FindOneAndUpdate
in package
implements
Explainable
Operation for updating a document with the findAndModify command.
Tags
Table of Contents
Interfaces
- Explainable
Constants
Properties
- $findAndModify : FindAndModify
Methods
- __construct() : mixed
- Constructs a findAndModify command for updating 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 updating a document.
public
__construct(string $databaseName, string $collectionName, array<string|int, mixed>|object $filter, array<string|int, mixed>|object $update[, array<string|int, mixed> $options = [] ]) : mixed
Supported options:
-
arrayFilters (document array): A set of filters specifying to which array elements an update should apply.
-
bypassDocumentValidation (boolean): If true, allows the write to circumvent document level validation.
-
codec (MongoDB\Codec\DocumentCodec): Codec used to decode documents from BSON to PHP objects.
-
collation (document): Collation specification.
-
comment (mixed): BSON value to attach as a comment to this command.
This is not supported for servers versions < 4.4.
-
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 FindOneAndUpdate::RETURN_DOCUMENT_BEFORE or FindOneAndUpdate::RETURN_DOCUMENT_AFTER. The default is FindOneAndUpdate::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.
-
let (document): 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").
-
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
- $update : array<string|int, mixed>|object
-
Update to apply to the matched document
- $options : array<string|int, mixed> = []
-
Command options
Tags
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|nullgetCommandDocument()
Returns the command document for this operation.
public
getCommandDocument() : array<string|int, mixed>