db.collection.findOneAndReplace()

Os critérios de seleção para a atualização. Os mesmos seletores de consulta que no método find() estão disponíveis.

Para substituir o primeiro documento retornado na coleção, especifique um documento vazio { }.

Se não for especificado, o padrão será um documento vazio.

Se o argumento de consulta não for um documento, a operação retornará um erro.

O documento de substituição.

Não é possível conter operadores de atualização.

O documento <replacement> não pode especificar um valor _id que difere do documento substituído.

Opcional. Um documento que expressa o write concern. Omitir para usar o write concern padrão.

{ w: <value>, j: <boolean>, wtimeout: <number> }

Não defina explicitamente a preocupação de gravação para a operação se for executada em uma transação. Para usar write concern com transações, consulte Transações e write concern.

Opcional. Um subconjunto de campos para retornar.

Para retornar todos os campos no documento correspondente, omita este campo.

Se o argumento de projeção não for um documento, ocorrerá um erro na operação.

Opcional. Especifica uma ordem de classificação para os documentos correspondentes pelo filtro.

Se o argumento de classificação não for um documento, ocorrerá um erro com a operação.

Consulte cursor.sort().

Opcional. Quando true, findOneAndReplace() ou:

• Insere o documento a partir do parâmetro replacement se nenhum documento corresponder ao filter. Retorna null após inserir o novo documento, a menos que returnNewDocument seja true.

• Substitui o documento que corresponde a filter pelo documento replacement.

O MongoDB adicionará o campo _id ao documento de substituição se ele não for especificado nos documentos filter ou replacement . Se _id estiver presente em ambos, os valores deverão ser iguais.

Para evitar várias alterações, certifique-se de que os campos query sejam indexados exclusivamente.

Padrão é false.

Opcional. A partir da versão 0.13.2 do mongosh, returnDocument é uma alternativa para returnNewDocument. Se ambas as opções forem definidas, o returnDocument terá precedência.

returnDocument: "before" retorna o documento original. returnDocument: "after" retorna o documento atualizado.

Opcional. Quando true, retorna o documento de substituição em vez do documento original.

Padrão é false.

Opcional.

Especifica o agrupamento a ser usado para a operação.

A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de strings, como regras para letras maiúsculas e marcas de acento.

A opção de agrupamento tem a seguinte sintaxe:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

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 (consulte db.createCollection()), a operação usará o agrupamento especificado para a coleção.

Se nenhum agrupamento for especificado para a coleção ou para as operações, o MongoDB usa a comparação binária simples usada nas versões anteriores para comparações de strings.

Você não pode especificar vários agrupamentos para uma operação. Por exemplo, você não pode especificar agrupamentos diferentes por campo ou, se estiver realizando uma busca com uma classificação, não poderá usar um agrupamento para a busca e outro para a classificação.

Usa o operador de projeção de array $ para retornar o primeiro elemento que corresponde à condição de consulta no campo de array. Se você especificar um número inteiro diferente de zero para o valor de projeção, a operação tratará o valor como true.

Não disponível para visualizações.

Usa os operadores de projeção de array ($elemMatch, $slice) para especificar os elementos da array a serem incluídos.

Não disponível para visualizações.

Especifica o valor do campo projetado.

Com o uso de expressões de agregação e sintaxe, incluindo o uso de literais e variáveis de agregação, você pode projetar novos campos ou projetar campos existentes com novos valores.

• Se você especificar um literal não numérico e não booleano (como uma string literal ou uma array ou uma expressão de operador) para o valor de projeção, o campo será projetado com o novo valor, por exemplo:

  • { field: [ 1, 2, 3, "$someExistingField" ] }

  • { field: "New String Value" }

  • { field: { status: "Active", total: { $sum: "$existingArray" } } }

• Para projetar um valor literal para um campo, use a expressão de aggregation $literal, por exemplo:

  • { field: { $literal: 5 } }

  • { field: { $literal: true } }

  • { field: { $literal: { fieldWithValue0: 0, fieldWithValue1: 1 } } }