- Reference >
- MongoDB\Collection Class >
- MongoDB\Collection::findOneAndReplace()
MongoDB\Collection::findOneAndReplace()
On this page
Definition
-
MongoDB\Collection::findOneAndReplace
Finds a single document matching the query and replaces it.
This method has the following parameters:
Parameter Type Description $filter
array|object The filter criteria that specifies the documents to replace. $replacement
array|object The replacement document. $options
array Optional. An array specifying the desired options. The
$options
parameter supports the following options:Option Type Description projection
array|object Optional. The projection specification to determine which fields to include in the returned documents. See Project Fields to Return from Query and Projection Operators in the MongoDB manual. sort
array|object Optional. The sort specification for the ordering of the results. collation
array|object Optional. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. 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, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
comment
mixed Optional. Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.
This is not supported for server versions prior to 4.4 and will result in an exception at execution time if used.
New in version 1.13.
hint
string|array|object Optional. The index to use. Specify either the index name as a string or the index key pattern as a document. If specified, then the query system will only consider plans using the hinted index.
This option is available in MongoDB 4.4+ and will result in an exception at execution time if specified for an older server version.
New in version 1.7.
maxTimeMS
integer Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point. bypassDocumentValidation
boolean Optional. If true
, allows the write operation to circumvent document level validation. Defaults tofalse
.let
array|object Optional. Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g.
$$var
).This is not supported for server versions prior to 5.0 and will result in an exception at execution time if used.
New in version 1.13.
returnDocument
integer Optional. Specifies whether to return the document before the replacement is applied, or after.
returnDocument
supports the following values:MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_BEFORE
(default)MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_AFTER
session
MongoDB\Driver\Session Optional. Client session to associate with the operation.
New in version 1.3.
typeMap
array Optional. The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the collection’s type map.
This will be used for the returned result document.
upsert
boolean Optional. If set to true
, creates a new document when no document matches the query criteria. The default value isfalse
, which does not insert a new document when no match is found.writeConcern
MongoDB\Driver\WriteConcern Optional. Write concern to use for the operation. Defaults to the collection’s write concern.
It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the
writeConcern
option when starting the transaction with startTransaction.
Return Values
An array object for either the original or the replaced document, depending on
the specified value of the returnDocument
option. By default, the original
document is returned. If no document matched the query, null
is returned.
The return type will depend on the typeMap
option.
Errors/Exceptions
MongoDB\Exception\UnexpectedValueException
if the command
response from the server was malformed.
MongoDB\Exception\UnsupportedException
if options are used and
not supported by the selected server (e.g. collation
, readConcern
,
writeConcern
).
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).
Behavior
When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP’s comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the driver (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).
Examples
Consider the following document in the restaurants
collection in the
test
database:
The following operation replaces the document with restaurant_id
of
"41220906"
with a new document:
The output would then resemble:
See Also
MongoDB\Collection::findOneAndDelete()
MongoDB\Collection::findOneAndUpdate()
- findAndModify command reference in the MongoDB manual