db.collection.findOneAndDelete()

Definição

db.collection.findOneAndDelete( filter, options )

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de comandos de banco de dados nem drivers específicos de linguagem, como Node.js.

Para o comando de banco de dados de dados, consulte o comando delete.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

Exclui um único documento com base nos critérios filter e sort, devolvendo o documento excluído.

O método findOneAndDelete() tem o seguinte formato:

db.collection.findOneAndDelete(
   <filter>,
   {
     writeConcern: <document>,
     projection: <document>,
     sort: <document>,
     maxTimeMS: <number>,
     collation: <document>
   }
)

O método findOneAndDelete() utiliza os seguintes parâmetros:

Parâmetro	Tipo	Descrição
filter	documento	Os critérios de seleção para a exclusão. Os mesmos seletores de query que no método find() estão disponíveis. Especifique um documento vazio { } para excluir o primeiro documento retornado na coleção. 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 será executada.
writeConcern	documento	Opcional. Um documento que expressa o write concern. Omitir para usar o write concern padrão. { w: <value>, j: <boolean>, wtimeout: <number> } Consulte Excluir um documento usando o WriteConcern para uso. 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.
projection	documento	Opcional. Um subconjunto de campos para retornar. Para retornar todos os campos no documento retornado, omita este parâmetro. Se o argumento de projeção não for um documento, ocorrerá um erro na operação.
sort	documento	Opcional. Especifica uma ordem de classificação para os documentos correspondidos pelo filter. Se o argumento de classificação não for um documento, ocorrerá um erro com a operação. Consulte cursor.sort().
maxTimeMS	número	Opcional. Especifica um limite de tempo em milissegundos dentro do qual a operação deve ser concluída. Lança um erro se o limite for excedido.
collation	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: 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.

Retorna:	Retorna o documento excluído.

Compatibilidade

Esse método 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

Comportamento

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

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

Exemplos

 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 }
] )

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

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

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 }
] )

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

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

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 }
] )

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

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

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

{ _id: 6322, "assignment" : 2 }

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

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

db.myColl.insertMany( [
   { _id: 1, category: "café", status: "A" },
   { _id: 2, category: "cafe", status: "a" },
   { _id: 3, category: "cafE", status: "a" }
] )

db.myColl.findOneAndDelete(
   { category: "cafe", status: "a" },
   { collation: { locale: "fr", strength: 1 } }
);

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