excluir (comando de banco de dados)

Definição

delete

Remove documentos de uma coleção. Um único comando pode conter várias especificações de exclusão. Os métodos de exclusão do driver MongoDB usam esse comando internamente.

Alterado na versão 5.0.:

Dica

Em mongosh, esse comando também pode ser executado por meio dos métodos auxiliares deleteOne(), deleteMany() e findOneAndDelete().

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.

Retorna:	Um documento que contém o status da operação. Consulte Saída para detalhes.

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

• 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

O comando tem a seguinte sintaxe:

 db.runCommand(
    {
      delete: <collection>,
      deletes: [
         {
           q : <query>,
           limit : <integer>,
           collation: <document>,
           hint: <document|string>
         },
         ...
      ],
      comment: <any>,
      let: <document>, // Added in MongoDB 5.0
      ordered: <boolean>,
      writeConcern: { <write concern> },
      maxTimeMS: <integer>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

Cada elemento do array deletes contém os seguintes campos:

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

Comportamento

Exemplos

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { status: "D" }, limit: 1 } ]
   }
)

{ "ok" : 1, "n" : 1 }

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { status: "D" }, limit: 0 } ],
      writeConcern: { w: "majority", wtimeout: 5000 }
   }
)

{ "ok" : 1, "n" : 13 }

db.runCommand(
   {
      delete: "orders",
      deletes: [ { q: { }, limit: 0 } ],
      writeConcern: { w: "majority", wtimeout: 5000 }
   }
)

{ "ok" : 1, "n" : 35 }

db.runCommand(
   {
      delete: "orders",
      deletes: [
         { q: { status: "D" }, limit: 0 },
         { q: { cust_num: 99999, item: "abc123", status: "A" }, limit: 1 }
      ],
      ordered: false,
      writeConcern: { w: 1, j: true }
   }
)

{ "ok" : 1, "n" : 21 }

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

db.runCommand({
   delete: "myColl",
   deletes: [
     { q: { category: "cafe", status: "a" }, limit: 0, collation: { locale: "fr", strength: 1 } }
   ]
})

db.members.insertMany([
   { "_id" : 1, "member" : "abc123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" },
   { "_id" : 3, "member" : "lmn123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 4, "member" : "pqr123", "status" : "D", "points" : 20,  "misc1" : "Deactivated", "misc2" : null },
   { "_id" : 5, "member" : "ijk123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 6, "member" : "cde123", "status" : "A", "points" : 86,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" }
])

db.members.createIndex( { status: 1 } )
db.members.createIndex( { points: 1 } )

db.runCommand({
   delete: "members",
   deletes: [
     { q: { "points": { $lte: 20 }, "status": "P" }, limit: 0, hint: { status: 1 } }
   ]
})

db.runCommand(
   {
     explain: {
       delete: "members",
       deletes: [
         { q: { "points": { $lte: 20 }, "status": "P" }, limit: 0, hint: { status: 1 } }
       ]
     },
     verbosity: "queryPlanner"
   }
)

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

db.runCommand( {
   delete: db.cakeFlavors.getName(),
   deletes: [ {
      q: { $expr: { $eq: [ "$flavor", "$$targetFlavor" ] } },
      limit: 1
   } ],
   let : { targetFlavor: "strawberry" }
} )

Saída

O documento devolvido contém um subconjunto dos seguintes campos:

delete.ok

O status do comando.

delete.n

O número de documentos excluídos.

delete.writeErrors

Uma array de documentos que contém informações sobre qualquer erro encontrado durante a operação de exclusão. A writeErrors array contém um documento de erro para cada declaração de exclusão com erro.

Cada documento de erro contém as seguintes informações:

delete.writeErrors.index

Um inteiro que identifica a declaração de exclusão na array deletes , que usa um índice baseado em zero.

delete.writeErrors.code

Um valor inteiro identificando o erro.

delete.writeErrors.errmsg

Uma descrição do erro.

delete.writeConcernError

Uma array de documentos que contém informações sobre qualquer erro encontrado durante a operação de exclusão.

Alterado na versão 7.0.6.:

(também disponível em 6.0.14 e 5.0.30): quando delete é executado em, os erros de preocupação de gravação são sempre relatados, mesmo quando ocorrem um ou mais mongos delete erros de escrita. Em versões anteriores, a ocorrência de erros de gravação poderia fazer com que não relatasse erros de preocupação de gravação .

Cada documento de erro contém os seguintes campos:

delete.writeConcernError.code

Um valor inteiro que identifica a causa do erro de write concern.

delete.writeConcernError.errmsg

Uma descrição da causa do erro de write concern.

delete.writeConcernError.errInfo.writeConcern

O 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:

delete.writeConcernError.errInfo.writeConcern.provenance

Um 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ência	Descrição
clientSupplied	A write concern foi especificada no aplicativo.
customDefault	A write concern originou-se de um valor padrão personalizado definido. Consulte setDefaultRWConcern.
getLastErrorDefaults	A write concern originada do campo settings.getLastErrorDefaults do conjunto de réplicas.
implicitDefault	A write concern originou-se do servidor na ausência de todas as outras especificações de write concern.

Veja a seguir um documento de exemplo retornado para um comando delete bem-sucedido:

{ ok: 1, n: 1 }

A seguir está um documento de exemplo retornado para um comando delete que encontrou um erro porque especificou um índice inexistente no campo hint:

{
  n: 0,
  writeErrors: [
    {
      index: 0,
      code: 2,
      errmsg: 'error processing query: ns=test.products: hat $eq "bowler"\n' +
        'Sort: {}\n' +
        'Proj: {}\n' +
        ' planner returned error :: caused by :: hint provided does not correspond to an existing index'
    }
  ],
  ok: 1
}