MongoDB\Collection::insertOne()

Definición

MongoDB\Collection::insertOne()

Inserte 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

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bypassDocumentValidation	booleano	Si true, permite que la operación de guardar eluda la validación a nivel de documento. Por defecto es false.
códec	MongoDB\Codec\DocumentCodec	La Codifica datos con códecs de tipo para usar en la codificación o decodificación de documentos. Esta opción es mutuamente excluyente con la opción typeMap. Se configura de forma predeterminada al códec de la colección. La herencia para una opción codec por defecto tiene prioridad 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 perfilador de base de datos, output de currentOp y 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 con 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 un nivel de confirmación de escritura (write concern) para operaciones individuales como parte de una transacción. En su lugar, configura la opción writeConcern 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 a nivel de extensión (por ejemplo, " errores de conexión).

Comportamiento

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

Por ejemplo, una operación de escritura puede haberse aplicado correctamente al servidor principal, pero no haber satisfecho el nivel de confirmación de escritura (write concern) (por ejemplo, la replicación tomó demasiado tiempo). Como alternativa, puede que una operación de guardar haya fallado por completo (por ejemplo, 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