db.collection.remove() (método mongosh)

Escreva preocupação

remove() usa o comando delete, que usa a write concern padrão. Para especificar uma write concern diferente, inclua a write concern no parâmetro de opções.

Considerações de query

Por padrão, remove() remove todos os documentos que correspondem à expressão query. Especifique a opção justOne para limitar a operação para remover um único documento. Para excluir um único documento classificado por uma ordem especificada, use o método findAndModify().

Ao remover vários documentos, a operação de remoção pode se intercalar com outras operações de leitura ou gravação na coleção.

Coleções de Time Series

Você não pode usar remove() em uma coleção de séries temporais.

Coleções fragmentadas

Para usar operações remove() para uma coleção fragmentada que especifique a opção justOne: true:

• Se você segmentar apenas um fragmento, poderá usar uma chave de fragmento parcial na especificação da consulta ou,

• Você pode fornecer a chave de estilhaço ou o campo _id na especificação de consulta.

Transações

remove() pode ser usado dentro de transações distribuídas.

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.

Remover todos os documentos de uma collection

Para remover todos os documentos em uma coleção, chame o método remove() com um documento de query {} vazio. A operação a seguir exclui todos os documentos da coleção bios:

db.bios.remove( { } )

Esta operação não é equivalente ao método drop().

Para remover todos os documentos de uma collection de forma eficaz, considere usar o método drop() para excluir a collection completamente, incluindo os índices, e depois recriar a collection e seus índices.

Remova todos os documentos que correspondam a uma condição

Para remover os documentos que correspondem a um critério de exclusão, chame o método remove() com o parâmetro <query>:

A operação a seguir remove todos os documentos da collection products onde qty é maior que 20:

db.products.remove( { qty: { $gt: 20 } } )

Substituir write concern padrão

A operação a seguir em um conjunto de réplicas remove todos os documentos da collection products onde qty é maior que 20 e especifica uma preocupação de gravação de w: 2 com um wtimeout de 5000 milissegundos. Essa operação retorna depois que a gravação se propaga para o primary e um secundário ou expira após 5 segundos.

db.products.remove(
    { qty: { $gt: 20 } },
    { writeConcern: { w: "majority", wtimeout: 5000 } }
)

Remover um único documento que corresponda a uma condição

Para remover o primeiro documento que corresponda a um critério de exclusão, chame o método remove() com os critérios query e o parâmetro justOne definido como true ou 1.

A operação a seguir remove o primeiro documento da collection products onde qty é maior que 20:

db.products.remove( { qty: { $gt: 20 } }, true )

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.

Uma coleção myColl possui os seguintes documentos:

{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }

A seguinte operação inclui a opção coleção:

db.myColl.remove(
   { category: "cafe", status: "A" },
   { collation: { locale: "fr", strength: 1 } }
)

Usar variáveis em let

Para definir variáveis que você pode acessar em outro lugar no comando, use a opção let .

Criar uma coleção cakeFlavors:

db.cakeFlavors.insertMany( [
   { _id: 1, flavor: "chocolate" },
   { _id: 2, flavor: "strawberry" },
   { _id: 3, flavor: "cherry" }
] )

O exemplo a seguir define uma variável targetFlavor em let e usa a variável para excluir o sabor do bolo de morango:

db.cakeFlavors.remove(
   { $expr: { $eq: [ "$flavor", "$$targetFlavor" ] } },
   { let : { targetFlavor: "strawberry" } }
)

Resultados bem-sucedidos

remove() retorna um objeto WriteResult() que contém o status da operação. Após o sucesso da operação, o objeto WriteResult() apresentará o total de documentos removidos:

WriteResult({ "nRemoved" : 4 })

Erros de write concern

Se remove() encontrar erros de preocupação de gravação, os resultados incluirão o campo WriteResult.writeConcernError:

WriteResult({
  "nRemoved" : 7,
  "writeConcernError" : {
    "code" : 64,
    "codeName" : "WriteConcernTimeout",
    "errmsg" : "waiting for replication timed out",
    "errInfo" : {
      "wtimeout" : true,
      "writeConcern" : {
        "w" : "majority",
        "wtimeout" : 1,
        "provenance" : "getLastErrorDefaults"
      }
    }
  }
})

Erros não relacionados a write concern

Se remove() encontrar um erro que não seja de write concern, os resultados incluirão o campo WriteResult.writeError:

WriteResult({
   "nRemoved" : 0,
   "writeError" : {
      "code" : 2,
      "errmsg" : "unknown top level operator: $invalidFieldName"
   }
})