Docs Menu

Docs HomePHP Library Manual

MongoDB\Collection::countDocuments()

On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Behavior
  • See Also

New in version 1.4.

MongoDB\\Collection::countDocuments()

Count the number of documents that match the filter criteria.

function countDocuments(array|object $filter = [], array $options = []): integer
$filter : array|object
The filter criteria that specifies the documents to count.
$options : array

An array specifying the desired options.

Name
Type
Description
collation
array|object
comment
mixed

Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.

The comment can be any valid BSON type since MongoDB 4.4. Earlier server versions only support string values.

hint
string|array|object

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 matching documents to return.
maxTimeMS
integer

The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.

readConcern

Read concern to use for the operation. Defaults to the collection's read concern.

It is not possible to specify a read concern for individual operations as part of a transaction. Instead, set the readConcern option when starting the transaction.

readPreference

Read preference to use for the operation. Defaults to the collection's read preference.

session

Client session to associate with the operation.

skip
integer
The number of matching documents to skip before returning results.

The number of documents matching the filter criteria.

MongoDB\\Exception\\UnexpectedValueException if the command response from the server was malformed.

MongoDB\\Exception\\UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

MongoDB\\Exception\\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\\Driver\\Exception\\RuntimeException for other errors at the driver level (e.g. connection errors).

Internally, this method uses the $group aggregation pipeline operator to obtain the result. If a filter parameter is given, this is converted into a $match pipeline operator. Optional $skip and $limit stages are added between $match and group if present in the options.

Note

This method counts documents on the server side. To obtain an approximate total number of documents without filters, the MongoDB\\Collection::estimatedDocumentCount() method can be used. This method estimates the number of documents based on collection metadata, thus sacrificing accuracy for performance.

Since this method uses an aggregation pipeline, some query operators accepted within a MongoDB\\Collection::count() filter cannot be used. Consider the following alternatives to these restricted operators:

Restricted
Alternative Syntax

When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the driver (e.g. use MongoDB\\BSON\\ObjectId to match an ObjectId).

←  MongoDB\Collection::count()MongoDB\Collection::createIndex() →