Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of PHP Library Manual, refer to the upgrade documentation.

MongoDB\Collection::replaceOne()

Definition

MongoDB\Collection::replaceOne

Replace at most one document that matches the filter criteria. If multiple documents match the filter criteria, only the first matching document will be replaced.

function replaceOne($filter, $replacement, array $options = []): MongoDB\UpdateResult

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
upsert boolean Optional. If set to true, creates a new document when no document matches the query criteria. The default value is false, which does not insert a new document when no match is found.
bypassDocumentValidation boolean

Optional. If true, allows the write operation to circumvent document level validation. Defaults to false.

This option is available in MongoDB 3.2+ and is ignored for older server versions, which do not support document level validation.

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.

This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.

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.

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.2+ and will result in an exception at execution time if specified for an older server version.

New in version 1.6.

session MongoDB\Driver\Session

Optional. Client session to associate with the operation.

Sessions are not supported for server versions prior to 3.6.

New in version 1.3.

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

A MongoDB\UpdateResult object, which encapsulates a MongoDB\Driver\WriteResult object.

Errors/Exceptions

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\BulkWriteException for errors related to the write operation. Users should inspect the value returned by getWriteResult() to determine the nature of the error.

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).

If a MongoDB\Driver\Exception\BulkWriteException is thrown, users should call getWriteResult() and inspect the returned MongoDB\Driver\WriteResult object to determine the nature of the error.

For example, a write operation may have been successfully applied to the primary server but failed to satisfy the write concern (e.g. replication took too long). Alternatively, a write operation may have failed outright (e.g. unique key violation).

Example

The following example replaces the document with restaurant_id of "40356068" in the restaurants collection in the test database:

<?php

$collection = (new MongoDB\Client)->test->restaurants;

$updateResult = $collection->replaceOne(
    [ 'restaurant_id' => '40356068' ],
    [
        'name' => 'New Restaurant',
        'restaurant_id' => '99988877',
        'borough' => 'Queens',
        'cuisine' => 'Cafe',
        'grades' => [],
    ]
);

printf("Matched %d document(s)\n", $updateResult->getMatchedCount());
printf("Modified %d document(s)\n", $updateResult->getModifiedCount());

The output would then resemble:

Matched 1 document(s)
Modified 1 document(s)