/ /

Contagem de documentos

Visão geral

Neste guia, você pode aprender como recuperar contagens precisas e estimadas do número de documentos em uma coleção.

Dados de amostra

Os exemplos neste guia usam a coleção movies no banco de dados sample_mflix dos conjuntos de dados de amostra do Atlas. Para aprender a criar uma implantação gratuita do MongoDB e carregar os conjuntos de dados de amostra, consulte o guia Começar do MongoDB.

A seguinte classe de dados Kotlin modela os documentos nesta coleção:

data class Movie(
    @BsonId
    val id: ObjectId,
    val title: String
)

Recuperar uma contagem precisa

Use o método countDocuments() para contar o número de documentos que estão em uma coleção. Para contar o número de documentos que correspondem aos critérios de pesquisa especificados, passe um filtro de query para o método countDocuments() .

Para saber mais sobre como especificar uma query, consulte Especificar uma query.

Contagem de todos os documentos

Para retornar uma contagem de todos os documentos na collection, chame o método countDocuments() sem argumentos, conforme mostrado no exemplo a seguir:

println(collection.countDocuments())

Contagem de documentos específicos

Para retornar uma contagem de documentos que correspondam a critérios de pesquisa específicos, especifique sua query no método countDocuments() . O exemplo a seguir imprime uma contagem de todos os documentos na collection movies que têm um valor de campo year igual a 1930:

println(collection.countDocuments(eq("year", "1930")))

Personalizar comportamento de contagem

O método countDocuments() aceita parâmetros opcionais na forma de um objeto CountOptions , que representa opções que você pode utilizar para configurar a operação de contagem. Você pode definir essas opções instanciando um novo objeto CountOptions , definindo os campos do objeto usando os métodos correspondentes e passando para o método countDocuments() . Se você não especificar nenhuma opção, o driver não personalizará a operação de contagem.

A tabela a seguir descreve as opções que você pode definir para personalizar countDocuments():

Opção	Descrição
`comment`	Especifica um comentário a ser anexado à operação.
`skip`	Define o número de documentos a ignorar antes de retornar os resultados.
`limit`	Define o número máximo de documentos a contar. Deve ser um número inteiro positivo.
`collation`	Especifica o tipo de agrupamento de idiomas a ser usado ao classificar os resultados. Para obter mais informações, consulte Agrupamento no manual do MongoDB Server .
`hint`	Define o índice para digitalizar documentos.

O exemplo a seguir utiliza um objeto CountOptions para adicionar um comentário à operação countDocuments() :

val options = CountOptions().comment("Retrieving count")
collection.countDocuments(Filters.empty(), options)

Recuperar uma contagem estimada

Use o método estimatedDocumentCount() para recuperar uma estimativa do número de documentos em uma coleção. O método estima a quantidade de documentos com base nos metadados da collection, o que pode ser mais rápido do que realizar uma contagem precisa.

O exemplo a seguir imprime o número estimado de documentos em uma collection:

print(collection.estimatedDocumentCount())

Personalizar comportamento de contagem estimada

O método estimatedDocumentCount() aceita parâmetros opcionais na forma de um objeto EstimatedDocumentCountOptions , que representa opções que você pode utilizar para configurar a operação de contagem. Você pode definir essas opções instanciando um novo objeto EstimatedDocumentCountOptions , definindo os campos do objeto usando os métodos correspondentes e passando para o método estimatedDocumentCount() . Se você não especificar nenhuma opção, o driver não personalizará a operação de contagem.

A tabela a seguir descreve as opções que você pode definir para personalizar estimatedDocumentCount():

Opção	Descrição
`comment`	Especifica um comentário a ser anexado à operação.

O exemplo a seguir utiliza um objeto EstimatedDocumentCountOptions para adicionar um comentário à operação estimatedDocumentCount() :

val options = EstimatedDocumentCountOptions().comment("Retrieving count")
collection.estimatedDocumentCount(options)

Documentação da API

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

Voltar

Especificar uma query

Valores de campo distintos