UpdateOne
in package
implements
Explainable
Operation for updating a single document with the update command.
Tags
Table of Contents
Interfaces
- Explainable
Properties
- $update : Update
Methods
- __construct() : mixed
- Constructs an update command.
- execute() : UpdateResult
- Execute the operation.
- getCommandDocument() : array<string|int, mixed>
- Returns the command document for this operation.
Properties
$update
private
Update
$update
Methods
__construct()
Constructs an update command.
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.
-
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.2 and will result in an exception at execution time if used.
-
session (MongoDB\Driver\Session): Client session.
-
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").
-
sort (document): Determines which document the operation modifies if the query selects multiple documents.
This is not supported for server versions < 8.0 and will result in an exception at execution time if used.
-
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) : UpdateResult
Parameters
- $server : Server
Tags
Return values
UpdateResultgetCommandDocument()
Returns the command document for this operation.
public
getCommandDocument() : array<string|int, mixed>