db.collection.findOneAndReplace()

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

To replace the first document returned in the collection, specify an empty document { }.

If unspecified, defaults to an empty document.

Starting in MongoDB 4.2, the operation returns an error if the query argument is not a document.

The replacement document.

Cannot contain update operators.

The <replacement> document cannot specify an _id value that differs from the replaced document.

Optional. A document expressing the write concern. Omit to use the default write concern.

{ w: <value>, j: <boolean>, wtimeout: <number> }

Do not explicitly set the write concern for the operation if run in a transaction. To use write concern with transactions, see Transactions and Write Concern.

Optional. A subset of fields to return.

To return all fields in the matching document, omit this field.

Starting in MongoDB 4.2, the operation returns an error if the projection field is not a document.

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

Starting in MongoDB 4.2, the operation returns an error if the sort field is not a document.

See cursor.sort().

Optional. When true, findOneAndReplace() either:

• Inserts the document from the replacement parameter if no document matches the filter. Returns null after inserting the new document, unless returnNewDocument is true.

• Replaces the document that matches the filter with the replacement document.

MongoDB will add the _id field to the replacement document if it is not specified in either the filter or replacement documents. If _id is present in both, the values must be equal.

To avoid multiple upserts, ensure that the query fields are uniquely indexed.

Defaults to false.

Optional. Starting in mongosh 0.13.2, returnDocument is an alternative for returnNewDocument. If both options are set, returnDocument takes precedence.

returnDocument: "before" returns the original document. returnDocument: "after" returns the updated document.

Optional. When true, returns the replacement document instead of the original document.

Defaults to false.

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.

Uses the $ array projection operator to return the first element that matches the query condition on the array field. If you specify a non-zero integer for the projection value, the operation treats the value as true.

Not available for views.

Uses the array projection operators ($elemMatch, $slice) to specify the array elements to include.

Not available for views.

Specifies the value of the projected field.

With the use of aggregation expressions and syntax, including the use of literals and aggregation variables, you can project new fields or project existing fields with new values.

• If you specify a non-numeric, non-boolean literal (such as a literal string or an array or an operator expression) for the projection value, the field is projected with the new value, for example:

  • { field: [ 1, 2, 3, "$someExistingField" ] }

  • { field: "New String Value" }

  • { field: { status: "Active", total: { $sum: "$existingArray" } } }

• To project a literal value for a field, use the $literal aggregation expression, for example:

  • { field: { $literal: 5 } }

  • { field: { $literal: true } }

  • { field: { $literal: { fieldWithValue0: 0, fieldWithValue1: 1 } } }

In versions 4.2 and earlier, any specification value (with the exception of the previously unsupported document value) is treated as either true or false to indicate the inclusion or exclusion of the field.