OPTIONS

db.collection.findOneAndDelete()

On this page

Definition

db.collection.findOneAndDelete(filter, options)

New in version 3.2.

Deletes a single document based on the filter and sort criteria, returning the deleted document.

The findOneAndDelete() method has the following form:

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

The findOneAndDelete() method takes the following parameters:

Parameter Type Description
filter document

The selection criteria for the update. The same query selectors as in the find() method are available.

Specify an empty document { } to delete the first document returned in the collection.

projection document

Optional. A subset of fields to return.

To return all fields in the returned document, omit this parameter.

sort document

Optional. Specifies a sorting order for the documents matched by the filter.

See cursor.sort().

maxTimeMS number Optional. Specifies a time limit in milliseconds within which the operation must complete within. Throws an error if the limit is exceeded.
Returns:Returns the deleted document.

Behavior

findOneAndDelete() deletes the first matching document in the collection that matches the filter. The sort parameter can be used to influence which document is updated.

The projection parameter takes a document in the following form:

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

The <boolean> value can be any of the following:

  • 1 or true to include the field. The method returns the _id field even if it is not explicitly stated in the projection parameter.
  • 0 or false to exclude the field. This can be used on any field, including _id.

Examples

Delete A Document

The grades collection contains documents similar to the following:

{ _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 }

The following operation finds the first document where name : M. Tagnum and deletes it:

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

The operation returns the original document that has been deleted:

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

Sort And Delete A Document

The grades collection contains documents similar to the following:

{ _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 }

The following operation first finds all documents where name : "A. MacDyver". It then sorts by points ascending before deleting the document with the lowest points value:

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

The operation returns the original document that has been deleted:

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

Projecting the Deleted Document

The following operation uses projection to only return the _id and assignment fields in the returned document:

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

The operation returns the original document with the assignment and _id fields:

{ _id: 6322, "assignment" : 2 }

Update Document with Time Limit

The following operation sets a 5ms time limit to complete the deletion:

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

If the operation exceeds the time limit, it returns:

Error: findAndModifyFailed failed: { "ok" : 0, "errmsg" : "operation exceeded time limit", "code" : 50 }

Was this page helpful?

Yes No

Thank you for your feedback!

We're sorry! You can Report a Problem to help us improve this page.