MongoDB\Driver\BulkWriteCommand::updateOne

(mongodb >=2.1.0)

MongoDB\Driver\BulkWriteCommand::updateOneAñade una operación updateOne

Descripción

public MongoDB\Driver\BulkWriteCommand::updateOne(
    string $namespace,
    array|object $filter,
    array|object $update,
    ?array $options = null
): void

Añade una operación updateOne a la MongoDB\Driver\BulkWriteCommand. El primer documento que coincida con filter en la colección identificada por namespace será actualizado.

Parámetros

namespace (string)

Un espacio de nombres completamente calificado (ej. "databaseName.collectionName")

filter (array|object)

El » atributo de la consulta. Un atributo vacío hará coincidir todos los documentos de la colección.

Nota: Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias » reglas de comparación para los tipos BSON, que difieren de las reglas de comparación y de manipulación de tipos de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON (ej. : utilizar MongoDB\BSON\ObjectId para hacer coincidir un » ObjectId).

update (array|object)

Un documento que contiene operadores de actualización (por ejemplo $set) o una » pipeline de agregación.

options

options
Opción Tipo Descripción Valor por omisión
arrayFilters array

Un array de documentos de filtro que determina qué elementos de array deben ser modificados para una operación de actualización en un campo de array. Ver » Especificar arrayFilters para operaciones de actualización de array en la documentación de MongoDB para más información.

collation array|object

» Collation permite a los usuarios especificar reglas específicas del lenguaje para la comparación de cadenas, por ejemplo, reglas para mayúsculas o acentos. Al especificar una collation, el campo "locale" es obligatorio; todos los demás campos de la collation son opcionales. Para la descripción de estos campos, consúltese el » documento Collation.

Si la collation no es especificada pero la colección tiene una collation por omisión, la operación utilizará la collation especificada para la colección. Si ninguna collation es especificada para la colección o para la operación, MongoDB utilizará el binario simple de comparación utilizado en versiones anteriores para las comparaciones de cadenas.

Esta opción está disponible en MongoDB 3.4+ y una excepción será emitida en tiempo de ejecución si es especificada en una versión anterior.

hint string|array|object

Especificación del índice. Especifique el nombre del índice como string o el patrón de clave del índice. Si se especifica, el sistema de consulta no considerará planes que no utilicen el índice sugerido.

sort array|object

Especifica qué documento será reemplazado por la operación si la consulta coincide con múltiples documentos. El primer documento que coincida con el orden de clasificación será reemplazado.

upsert bool Si filter no coincide con ningún documento existente, insertar un documento single. El documento será creado aplicando los operadores en update a todos los valores de campo en filter. false

Valores devueltos

No se retorna ningún valor.

Errores/Excepciones

  • Lanza una excepción MongoDB\Driver\InvalidArgumentException en caso de error durante el análisis de un argumento.

Ejemplos

Ejemplo #1 Ejemplo de MongoDB\Driver\BulkWriteCommand::updateOne()

<?php

$manager
= new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand;
$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 2]]);

$result = $manager->executeBulkWriteCommand($bulk);

?>

Ver también

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top