MongoDB\Collection::findOneAndUpdate()

Definição

MongoDB\Collection::findOneAndUpdate()

Localiza um único documento que corresponda à query e o atualiza.

function findOneAndUpdate(
    array|object $filter,
    array|object $update,
    array $options = []
): object|null

Parâmetros

$filter : array|object

Os critérios de filtro que especificam os documentos a serem atualizados.

$update : array|object

Especifica as combinações de campo e valor a serem atualizadas e quaisquer operadores de atualização relevantes. $update usa osoperadores de atualização do MongoDB. A partir do MongoDB 4.2, um aggregation pipeline pode ser passado como esse parâmetro.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
bypassDocumentValidation	booleano	Se true, permite que a operação de gravação contorne a validação do nível do documento. O padrão é false.
arrayFilters	array	Uma array de documentos de filtro que determina quais elementos da array modificar para uma operação de atualização em um campo da array. Novidade na versão 1.3.
agrupamento	array|object	A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de string , como regras para letras maiúsculas e marcas de acento. Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento. Se o agrupamento não for especificado, mas a coleção tiver um agrupamento padrão, a operação usará o agrupamento especificado para a coleção. Se nenhum agrupamento for especificado para a coleção nem para a operação, o MongoDB usará a comparação binária simples usada nas versões anteriores para comparações de strings.
comment	misto	Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.13.
dica	string|array|objeto	O índice a ser utilizado. Especifique o nome do índice como uma string ou o padrão da chave do índice como um documento. Se especificado, o sistema de query considerará apenas os planos usando o índice sugerido. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.7.
maxTimeMS	inteiro	O limite de tempo cumulativo em milésimos de segundo para operações de processamento no cursor. O MongoDB aborta a operação o mais cedo possível após o ponto de interrupção.
let	array|object	Mapa de nomes e valores de parâmetros. Os valores devem ser expressões constantes ou fechadas que não façam referência aos campos do documento. Os parâmetros podem ser acessados como variáveis em um contexto de expressão agregada (como $$var). Isto não é suportado para versões de servidor anteriores à 5.0 e resultará em uma exceção no tempo de execução se utilizado. Novidade na versão 1.13.
projeção	array|object	A especificação da projeção para determinar quais campos incluir nos documentos devolvidos. Consulte Campos do projeto para retornar da consulta e Operadores de projeção no manual do MongoDB.
documento de devolução	inteiro	Especifica se deseja devolver o documento antes da atualização ser aplicada ou depois. O returnDocument suporta os seguintes valores: MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE (padrão) MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidade na versão 1.3.
sort	array|object	A especificação de classificação para a ordenação dos resultados.
typeMap	array	O mapa de tipos para aplicar aos cursores, que determina como os documentos BSON são convertidos para valores PHP. O padrão é o mapa de tipos da coleção. Isso será usado para o documento de resultado retornado.
upsert	booleano	Se definido como true, é criado um novo documento quando nenhum documento corresponde aos critérios da consulta. O valor padrão é false, que não insere um novo documento quando nenhuma correspondência é encontrada.
writeConcern	MongoDB\Driver\WriteConcern	Preocupação de gravação a ser usada na operação. O padrão é a preocupação de gravação da coleção. Não é possível especificar uma preocupação de gravação para operações individuais como parte de uma transação. Em vez disso, defina a opção writeConcern ao iniciar a transação.

Return Values

Uma array ou objeto para o documento original ou atualizado, dependendo do valor especificado da opção returnDocument . Por padrão, o documento original é devolvido. Se nenhum documento corresponder à query, null será retornado. O tipo de retorno depende da opção typeMap .

Erros/exceções

MongoDB\Exception\UnexpectedValueException se a resposta do comando do servidor estiver malformada.

MongoDB\Exception\UnsupportedException se as opções forem usadas e não aceitas pelo servidor selecionado (p. ex., collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo erros de conexão).

Comportamento

Ao avaliar critérios de query, oMongoDB compara tipos e valores de acordo com suas próprias regras de comparação para BSON types, o que difere da comparação do e digite PHP malabarismo regras. Ao corresponder a um tipo BSON especial, os critérios de query devem usar a respectiva classe BSON na extensão (por exemplo use MongoDB\BSON\ObjectId para corresponder a um ObjectId).

Exemplos

A operação a seguir atualiza o restaurante com restaurant_id de "40361708" na collection de restaurants no reconhecimento de data center de test definindo seu número de construção como "761":

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$updatedRestaurant = $collection->findOneAndUpdate(
    [ 'restaurant_id' => '40361708' ],
    [ '$set' => [ 'address.building' => '761' ]],
    [
        'projection' => [ 'address' => 1 ],
        'returnDocument' => MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER,
    ]
);
var_dump($updatedRestaurant);

A saída seria então semelhante a:

object(MongoDB\Model\BSONDocument)#20 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["_id"]=>
    object(MongoDB\BSON\ObjectId)#12 (1) {
      ["oid"]=>
      string(24) "594d5ef280a846852a4b3dee"
    }
    ["address"]=>
    object(MongoDB\Model\BSONDocument)#19 (1) {
      ["storage":"ArrayObject":private]=>
      array(4) {
        ["building"]=>
        string(3) "761"
        ["coord"]=>
        object(MongoDB\Model\BSONArray)#18 (1) {
          ["storage":"ArrayObject":private]=>
          array(2) {
            [0]=>
            float(-73.9925306)
            [1]=>
            float(40.7309346)
          }
        }
        ["street"]=>
        string(8) "Broadway"
        ["zipcode"]=>
        string(5) "10003"
      }
    }
  }
}

Veja também

• MongoDB\Collection::findOneAndDelete()

• MongoDB\Collection::findOneAndReplace()

• referência do comando findAndModify no manual MongoDB