db.collection.findOneAndDelete()

Correspondência de documento

findOneAndDelete() exclui o primeiro documento correspondente na coleção que corresponde ao filter. O parâmetro sort pode ser usado para influenciar qual documento será excluído.

Projeção

O parâmetro projection obtém um documento no seguinte formato:

{ field1: <value>, field2: <value> ... }

Coleções fragmentadas

Ao usar db.collection.findOneAndDelete() em uma coleção fragmentada, o query deve conter uma condição de igualdade na chave de fragmento.

Os documentos em uma coleção fragmentada podem não ter campos de chave de fragmento. Para direcionar um documento que não tem a chave de fragmento, você pode usar a correspondência de igualdade nullem conjunto com outra condição de filtro (como no campo _id). Por exemplo:

{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key

Transações

db.collection.findOneAndDelete() 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.

Entradas de oplog

Se uma operação db.collection.findOneAndDelete() excluir um documento com êxito, a operação adicionará uma entrada no oplog (registro de operações). Se a operação falhar ou não localizar um documento a ser excluído, a operação não adicionará uma entrada no oplog.

Excluir um documento

A collection scores contém documentos semelhantes aos seguintes:

 db.scores.insertMany( [
   { _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
   { _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
   { _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
   { _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
   { _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
   { _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }
] )

A seguinte operação localiza o primeiro documento onde name : M. Tagnum e o exclui:

db.scores.findOneAndDelete(
   { "name" : "M. Tagnum" }
)

A operação retorna o documento original que foi excluído:

{ _id: 6312, name: "M. Tagnum", "assignment" : 5, "points" : 30 }

Excluir um documento usando o WriteConcern

A collection scores contém documentos semelhantes aos seguintes:

db.scores.insertMany( [
   { _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
   { _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
   { _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
   { _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
   { _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
   { _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }
] )

A operação a seguir usa um documento de preocupação de gravação dentro do método db.collection.findOneAndDelete() com opções:

• w:1 para solicitar a confirmação de que a operação de escrita foi propagada para o mongod autônomo ou para o primário em um conjunto de réplicas.

• j:true para informar o número de instâncias do MongoDB especificadas em w:1 para que a exclusão seja gravada no diário em disco.

• wtimeout : 1000 especificar um limite de tempo, em milésimos de segundo, para o write concern. wtimeout só é aplicável para valores w maiores que 1.

db.scores.findOneAndDelete(
   { name: "A. MacDyver" },
   {
      writeConcern: {
         w : 1,
         j : true,
         wtimeout : 1000
      }
   }
)

A operação retorna o seguinte documento:

{ _id: 6305, name: 'A. MacDyver', assignment: 5, points: 24 }

O documento é excluído com as opções do writeConcern especificadas.

Classificar e excluir um documento

A collection scores contém documentos semelhantes aos seguintes:

db.scores.insertMany( [
   { _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
   { _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
   { _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
   { _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
   { _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
   { _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }
] )

A operação a seguir localiza primeiro todos os documentos onde name : "A. MacDyver". Em seguida, ele classifica points crescente antes de excluir o documento com o menor valor de pontos:

db.scores.findOneAndDelete(
   { "name" : "A. MacDyver" },
   { sort : { "points" : 1 } }
)

A operação retorna o documento original que foi excluído:

{ _id: 6322, name: "A. MacDyver", "assignment" : 2, "points" : 14 }

Projetando o documento excluído

A seguinte operação usa projeção para retornar somente os campos _id e assignment no documento retornado:

db.scores.findOneAndDelete(
   { "name" : "A. MacDyver" },
   { sort : { "points" : 1 }, projection: { "assignment" : 1 } }
)

A operação retorna o documento original com os campos assignment e _id:

{ _id: 6322, "assignment" : 2 }

Atualizar documento com limite de tempo

A seguinte operação define um limite de tempo de 5ms para concluir a exclusão:

try {
   db.scores.findOneAndDelete(
      { "name" : "A. MacDyver" },
      { sort : { "points" : 1 }, maxTimeMS : 5 }
   )
}
catch(e){
   print(e)
}

Se a operação exceder o limite de tempo, ela retornará:

MongoServerError: operation exceeded time limit: { "ok": 0, "code" : 50, "codeName" : "MaxTimeMSExpired" }

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:

db.myColl.insertMany( [
   { _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.findOneAndDelete(
   { category: "cafe", status: "a" },
   { collation: { locale: "fr", strength: 1 } }
);

A operação retorna o seguinte documento:

{ "_id" : 1, "category" : "café", "status" : "A" }