Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/cache/stores/mongodb/MongoDB/Operation/ -> Update.php (source)

[Source view]

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

(no description)

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

Defines 1 class

Update:: (5 methods):
  __construct()
  execute()
  getCommandDocument()
  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($databaseName, $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.

This is not supported for server versions < 3.6 and will result in an
exception at execution time if used.

* bypassDocumentValidation (boolean): If true, allows the write to
circumvent document level validation.

For servers < 3.2, this option is ignored as document level validation
is not available.

* collation (document): Collation specification.

This is not supported for server versions < 3.4 and will result in an
exception at execution time if used.

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

Sessions are not supported for server versions < 3.6.

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

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
param: Server $server

getCommandDocument(Server $server)   X-Ref
No description

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

return: array

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

return: array