MongoDB\Collection::count()

Definição

MongoDB\Collection::count()

Conte o número de documentos que correspondem aos critérios de filtro.

function count(
    array|object $filter = [],
    array $options = []
): integer

Parâmetros

$filter : array|object

Os critérios de filtro que especificam os documentos a serem contados.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
agrupamento	array|object	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. Se o agrupamento não for especificado, mas a coleção tiver um agrupamento padrão, a operação usará o agrupamento especificado para a coleção. Se nenhum agrupamento for especificado para a coleção nem para a operação, o MongoDB usará a comparação binária simples usada nas versões anteriores para comparações de strings.
comment	misto	Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidades na versão 1.13.
dica	string|array|objeto	O índice a ser utilizado. Especifique o nome do índice como uma string ou o padrão da chave do índice como um documento. Se especificado, o sistema de query considerará apenas os planos usando o índice sugerido. Changed in version 1.2: Se um documento for fornecido, ele será passado para o comando como está. Anteriormente, a biblioteca convertia o padrão de chave em um nome de índice.
limit	inteiro	O número máximo de documentos correspondentes a serem devolvidos.
maxTimeMS	inteiro	O limite de tempo cumulativo em milésimos de segundo para operações de processamento no cursor. O MongoDB aborta a operação o mais cedo possível após o ponto de interrupção.
readConcern	MongoDB\Driver\ReadConcern	Read concern a ser usada para a operação. O padrão é a read concern da coleção. Não é possível especificar uma read concern para operações individuais como parte de uma transação. Em vez disso, defina a opção readConcern ao iniciar a transação.
readPreference	MongoDB\Driver\ReadPreference	Preferência de leitura a ser usada na operação. O padrão é a preferência de leitura da coleção.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidades na versão 1.3.
ignorar	inteiro	O número de documentos correspondentes a ignorar antes de retornar os resultados.

Return Values

O número de documentos que correspondem aos critérios de filtro.

Erros/exceções

MongoDB\Exception\UnexpectedValueException se a resposta do comando do servidor estiver malformada.

MongoDB\Exception\UnsupportedException se as opções forem usadas e não aceitas pelo servidor selecionado (p. ex., collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo erros de conexão).

Comportamento

This method is deprecated and cannot be executed within a transaction. It has always been implemented using the count command. The behavior of the count command differs depending on the options passed to it and may or may not provide an accurate count. When no query filter is provided, the count command provides an estimate using collection metadata. Even when provided with a query filter the count command can return inaccurate results with a sharded cluster if orphaned documents exist or if a chunk migration is in progress. The MongoDB\Collection::countDocuments() method avoids these sharded cluster problems entirely.

Ao avaliar critérios de query, o MongoDB compara tipos e valores de acordo com suas próprias regras de comparação para tipos BSON, o que difere das regras de comparação e malabarismo de tipos do PHP. Ao corresponder a um tipo BSON especial, os critérios de query devem usar a respectiva classe BSON na extensão (por exemplo use MongoDB\BSON\ObjectId para corresponder a um ObjectId).

Veja também

• referência do comando de contagem no manual do MongoDB

• MongoDB\Collection::countDocuments()

• MongoDB\Collection::estimatedDocumentCount()