db.collection.findAndModify()¶

On this page

Definition¶

db.collection.findAndModify(document)¶

Modifies and returns a single document. By default, the returned document does not include the modifications made on the update. To return the document with the modifications made on the update, use the new option. The findAndModify() method is a shell helper around the findAndModify command.

The findAndModify() method has the following form:

db.collection.findAndModify({
    query: <document>,
    sort: <document>,
    remove: <boolean>,
    update: <document>,
    new: <boolean>,
    fields: <document>,
    upsert: <boolean>,
    bypassDocumentValidation: <boolean>,
    writeConcern: <document>,
    collation: <document>
});

The db.collection.findAndModify() method takes a document parameter with the following embedded document fields:

Parameter	Type	Description
`query`	document	Optional. The selection criteria for the modification. The `query` field employs the same query selectors as used in the `db.collection.find()` method. Although the query may match multiple documents, `findAndModify()` will only select one document to modify.
`sort`	document	Optional. Determines which document the operation modifies if the query selects multiple documents. `findAndModify()` modifies the first document in the sort order specified by this argument.
`remove`	boolean	Must specify either the `remove` or the `update` field. Removes the document specified in the `query` field. Set this to `true` to remove the selected document . The default is `false`.
`update`	document	Must specify either the `remove` or the `update` field. Performs an update of the selected document. The `update` field employs the same update operators or `field: value` specifications to modify the selected document.
`new`	boolean	Optional. When `true`, returns the modified document rather than the original. The `findAndModify()` method ignores the `new` option for `remove` operations. The default is `false`.
`fields`	document	Optional. A subset of fields to return. The `fields` document specifies an inclusion of a field with `1`, as in: `fields: { <field1>: 1, <field2>: 1, ... }`. See projection.
`upsert`	boolean	Optional. Used in conjuction with the `update` field. When `true`, `findAndModify()` either: Creates a new document if no documents match the `query`. For more details see upsert behavior. Updates a single document that matches the `query`. To avoid multiple upserts, ensure that the `query` fields are uniquely indexed. Defaults to `false`.
`bypassDocumentValidation`	boolean	Optional. Enables `db.collection.findAndModify` to bypass document validation during the operation. This lets you update documents that do not meet the validation requirements. New in version 3.2.
`writeConcern`	document	Optional. A document expressing the write concern. Omit to use the default write concern. New in version 3.2.
`maxTimeMS`	integer	Optional. Specifies a time limit in milliseconds for processing the operation.
`collation`	document	Optional. Specifies the collation to use for the operation. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. The collation option has the following syntax: collation: { locale: <string>, caseLevel: <boolean>, caseFirst: <string>, strength: <int>, numericOrdering: <boolean>, alternate: <string>, maxVariable: <string>, backwards: <boolean> } When specifying collation, the `locale` field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. If the collation is unspecified but the collection has a default collation (see `db.createCollection()`), the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operations, MongoDB uses the simple binary comparison used in prior versions for string comparisons. You cannot specify multiple collations for an operation. For example, you cannot specify different collations per field, or if performing a find with a sort, you cannot use one collation for the find and another for the sort. New in version 3.4.

Return Data¶

For remove operations, if the query matches a document, findAndModify() returns the removed document. If the query does not match a document to remove, findAndModify() returns null.

For update operations, findAndModify() returns one of the following:

If the new parameter is not set or is false:
- the pre-modification document if the query matches a document;
- otherwise, null.
If new is true:
- the modified document if the query returns a match;
- the inserted document if upsert: true and no document matches the query;
- otherwise, null.

Changed in version 3.0: In previous versions, if for the update, sort is specified, and upsert: true, and the new option is not set or new: false, db.collection.findAndModify() returns an empty document {} instead of null.

Behavior¶

Upsert and Unique Index¶

When findAndModify() includes the upsert: true option and the query field(s) is not uniquely indexed, the method could insert a document multiple times in certain circumstances.

In the following example, no document with the name Andy exists, and multiple clients issue the following command:

db.people.findAndModify({
    query: { name: "Andy" },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } },
    upsert: true
})

Then, if these clients’ findAndModify() methods finish the query phase before any command starts the modify phase, and there is no unique index on the name field, the commands may all perform an upsert, creating multiple duplicate documents.

To prevent the creation of multiple duplicate documents with the same name, create a unique index on the name field. With this unique index in place, the multiple methods will exhibit one of the following behaviors:

Exactly one findAndModify() successfully inserts a new document.
Zero or more findAndModify() methods update the newly inserted document.
Zero or more findAndModify() methods fail when they attempt to insert documents with the same name. If the method fails due to the unique index constraint violation on the name field, you can retry the method. Absent a delete of the document, the retry should not fail.

Sharded Collections¶

When using findAndModify in a sharded environment, the query must contain the shard key for all operations against the sharded cluster for the sharded collections.

findAndModify operations issued against mongos instances for non-sharded collections function normally.

Document Validation¶

The db.collection.findAndModify() method adds support for the bypassDocumentValidation option, which lets you bypass document validation when inserting or updating documents in a collection with validation rules.

Comparisons with the `update` Method¶

When updating a document, findAndModify() and the update() method operate differently:

By default, both operations modify a single document. However, the update() method with its multi option can modify more than one document.
If multiple documents match the update criteria, for findAndModify(), you can specify a sort to provide some measure of control on which document to update.

With the default behavior of the update() method, you cannot specify which single document to update when multiple documents match.
By default, findAndModify() returns the pre-modified version of the document. To obtain the updated document, use the new option.

The update() method returns a WriteResult object that contains the status of the operation. To return the updated document, use the find() method. However, other updates may have modified the document between your update and the document retrieval. Also, if the update modified only a single document but multiple documents matched, you will need to use additional logic to identify the updated document.

When modifying a single document, both findAndModify() and the update() method atomically update the document. See Atomicity and Transactions for more details about interactions and order of operations of these methods.

Examples¶

Update and Return¶

The following method updates and returns an existing document in the people collection where the document matches the query criteria:

db.people.findAndModify({
    query: { name: "Tom", state: "active", rating: { $gt: 10 } },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } }
})

This method performs the following actions:

The query finds a document in the people collection where the name field has the value Tom, the state field has the value active and the rating field has a value greater than 10.
The sort orders the results of the query in ascending order. If multiple documents meet the query condition, the method will select for modification the first document as ordered by this sort.
The update increments the value of the score field by 1.
The method returns the original (i.e. pre-modification) document selected for this update:
```
{
  "_id" : ObjectId("50f1e2c99beb36a0f45c6453"),
  "name" : "Tom",
  "state" : "active",
  "rating" : 100,
  "score" : 5
}
```
To return the modified document, add the new:true option to the method.

If no document matched the query condition, the method returns null.

Upsert¶

The following method includes the upsert: true option for the update operation to either update a matching document or, if no matching document exists, create a new document:

db.people.findAndModify({
    query: { name: "Gus", state: "active", rating: 100 },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } },
    upsert: true
})

If the method finds a matching document, the method performs an update.

If the method does not find a matching document, the method creates a new document. Because the method included the sort option, it returns an empty document { } as the original (pre-modification) document:

{ }

If the method did not include a sort option, the method returns null.

null

Return New Document¶

The following method includes both the upsert: true option and the new:true option. The method either updates a matching document and returns the updated document or, if no matching document exists, inserts a document and returns the newly inserted document in the value field.

In the following example, no document in the people collection matches the query condition:

db.people.findAndModify({
    query: { name: "Pascal", state: "active", rating: 25 },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } },
    upsert: true,
    new: true
})

The method returns the newly inserted document:

{
   "_id" : ObjectId("50f49ad6444c11ac2448a5d6"),
   "name" : "Pascal",
   "rating" : 25,
   "score" : 1,
   "state" : "active"
}

Sort and Remove¶

By including a sort specification on the rating field, the following example removes from the people collection a single document with the state value of active and the lowest rating among the matching documents:

db.people.findAndModify(
   {
     query: { state: "active" },
     sort: { rating: 1 },
     remove: true
   }
)

The method returns the deleted document:

{
   "_id" : ObjectId("52fba867ab5fdca1299674ad"),
   "name" : "XYZ123",
   "score" : 1,
   "state" : "active",
   "rating" : 3
}

Specify Collation¶

New in version 3.4.

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

A collection myColl has the following documents:

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

The following operation includes the collation option:

db.myColl.findAndModify({
    query: { category: "cafe", status: "a" },
    sort: { category: 1 },
    update: { $set: { status: "Updated" } },
    collation: { locale: "fr", strength: 1 }
});

The operation returns the following document:

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