MongoDB\Operation\Count Class Reference

Inheritance diagram for MongoDB\Operation\Count:

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	$databaseName	Database name
string	$collectionName	Collection name
array | object	$filter	Query by which to filter documents
array	$options	Command options

Exceptions

InvalidArgumentException

for 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

UnexpectedValueException	if the command response was malformed
UnsupportedException	if read concern is used and unsupported
DriverRuntimeException	for 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:

• cache/stores/mongodb/MongoDB/Operation/Count.php