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/ -> CountDocuments.php (source)

[Source view]

Differences Between: [Versions 400 and 401]

(no description)

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

Defines 1 class

CountDocuments:: (3 methods):
  __construct()
  execute()
  createAggregate()


Class: CountDocuments  - X-Ref

Operation for obtaining an exact count of documents in a collection

__construct($databaseName, $collectionName, $filter, array $options = [])   X-Ref
Constructs an aggregate command for counting documents

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.

* limit (integer): The maximum number of documents to count.

* maxTimeMS (integer): The maximum amount of time to allow the query to
run.

* readConcern (MongoDB\Driver\ReadConcern): Read concern.

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

* readPreference (MongoDB\Driver\ReadPreference): Read preference.

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

Sessions are not supported for server versions < 3.6.

* skip (integer): The number of documents to skip before returning the
documents.

param: string       $databaseName   Database name
param: string       $collectionName Collection name
param: array|object $filter         Query by which to filter documents
param: array        $options        Command options

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

return: integer
param: Server $server

createAggregate()   X-Ref

return: Aggregate