PHP 8.5.0 Alpha 1 available for testing

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 cualificado (p. ej. "nombreBaseDatos.nombreColección").

filter (array|object)

El » predicado de la consulta. Un predicado vacío coincidirá con todos los documentos de una colección.

Nota: Al evaluar criterios de consulta, MongoDB compara tipos y valores según sus propias » reglas de comparación para tipos BSON, lo cual difiere de las reglas de comparación y manejo de tipos de PHP. Al encontrar un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON respectiva (p.ej. usar MongoDB\BSON\ObjectID al encontrar 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, o cotejamiento, permite a los usuarios especificar reglas específcas del lenguaje para comparar cadenas, tales como reglas para mayúsculas/minúsculas y marcas de acento. Cuando se especifica el cotejamiento, el cambpo "locale" es obligatorio; todos los demás campos de cotejamiento son opcionales. Para la descripción de los campos, véase la » Documentación de Collation.

Si no se especifica el cotejamiento y la colección tiene un cotejamiento predeterminado, la operación usará el cotejamiento especificado por la colección. Si no se especifica el cotejamiento para la colección o para la operación, MongoDB usará la comparación binaria simple utilizada en versiones anteriores para comparar cadenas.

Esta opción está disponible en MongoDB 3.4+ y resultará en una excepción durante la ejecución si se especifica para una versión más antigua del servidor.

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 devuelve ningún valor.

Errores/Excepciones

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