Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/cache/stores/mongodb/MongoDB/Operation/ -> Delete.php (source)

[Source view]

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

(no description)

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

Defines 1 class

Delete:: (5 methods):
  __construct()
  execute()
  getCommandDocument()
  createDeleteOptions()
  createExecuteOptions()


Class: Delete  - X-Ref

Operation for the delete command.

This class is used internally by the DeleteMany and DeleteOne operation
classes.

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

Supported options:

* 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.4 and will result in an
exception at execution time if used.

* session (MongoDB\Driver\Session): Client session.

Sessions are not supported for server versions < 3.6.

* 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: integer      $limit          The number of matching documents to
param: array        $options        Command options

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

param: Server $server
return: DeleteResult

getCommandDocument(Server $server)   X-Ref
No description

createDeleteOptions()   X-Ref
Create options for the delete command.

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

return: array

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

return: array