Inheritance diagram for MongoDB\Operation\CountDocuments:

Public Member Functions
	__construct (string $databaseName, string $collectionName, $filter, array $options=[])
	Constructs an aggregate command for counting documents.

	execute (Server $server)
	Execute the operation.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs an aggregate command for counting documents.

Supported options:

collation (document): Collation specification.
comment (mixed): BSON value to attach as a comment to this command.

Only string values are supported for server 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

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

Execute the operation.

Return values

integer

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if collation or read concern is used and unsupported
DriverRuntimeException	for other driver errors (e.g. connection errors)

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