Moodle PHP Documentation 4.1
Moodle 4.1.19+ (Build: 20250711) (5f47dc23ffc)
MongoDB\Operation\Count Class Reference
Inheritance diagram for MongoDB\Operation\Count:
MongoDB\Operation\Executable MongoDB\Operation\Explainable MongoDB\Operation\Executable

Public Member Functions

 __construct (string $databaseName, string $collectionName, $filter=[], array $options=[])
 Constructs a count command.
 
 execute (Server $server)
 Execute the operation.
 
 getCommandDocument (Server $server)
 Returns the command document for this operation.
 

Constructor & Destructor Documentation

◆ __construct()

MongoDB\Operation\Count::__construct ( string $databaseName,
string $collectionName,
$filter = [],
array $options = [] )

Constructs a count command.

Supported options:

  • 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.
  • 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.
  • readPreference (MongoDB::Driver::ReadPreference): Read preference.
  • session (MongoDB::Driver::Session): Client session.
  • skip (integer): The number of documents to skip before returning the documents.
Parameters
string$databaseNameDatabase name
string$collectionNameCollection name
array | object$filterQuery by which to filter documents
array$optionsCommand options
Exceptions
InvalidArgumentExceptionfor parameter/option parsing errors

Member Function Documentation

◆ execute()

MongoDB\Operation\Count::execute ( Server $server)

Execute the operation.

See also
Executable::execute()
Return values
integer
Exceptions
UnexpectedValueExceptionif the command response was malformed
UnsupportedExceptionif read concern is used and unsupported
DriverRuntimeExceptionfor other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

◆ getCommandDocument()

MongoDB\Operation\Count::getCommandDocument ( Server $server)

Returns the command document for this operation.

See also
Explainable::getCommandDocument()
Return values
array

Implements MongoDB\Operation\Explainable.


The documentation for this class was generated from the following file: