Definição
updateO comando
updatemodifica documentos em uma coleção. Um único comandoupdatepode conter várias declarações de atualização.Dica
No
mongosh, este comando também pode ser executado através dos métodos assistenteupdateOne(),updateMany(),replaceOne(),findOneAndReplace()efindOneAndUpdate().Os métodos auxiliares são práticos para os usuários
mongosh, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.
Compatibilidade
Esse comando está disponível em implantações hospedadas nos seguintes ambientes:
MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem
Observação
Este comando é aceito em todos os clusters do MongoDB Atlas. Para obter informações sobre o suporte do Atlas a todos os comandos, consulte Comandos não suportados.
MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB
Sintaxe
Alterado na versão 8.0.
O comando tem a seguinte sintaxe:
db.runCommand( { update: <collection>, updates: [ { q: <query>, u: <document or pipeline>, c: <document>, // Added in MongoDB 5.0 upsert: <boolean>, multi: <boolean>, collation: <document>, arrayFilters: <array>, hint: <document|string>, sort: <document> }, ... ], ordered: <boolean>, maxTimeMS: <integer>, writeConcern: { <write concern> }, bypassDocumentValidation: <boolean>, comment: <any>, let: <document> // Added in MongoDB 5.0 } )
Campos de comando
O comando utiliza os seguintes campos:
Campo | Tipo | Descrição | |||||
|---|---|---|---|---|---|---|---|
| string | O nome da coleção de destino. | |||||
| array | Uma array de uma ou mais declarações de atualização para executar na coleção denominada. Para obter detalhes sobre as declarações de atualização, consulte Declarações de atualização. | |||||
| booleano | Opcional. Se | |||||
| non-negative integer | Opcional. Especifica um limite de tempo em milissegundos. Se você não especificar um valor para O MongoDB encerra as operações que excedem o limite de tempo alocado usando o mesmo mecanismo de | |||||
| documento | Opcional. Um documento que Express a 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. | |||||
| booleano | Opcional. Habilita | |||||
| any | Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:
Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc). | |||||
documento | Opcional. Especifica um documento com uma lista de variáveis. Isso permite que você melhore a legibilidade do comando separando as variáveis do texto da query. A sintaxe do documento é: A variável é definida para o valor retornado pela expressão e não pode ser alterada posteriormente. Para acessar o valor de uma variável no comando, use o prefixo de dois cifrões ( Para obter um exemplo completo, consulte Usar variáveis na Novidades na versão 5.0. | ||||||
| documento | Opcional. Ordena os documentos antes que a atualização seja aplicada. Se o argumento de classificação não for um documento, ocorrerá um erro com a operação. O MongoDB não armazena documentos em uma collection em uma ordem específica. Ao ordenar em um campo que contém valores duplicados, os documentos que contêm esses valores podem ser retornados em qualquer ordem. A operação Se o campo especificado nos critérios de classificação não existir em dois documentos, então o valor pelo qual eles são classificados é o mesmo. Os dois documentos podem ser retornados em qualquer ordem. Se desejar uma ordem de classificação consistente, inclua pelo menos um campo em sua ordenação que contenha valores exclusivos. A maneira mais fácil de garantir isso é incluir o campo Para obter mais informações, consulte Consistência de classificação. Novidades na versão 8.0. Você não pode usar Para um exemplo de |
Atualizar declarações
Cada elemento de array updates é um documento de instrução de atualização. Cada documento contém os seguintes campos:
Campo | Tipo | Descrição | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
documento | A consulta que corresponde aos documentos a serem atualizados. Use os mesmos seletores de consulta usados no método | |||||||||||||||||||
documento ou pipeline | As modificações a serem aplicadas. O valor pode ser:
Confira os detalhes em Comportamento. | |||||||||||||||||||
documento | Opcional. Você pode especificar Especifica um documento com uma lista de variáveis. Isso permite que você melhore a legibilidade do comando separando as variáveis do texto da query. A sintaxe do documento é: A variável é definida para o valor retornado pela expressão e não pode ser alterada posteriormente. Para acessar o valor de uma variável no comando, use o prefixo de dois cifrões ( Para usar uma variável para filtrar os resultados, você deve acessar a variável dentro do operador Para obter um exemplo completo usando Novidades na versão 5.0. | |||||||||||||||||||
booleano | Opcional. Quando,
Se Para evitar várias atualizações, certifique-se de que os O padrão é | |||||||||||||||||||
| booleano | Opcional. Se Ao atualizar vários documentos, se um único documento não for atualizado, outros documentos não serão atualizados. Consulte falhas de múltiplas atualizações para obter mais detalhes sobre esse comportamento. | ||||||||||||||||||
| documento | 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: Ao especificar agrupamento, o campo Se o agrupamento não for especificado, mas a coleção tiver um agrupamento padrão (consulte 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. | ||||||||||||||||||
| array | Opcional. 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. No documento de atualização, use o operador posicional filtrado O Você pode incluir o mesmo identificador várias vezes no documento de atualização; entretanto, para cada identificador distinto ( No entanto, você pode especificar condições compostas no mesmo identificador em um único documento de filtro, como nos exemplos a seguir: Para obter exemplos, consulte Especificar | ||||||||||||||||||
Documento ou string | Opcional. Um documento ou string que especifica o índice aser usado para dar suporte ao predicado de query. A opção pode usar um documento de especificação de índice ou a string do nome do índice. Se você especificar um índice que não existe, a operação emitirá erros. Para um exemplo, consulte Especificar |
Devoluções
O comando retorna um documento que contém o status da operação. Por exemplo:
{ "ok" : 1, "nModified" : 0, "n" : 1, "upserted" : [ { "index" : 0, "_id" : ObjectId("52ccb2118908ccd753d65882") } ] }
Para obter detalhes sobre os campos de saída, consulte Saída.
Controle de acesso
Em implantações executadas com authorization, o usuário deve ter acesso que inclua os seguintes privilégios:
updateação na(s) coleção(ões) especificada(s).findação na(s) coleção(ões) especificada(s).insertação na(s) coleção(ões) especificada(s).
A função embutida readWrite fornece os privilégios exigidos.
Comportamento
Limitações
Se você definir multi: true, use o comando update apenas para operações idempotentes.
Atualizar com um Documento de Expressões do Operador de Atualização
O campo de instrução de atualização u pode aceitar um documento que contenha apenas expressões de operador de atualização. Por exemplo:
updates: [ { q: <query>, u: { $set: { status: "D" }, $inc: { quantity: 2 } }, ... }, ... ]
Em seguida, o comando update atualiza somente os campos correspondentes no documento.
Atualizar com um documento de substituição
O campo u da declaração de atualização pode aceitar um documento de substituição, ou seja, o documento contém apenas expressões field:value. Por exemplo:
updates: [ { q: <query>, u: { status: "D", quantity: 4 }, ... }, ... ]
Em seguida, o comando update substitui o documento correspondente pelo documento de atualização. O comando update só pode substituir um único documento correspondente; ou seja, o campo multi não pode ser true. O comando update não substitui o valor _id.
Falhas em múltiplas atualizações
Se um único documento não for atualizado em um comando de atualização com o parâmetro multi definido como true, nenhum outro documento será atualizado como parte desse comando.
Por exemplo, a sample_mflix.movies coleção contém filmes com imdb.rating campos. Crie um validador de documento na movies coleção com uma regra de que o imdb.rating valor deve ser menor ou igual 10 a:
db.runCommand( { update: "movies", updates: [ { q: { year: { $gte: 2000, $lte: 2005 }, "imdb.rating": { $type: "number" } }, u: { $inc: { "imdb.rating": 1 } }, multi: true } ] } )
Se algum filme já tiver uma classificação de 10, incrementá-lo violaria a regra de validação (classificação > 10). Quando isso acontece, a atualização é interrompida e nenhum outro documento é atualizado, mesmo que milhares de documentos correspondam à query.
Observação
Se um subconjunto de documentos correspondentes for atualizado, como quando uma atualização causaria a falha na validação de esquema de alguns documentos, o valor de nModified retornado pelo comando update pode não ser preciso.
Atualize com um pipeline de agregação.
O campo u da instrução de atualização pode aceitar um pipeline de agregação [ <stage1>, <stage2>, ... ] que especifica as modificações a serem realizadas. O pipeline pode consistir nas seguintes etapas:
$addFieldse seu alias$set$replaceRoote seu alias$replaceWith
O uso do aggregation pipeline permite uma instrução de atualização mais expressiva, como atualizações condicionais Express com base em valores de campo atuais ou atualização de um campo usando o valor de outro(s) campo(s).
Por exemplo:
updates: [ { q: <query>, u: [ { $set: { status: "Modified", comments: [ "$misc1", "$misc2" ] } }, { $unset: [ "misc1", "misc2" ] } ], ... }, ... ]
Observação
Para obter exemplos, consulte Atualizar com pipeline de agregação.
Upsert com índice exclusivo
Os upserts podem criar documentos duplicados, a menos que haja um índice único para evitar duplicatas.
Considere um exemplo em que nenhum documento com o nome Andy existe e vários clientes emitem o seguinte comando ao mesmo tempo:
db.runCommand( { update: "people", updates: [ { q: { name: "Andy" }, u: { $inc: { score: 1 } }, multi: true, upsert: true } ] } )
Se todas as operações update terminarem a fase de query antes que qualquer cliente insira dados com êxito e não houver nenhum índice exclusivo no campo name, cada operação update poderá resultar em uma inserção, criando vários documentos com name: Andy.
Um índice exclusivo no campo name garante que somente um documento seja criado. Com um índice único em vigor, as múltiplas operações update agora apresentam o seguinte comportamento:
Exatamente uma operação
updateinserirá com êxito um novo documento.Outras operações
updateatualizam o documento recém-inserido ou falham devido a uma colisão de chave exclusiva.Para que outras operações
updateatualizem o documento recém-inserido, todas as seguintes condições devem ser atendidas:A collection de destino tem um índice único que causaria um erro de chave duplicado.
A operação de atualização não é
updateManyoumultiéfalse.A condição de correspondência de atualização é:
Um único predicado de igualdade. Por exemplo
{ "fieldA" : "valueA" }Um E lógico de predicados de igualdade. Por exemplo
{ "fieldA" : "valueA", "fieldB" : "valueB" }
O campo no predicado de igualdade correspondem ao campo no padrão de chave de índice único.
A operação de atualização não modifica nenhum campo no padrão de chave de índice único.
A tabela a seguir mostra exemplos de operações upsert que, quando ocorre uma colisão de chaves, resultam em uma atualização ou falha.
Padrão de chave de índice exclusivo | Operação de atualização | Resultado | ||||||
|---|---|---|---|---|---|---|---|---|
| | O campo | ||||||
| | A operação falha porque modifica o campo no padrão de chave de índice único ( | ||||||
| | A operação falha porque os campos de predicados de igualdade ( |
Limites
Para cada elemento de atualização na array updates, a soma da query e os tamanhos de atualização (ou seja, q e u ) devem ser menores ou iguais ao tamanho máximo do documento BSON.
O número total de instruções de atualização na array updates deve ser menor ou igual ao tamanho máximo em massa.
Validação de esquema
O comando update adiciona suporte para a opção bypassDocumentValidation, que permite ignorar a validação de esquema ao inserir ou atualizar documentos em uma coleção com regras de validação.
Coleções fragmentadas
upsert em uma coleção fragmentada
Para usar update com multi: false em uma coleção fragmentada,
Se você não especificar upsert: true, o filtro q deverá incluir uma correspondência de igualdade no campo
_idou direcionar um único fragmento (por exemplo, incluindo a chave de fragmento).Se você especificar upsert: true, o filtro q deverá incluir uma correspondência de igualdade na chave de fragmento.
No entanto, os documentos em uma coleção fragmentada podem estar faltando os campos de chave de fragmento. Para direcionar um documento que não possui a chave de fragmento, você pode usar a
nullcorrespondência de igualdade em conjunto com outra condição de filtro (como no campo_id). Por exemplo:{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key
Substituir documento
Ao substituir um documento, update tenta direcionar um fragmento, primeiro usando o filtro de query. Se a operação não puder direcionar um único fragmento pelo filtro de query, ela tentará direcionar pelo documento de substituição.
Modificação da chave de fragmento
Você pode atualizar o valor da chave de fragmento de um documento, a menos que o campo de chave de fragmento seja o campo de _id imutável.
Para modificar o valor da chave de fragmento existente com update:
Você deve executar em um
mongos. Não emita a operação diretamente no fragmento.Você deve executar em uma transação ou como uma gravação repetível.
Você deve especificar
multi: false.Você deve incluir um filtro de queries de igualdade na chave de fragmento completa.
Dica
Como um valor de chave ausente é retornado como parte de uma correspondência de igualdade nula,
para evitar a atualização de uma chave de valor nulo, inclua
condições de consulta (como no campo _id) conforme apropriado.
Consulte também upsert em uma coleção fragmentada.
Chave de fragmento ausente
Os documentos em coleções fragmentadas podem não ter os campos de chave de fragmento. Para usar update a fim de definir a chave de fragmento ausente do documento, é necessário executar em um mongos. Não emita a operação diretamente no fragmento.
Além disso, os seguintes requisitos também se aplicam:
Tarefa | Requisitos |
|---|---|
Para definir como |
|
Para definir um valor diferente de |
|
Dica
Como um valor de chave ausente é retornado como parte de uma correspondência de igualdade nula,
para evitar a atualização de uma chave de valor nulo, inclua
condições de consulta (como no campo _id) conforme apropriado.
Veja também:
Transações
update pode ser usado dentro de transações distribuídas.
Importante
Na maioria dos casos, uma transação distribuída incorre em um custo de desempenho maior do que as gravações de um único documento, e a disponibilidade de transações distribuídas não deve substituir o design eficaz do esquema. Em muitos cenários, o modelo de dados desnormalizado (documentos e arrays incorporados) continuará a ser ideal para seus dados e casos de uso. Ou seja, para muitos cenários, modelar seus dados adequadamente minimizará a necessidade de transações distribuídas.
Para considerações adicionais sobre o uso de transações (como limite de tempo de execução e limite de tamanho do oplog), consulte também Considerações de produção.
Inserção nas Transações
Você pode criar coleção e índices dentro de uma transação distribuída se a transação não for uma transação de gravação cross-fragmento.
update com upsert: true pode ser executado em uma coleção existente ou em uma coleção inexistente. Se for executada em uma coleção inexistente, a operação cria a coleção.
Write concerns e transações
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.
Exemplos
Os exemplos nesta página usam dados do conjunto de dados de amostra sample_mflix. Para obter detalhes sobre como carregar esse conjunto de dados em sua implantação autogerenciada do MongoDB , consulte Carregar o conjunto de dados de amostra. Se você fez modificações nos bancos de dados de amostra, talvez seja necessário descartar e recriar os bancos de dados para executar os exemplos nesta página.
Atualizar campos específicos de um documento
Use operadores de atualização para atualizar apenas os campos especificados de um documento.
Por exemplo, os documentos na collection movies do banco de dados sample_mflix contêm campos como title, year e num_mflix_comments.
O comando a seguir usa os operadores de atualização $set e $inc para atualizar os campos year e num_mflix_comments de um documento em que title é igual a "The Godfather":
db.runCommand( { update: "movies", updates: [ { q: { title: "The Godfather" }, u: { $set: { year: 1972 }, $inc: { num_mflix_comments: 1 } } } ], ordered: false, writeConcern: { w: "majority", wtimeout: 5000 } } )
Como <update> documento não especifica o campo de multi opcional, a atualização modifica apenas um documento, mesmo que mais de um documento corresponda à condição de correspondência de q .
Consulte Saída para detalhes.
Atualizar campos específicos de vários documentos
Use operadores de atualização para atualizar apenas os campos especificados de um documento e inclua o campo multi definido como true na instrução update.
Por exemplo, os documentos na collection movies do banco de dados sample_mflix contêm campos como year e num_mflix_comments.
O comando a seguir usa o $inc operador de atualização para incrementar o num_mflix_comments campo para todos os filmes lançados 1924 em:
db.runCommand( { update: "movies", updates: [ { q: { year: 1924 }, u: { $inc: { num_mflix_comments: 1 }, $set: { classic: true, era: "silent" } }, multi: true } ], ordered: false, writeConcern: { w: "majority", wtimeout: 5000 } } )
Como o campo multi está configurado para true, a atualização modifica todos os documentos do 6 que correspondem à query especificada no campo q e retorna a seguinte saída:
{ n: 6, nModified: 6, ok: 1 }
Consulte Saída para detalhes.
Atualização com aggregation pipeline
O comando update pode usar um pipeline de agregação para a atualização. O pipeline pode consistir nas seguintes etapas:
$addFieldse seu alias$set$replaceRoote seu alias$replaceWith
O uso do aggregation pipeline permite uma instrução de atualização mais expressiva, como atualizações condicionais Express com base em valores de campo atuais ou atualização de um campo usando o valor de outro(s) campo(s).
Exemplo 1
Os exemplos a seguir usam o aggregation pipeline para modificar um campo usando os valores de outros campos no documento.
Os documentos na coleção users do banco de dados sample_mflix contêm campos como name e email.
A seguinte operação de atualização utiliza um pipeline de agregação para adicionar novos campos ao documento de um usuário específico:
db.runCommand( { update: "users", updates: [ { q: { name: "Robert Baratheon" }, u: [ { $set: { full_info: { $concat: [ "$name", " - ", "$email" ] } } }, { $set: { status: "active" } } ], multi: false } ], ordered: false, writeConcern: { w: "majority", wtimeout: 5000 } } )
Observação
A $set operação usada no pipeline refere-se ao estágio de agregação $set e não ao operador de $set atualização.
Exemplo 2
O aggregation pipeline permite que a atualização execute atualizações condicionais com base nos valores de campo atuais, bem como use valores de campo atuais para calcular um valor de campo separado.
Os documentos na coleção movies do banco de dados sample_mflix têm um campo year .
O exemplo a seguir usa um pipeline de agregação para calcular a idade de "O grande roubo do trem" e atribuir uma classificação de era com base em quando ele foi lançado.
db.runCommand( { update: "movies", updates: [ { q: { title: "The Great Train Robbery" }, u: [ { $set: { age: { $subtract: [ 2026, "$year" ] } } }, { $set: { era: { $switch: { branches: [ { case: { $lt: [ "$year", 1960 ] }, then: "Classic" }, { case: { $lt: [ "$year", 1980 ] }, then: "Golden Age" }, { case: { $lt: [ "$year", 2000 ] }, then: "Modern" }, { case: { $gte: [ "$year", 2000 ] }, then: "Contemporary" } ], default: "Unknown" } } } } ], multi: false } ], ordered: false, writeConcern: { w: "majority", wtimeout: 5000 } } )
Observação
- Primeira etapa
- O estágio calcula um novo
$setcampoagecom base na diferença entre 2026 e o ano de lançamento do filme. Consulte para obter mais$subtractinformações. - Segunda etapa
- O estágio calcula um novo
$setcampoeracom base noyearcampo usando lógica condicional. Consulte para obter mais informações sobre$switcho$switchoperador de agregação.
Atualização em Massa
O exemplo a seguir executa várias operações de atualização em um único comando para atualizar documentos existentes e inserir novos documentos. A operação:
marca filmes de gênero bem avaliados de 2015 como
featuredcategoriza curtas-metragens de ação e sucesso de 2012 como
melodramaupsert um novo filme de ficção científica de 2024 se não existir
db.runCommand( { update: "movies", updates: [ // Update highly-rated Horror movies from 2015 { q: { year: 2015, genres: "Horror", "imdb.rating": { $gte: 7 } }, u: { $set: { featured: true } }, multi: true }, // Update short Drama/Romance movies from 2012 { q: { year: 2012, genres: { $all: ["Drama", "Romance"] }, runtime: { $lt: 90 } }, u: { $set: { category: "melodrama" } }, multi: true }, // Upsert a new movie from 2026 { q: { title: "A New Movie", year: 2026 }, u: { $set: { genres: ["Sci-Fi", "Adventure"], runtime: 142, "imdb.rating": 8.5, featured: true } }, upsert: true } ], ordered: false, writeConcern: { w: "majority", wtimeout: 5000 } } )
O documento retornado mostra que o comando modificou os documentos existentes e inseriu um novo documento por upsert. Consulte Saída para detalhes.
{ n: 16, upserted: [ { index: 2, _id: ObjectId('69861e680e6ea1f51160fe1c') } ], nModified: 15, ok: 1, '...': '...' }
Especifique o agrupamento
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.
Os documentos na coleção movies do banco de dados sample_mflix têm campos como title e year.
A operação a seguir usa agrupamento para executar uma pesquisa sem diferenciação de maiúsculas e minúsculas. A query pesquisa "the godfather" em letras minúsculas, mas com o agrupamento strength: 1, a query corresponde a "The Godfather", independentemente da capitalização:
db.runCommand({ update: "movies", updates: [ { q: { title: "the godfather" }, u: { $set: { featured: true } }, collation: { locale: "en", strength: 1 } } ] })
Especificar arrayFilters para operações de atualização de array
Ao atualizar um campo de array, você pode especificar arrayFilters que determinam quais elementos de array atualizar.
arrayFilters Atualizar elementos que correspondem aos critérios
Os documentos na collection movies do banco de dados sample_mflix têm um campo de array languages.
O exemplo a seguir atualiza todos os filmes que têm "English" em sua array languages. A operação substitui "English" por "EN".
db.runCommand( { update: "movies", updates: [ { q: { languages: "English" }, u: { $set: { "languages.$[element]" : "EN" } }, arrayFilters: [ { "element": "English" } ], multi: true} ] } )
Atualizar elementos específicos de uma array de documentos
Os documentos na coleção movies do banco de dados sample_mflix têm uma array cast que lista os nomes dos atores.
O exemplo a seguir atualiza todos os filmes que têm "Al Pacino" em sua array cast, substituindo "Al Pacino" por "REDACTED". A opção arrayFilters especifica quais elementos de array atualizar:
db.runCommand({ update: "movies", updates: [ { q: { cast: "Al Pacino" }, u: { $set: { "cast.$[elem]" : "REDACTED" } }, arrayFilters: [ { "elem": "Al Pacino" } ], multi: true } ] })
A operação atualiza todos os filmes 40 que têm "Al Pacino" na array cast, substituindo seu nome por "REDACTED".
Especifique hint para operações de atualização
Os documentos na coleção movies do banco de dados sample_mflix têm campos como year e num_mflix_comments.
Crie os seguintes índices na coleção:
[ db.movies.createIndex( { year: 1 } ), db.movies.createIndex( { num_mflix_comments: 1 } ) ]
A seguinte operação de atualização incrementa o campo num_mflix_comments para "O grande roubo do trem" e sugere explicitamente o uso do índice { year: 1 }:
Observação
Se você especificar um índice que não existe, a operação emitirá erros.
db.runCommand({ update: "movies", updates: [ { q: { title: "The Great Train Robbery" }, u: { $inc: { "num_mflix_comments": 1 } }, hint: { year: 1 }, multi: false } ] })
Para visualizar o índice utilizado, você pode executar o em uma operação de atualização. Por exemplo, o seguinte explica uma atualização que explain incrementa num_mflix_comments para filmes com 5 ou menos comentários lançados em 2000 ou posterior:
db.runCommand( { explain: { update: "movies", updates: [ { q: { "num_mflix_comments": { $lte: 5 }, "year": { $gte: 2000 } }, u: { $inc: { "num_mflix_comments": 1 } }, hint: { year: 1 }, multi: true } ] }, verbosity: "queryPlanner" } )
O explain não modifica os documentos.
Usar variáveis na let opção ou no c campo
Novidades na versão 5.0.
As variáveis podem ser definidas na opção let ou no campo c e acessadas no array updates.
Observação
Para filtrar resultados usando uma variável, você deve acessar a variável dentro do operador $expr.
Os documentos na coleção movies do banco de dados sample_mflix têm campos como title e year.
O exemplo seguinte utiliza a opção let para definir variáveis para localizar e adicionar um novo campo a um filme.
db.runCommand( { update: "movies", updates: [ { q: { $expr: { $eq: [ "$title", "$$movieTitle" ] } }, u: [ { $set: { franchise: "$$franchiseName" } } ] } ], let : { movieTitle: "The Godfather", franchiseName: "The Godfather Trilogy" } } )
O exemplo a seguir define movieTitle e franchiseName variáveis em c e usa as variáveis para adicionar um campo franchise .
db.runCommand( { update: "movies", updates: [ { q: { $expr: { $eq: [ "$title", "$$movieTitle" ] } }, u: [ { $set: { franchise: "$$franchiseName" } } ], c: { movieTitle: "The Godfather", franchiseName: "The Godfather Trilogy" } } ] } )
Saída
O documento devolvido contém um subconjunto dos seguintes campos:
update.nUm comando
updateaceita uma array de atualizações de documentos, algumas das quais podem ser upserts. Para uma atualização,nindica o número de documentos selecionados para a atualização. Para um upsert,né1para o documento inserido. O servidor adiciona os valores denpara todas as atualizações e upserts e retorna o total comoupdate.n.Se uma operação de atualização resultar em nenhuma alteração no documento, por exemplo, a expressão
$setatualiza o valor para o valor atual,npode ser maior quenModified.
update.nModifiedO número de documentos atualizados. Se a operação de atualização não resultar em nenhuma alteração no documento, como definir o valor do campo com seu valor atual,
nModifiedpoderá ser menor quen.Observação
Se um subconjunto de documentos correspondentes for atualizado, como quando uma atualização causaria a falha na validação de esquema de alguns documentos, o valor de
nModifiedretornado pelo comandoupdatepode não ser preciso.
update.upsertedUma array de documentos que contém informações para cada documento inserido através da atualização com
upsert: true.Cada documento contém as seguintes informações:
update.writeErrorsUmo array de documentos que contém informações sobre qualquer erro encontrado durante a operação de atualização. o array
writeErrorscontém um documento de erro para cada instrução de atualização com erro.Cada documento de erro contém os seguintes campos:
update.writeConcernErrorDocumento descrevendo erros relacionados à preocupação de gravação.
Alterado na 7.0.6 versão: (também disponível em 6.0.14 e 5.0.30): Quando é
updatemongosexecutado em , erros de preocupação de gravação são sempre relatados, mesmo quando ocorrem um ou mais erros de escrita. Em versões anteriores, a ocorrência de erros de gravação poderia fazer com queupdatenão relatasse erros de preocupação de gravação .Os documentos
writeConcernErrorcontêm os seguintes campos:update.writeConcernError.errInfo.writeConcernO objeto de write concern usado para a operação correspondente. Para obter informações sobre os campos de objeto de write concern, consulte Especificação de write concern.
O objeto de write concern também pode conter o seguinte campo, indicando a origem da write concern:
update.writeConcernError.errInfo.writeConcern.provenanceUm valor de string que indica a origem do write concern (conhecido como write concern
provenance). A tabela a seguir mostra os valores possíveis para este campo e sua significância:ProveniênciaDescriçãoclientSuppliedA preocupação de gravação foi especificada no aplicativo.
customDefaultA preocupação de gravação originou-se de um valor padrão personalizado definido. Consulte
setDefaultRWConcern.getLastErrorDefaultsA preocupação de gravação originada do campo
settings.getLastErrorDefaultsdo conjunto de réplicas.implicitDefaultA preocupação de gravação originou-se do servidor na ausência de todas as outras especificações de preocupação de gravação.
Alterado na versão 8.1.2.
Quando update é executado em mongos em um cluster fragmentado, um writeConcernError é sempre relatado na resposta, mesmo quando ocorre um ou mais erros. Em versões anteriores, outros erros às vezes faziam com que update não relatasse erros de preocupação de gravação.
Por exemplo, se um documento falhar na validação, desencadeando um erro DocumentValidationFailed e também ocorrer um erro de preocupação de gravação , o erro DocumentValidationFailed e o writeConcernError serão retornados no campo de nível superior da resposta.
Além dos campos de retorno específicos de atualização mencionados acima, o db.runCommand() inclui informações adicionais:
para conjuntos de réplicas:
optime,electionId,$clusterTimeeoperationTime.para clusters fragmentados:
operationTimee$clusterTime.
Consulte Resposta db.runCommand para obter detalhes sobre esses campos.
Atualizar operação com uma classificação
Os documentos na coleção movies do banco de dados sample_mflix têm campos como year, title e num_mflix_comments.
O exemplo a seguir encontra todos os filmes de 1972 e atualiza aquele com mais comentários.
db.runCommand( { update: "movies", updates: [ { // Find movies from 1972 q: { year: 1972 }, // Add a classic_status field to the found movie u: { $set: { classic_status: "Most Discussed 1972 Film" } }, // Only update one movie multi: false, // Sort movies by comment count in descending order sort: { num_mflix_comments: -1 } } ] } )
A operação atualiza apenas o filme 1972 com o maior número de comentários.