MongoDB\Collection::insertOne()

Definición

MongoDB\Collection::insertOne()

Insertar un documento.

function insertOne(
    array|object $document,
    array $options = []
): MongoDB\InsertOneResult

Parámetros

$document : arreglo|objeto

El documento para insertar en la colección.

$options : arreglo

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bypassDocumentValidation	booleano	Si es true, permite que la operación de escritura evite la validación a nivel de documento. El valor predeterminado es false.
códec	MongoDB\Codec\DocumentCodec	La Codificar datos con códecs de tipo para codificar o decodificar documentos. Esta opción es mutuamente excluyente con la typeMap opción. El valor predeterminado es el códec de la colección. La herencia de la opción predeterminada codec prevalece sobre la de la opción typeMap. Novedad en la versión 1.17.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través de generador de perfilesde base de datos, salidacurrentOpy registros. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.13.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar a la operación. Nueva en la versión 1.3.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a usar en la operación. Por defecto, se aplica el nivel de confirmación de escritura (write concern) de la colección. No es posible especificar una preocupación de escritura para operaciones individuales como parte de una transacción. En su lugar, configure la writeConcern opción al iniciar la transacción.

Return Values

Un objeto MongoDB\InsertOneResult, que encapsula un objeto MongoDB\Driver\WriteResult.

Errores/Excepciones

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\BulkWriteException para errores relacionados con la operación de escritura. Los usuarios deben inspeccionar el valor devuelto por getWriteResult() para determinar la naturaleza del error.

MongoDB\Driver\Exception\RuntimeException para otros errores en el nivel de extensión (por ejemplo, errores de conexión).

Comportamiento

Si se lanza una MongoDB\Driver\Exception\BulkWriteException, los usuarios deben llamar a getWriteResult() e inspeccionar el objeto MongoDB\Driver\WriteResult devuelto para determinar la naturaleza del error.

Por ejemplo, es posible que una operación de escritura se haya ejecutado correctamente en el servidor principal, pero no haya solucionado el problema (p. ej., la replicación tardó demasiado). También es posible que una operación de escritura haya fallado por completo (p. ej., violación de clave única).

Ejemplo

La siguiente operación inserta un documento en la colección users de la base de datos test:

<?php
$collection = (new MongoDB\Client)->test->users;
$insertOneResult = $collection->insertOne([
    'username' => 'admin',
    'email' => 'admin@example.com',
    'name' => 'Admin User',
]);
printf("Inserted %d document(s)\n", $insertOneResult->getInsertedCount());
var_dump($insertOneResult->getInsertedId());

La vista de salida se ilustraría como sigue:

Inserted 1 document(s)
object(MongoDB\BSON\ObjectId)#11 (1) {
  ["oid"]=>
  string(24) "579a25921f417dd1e5518141"
}

Ver también

• MongoDB\Collection::insertMany()

• MongoDB\Collection::bulkWrite()

• Insertar documentos

• insertar referencia de comandos en el manual de MongoDB