Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/Operation/ -> Update.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

File Size: 305 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Update:: (6 methods):
  __construct()
  execute()
  getCommandDocument()
  createBulkWriteOptions()
  createExecuteOptions()
  createUpdateOptions()


Class: Update  - X-Ref

Operation for the update command.

This class is used internally by the ReplaceOne, UpdateMany, and UpdateOne
operation classes.

__construct(string $databaseName, string $collectionName, $filter, $update, array $options = [])   X-Ref
Constructs a update command.

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.

* multi (boolean): When true, updates all documents matching the query.
This option cannot be true if the $update argument is a replacement
document (i.e. contains no update operators). The default is false.

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

* writeConcern (MongoDB\Driver\WriteConcern): Write concern.

param: string       $databaseName   Database name
param: string       $collectionName Collection name
param: array|object $filter         Query by which to delete documents
param: array|object $update         Update to apply to the matched
param: array        $options        Command options

execute(Server $server)   X-Ref
Execute the operation.

return: UpdateResult

getCommandDocument(Server $server)   X-Ref
Returns the command document for this operation.

return: array

createBulkWriteOptions()   X-Ref
Create options for constructing the bulk write.


createExecuteOptions()   X-Ref
Create options for executing the bulk write.


createUpdateOptions()   X-Ref
Create options for the update command.

Note that these options are different from the bulk write options, which
are created in createExecuteOptions().