FindOneAndReplace
in package
implements
Executable, Explainable
Operation for replacing a document with the findAndModify command.
Tags
Interfaces, Classes, Traits and Enums
- Executable
- Explainable
Table of Contents
- RETURN_DOCUMENT_AFTER = 2
- RETURN_DOCUMENT_BEFORE = 1
- $findAndModify : FindAndModify
- __construct() : mixed
- Constructs a findAndModify command for replacing a document.
- execute() : array<string|int, mixed>|object|null
- Execute the operation.
- getCommandDocument() : array<string|int, mixed>
- Returns the command document for this operation.
Constants
RETURN_DOCUMENT_AFTER
public
mixed
RETURN_DOCUMENT_AFTER
= 2
RETURN_DOCUMENT_BEFORE
public
mixed
RETURN_DOCUMENT_BEFORE
= 1
Properties
$findAndModify
private
FindAndModify
$findAndModify
Methods
__construct()
Constructs a findAndModify command for replacing a document.
public
__construct(string $databaseName, string $collectionName, array<string|int, mixed>|object $filter, array<string|int, mixed>|object $replacement[, array<string|int, mixed> $options = [] ]) : mixed
Supported options:
-
bypassDocumentValidation (boolean): If true, allows the write to circumvent document level validation.
-
collation (document): Collation specification.
-
hint (string|document): 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 is not supported for server versions < 4.4 and will result in an exception at execution time if used.
-
maxTimeMS (integer): The maximum amount of time to allow the query to run.
-
projection (document): Limits the fields to return for the matching document.
-
returnDocument (enum): Whether to return the document before or after the update is applied. Must be either FindOneAndReplace::RETURN_DOCUMENT_BEFORE or FindOneAndReplace::RETURN_DOCUMENT_AFTER. The default is FindOneAndReplace::RETURN_DOCUMENT_BEFORE.
-
session (MongoDB\Driver\Session): Client session.
-
sort (document): Determines which document the operation modifies if the query selects multiple documents.
-
typeMap (array): Type map for BSON deserialization.
-
upsert (boolean): When true, a new document is created if no document matches the query. The default is false.
-
writeConcern (MongoDB\Driver\WriteConcern): Write concern.
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $filter : array<string|int, mixed>|object
-
Query by which to filter documents
- $replacement : array<string|int, mixed>|object
-
Replacement document
- $options : array<string|int, mixed> = []
-
Command options
Tags
Return values
mixed —execute()
Execute the operation.
public
execute(Server $server) : array<string|int, mixed>|object|null
Parameters
- $server : Server
Tags
Return values
array<string|int, mixed>|object|null —getCommandDocument()
Returns the command document for this operation.
public
getCommandDocument(Server $server) : array<string|int, mixed>
Parameters
- $server : Server