MongoDB\Collection::countDocuments()

Definição

MongoDB\Collection::countDocuments()

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

function countDocuments(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	A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de string , como regras para letras maiúsculas e marcas de acento. Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento. 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.
comentário	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. O comentário pode ser qualquer tipo de BSON válido desde o MongoDB 4.4. As versões anteriores do servidor suportam apenas valores de string.
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.
limite	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	Preocupação de leitura a ser usada para a operação. O padrão é a preocupação de leitura da coleção. Não é possível especificar uma preocupação de leitura 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.
ignorar	inteiro	O número de documentos correspondentes a ignorar antes de retornar os resultados.

Valores de retorno

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

Internamente, esse método usa o operador de pipeline de agregação $group para obter o resultado. Se um parâmetro filter for fornecido, ele será convertido em um operador de pipeline $match . Os estágios $skip e $limit opcionais são adicionados entre $match e group , se presentes nas opções.

Como esse método usa um aggregation pipeline, alguns operadores de query aceitos em um MongoDB\Collection::count() filter não podem ser usados. Considere as seguintes alternativas a esses operadores restritos:

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 da comparação do PHP e digite malabarismo regras. 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

• MongoDB\Collection::estimatedDocumentCount()