MongoDB\Collection::estimatedDocumentCount()

Definição

MongoDB\Collection::estimatedDocumentCount()

Obtém um número estimado de documentos na collection usando os metadados da collection.

function countDocuments(array $options = []): integer

Parâmetros

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
comment	misto	Permite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do profiler do banco de dados, saída currentOp e registros. Para usar esta opção, você deve se conectar ao MongoDB 6.0 ou posterior. Se você estiver conectado a uma versão anterior, o servidor retornará uma exceção no tempo de execução. Novidade na versão 1.13.
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.

Return Values

Um número estimado de documentos na collection.

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

Esse método retorna uma estimativa da contagem de documentos na coleção usando metadados da coleção, em vez de contar os documentos ou consultar um índice. Este método não aceita uma opção session e não pode ser executado dentro de uma transação. Consulte Contagem: Comportamento no manual MongoDB para obter mais informações.

Este método é implementado usando o comando de contagem. O count comando não está incluído na versão 1 da API estável. Se você habilitar a API estável e quiser usar esse método, atualize a versão do servidor para o MongoDB 6.0 ou desative o modo rigoroso para evitar erros.

Veja também

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

• MongoDB\Collection::countDocuments()