Classificar resultados

Visão geral

Neste guia, você pode aprender como usar operações de classificação para ordenar seus resultados de operações de leitura com o driver MongoDB Kotlin.

A operação de classificação ordena os documentos retornados da sua query de acordo com os critérios de classificação especificados. Os critérios de classificação são as regras que você passa para o MongoDB e descrevem como você gostaria que seus dados fossem ordenados. Alguns exemplos de critérios de classificação são:

• Do menor número para o maior número

• Hora do dia mais antiga para a última hora do dia

• Ordem alfabética pelo nome

Leia este guia para saber como executar as seguintes ações:

• Executar classificações crescentes e classificações decrescentes

• Combinar critérios de classificação

• Classificar na pontuação de texto de um Atlas Search

Os exemplos deste guia usam uma collection de amostras que contém os seguintes documentos:

{ "_id": 1, "date": "2022-01-03", "orderTotal": 17.86, "description": "1/2 lb cream cheese and 1 dozen bagels" },
{ "_id": 2, "date": "2022-01-11", "orderTotal": 83.87, "description": "two medium vanilla birthday cakes" },
{ "_id": 3, "date": "2022-01-11", "orderTotal": 19.49, "description": "1 dozen vanilla cupcakes" },
{ "_id": 4, "date": "2022-01-15", "orderTotal": 43.62, "description": "2 chicken lunches and a diet coke" },
{ "_id": 5, "date": "2022-01-23", "orderTotal": 60.31, "description": "one large vanilla and chocolate cake" },
{ "_id": 6, "date": "2022-01-23", "orderTotal": 10.99, "description": "1 bagel, 1 orange juice, 1 muffin" }

Esses dados são modelados com a seguinte classe de dados Kotlin:

data class Order(
    @BsonId val id: Int,
    val date: String,
    val orderTotal: Double,
    val description: String,
)

Métodos de classificação

Você pode classificar os resultados recuperados por uma query ou classificar os resultados dentro de uma aggregation pipeline.

Para classificar seus resultados de query, utilize o método sort() de uma instância do FindFlow . Para classificar seus resultados dentro de um pipeline de agregação, utilize o método de fábrica estático do Aggregates.sort() . Ambos os métodos recebem objetos que implementam a interface Bson como argumentos. Para obter mais informações, consulte a documentação da API para a interface BSON.

Você pode utilizar o método sort() de uma instância do FindFlow como segue:

val resultsFlow = collection.find().sort(Sorts.ascending(Order::orderTotal.name))

Você pode usar o método Aggregates.sort() em um aggregation pipeline para classificar os documentos na coleção de amostras do menor para o maior valor do campo orderTotal da seguinte forma:

val resultsFlow = collection.aggregate(listOf(
    Aggregates.sort(Sorts.ascending(Order::orderTotal.name))
))
resultsFlow.collect { println(it) }

Order(id=6, date=2022-01-23, orderTotal=10.99, description=1 bagel, 1 orange juice, 1 muffin)
Order(id=1, date=2022-01-03, orderTotal=17.86, description=1/2 lb cream cheese and 1 dozen bagels)
Order(id=3, date=2022-01-11, orderTotal=19.49, description=1 dozen vanilla cupcakes)
Order(id=4, date=2022-01-15, orderTotal=43.62, description=2 chicken lunches and a diet coke)
Order(id=5, date=2022-01-23, orderTotal=60.31, description=one large vanilla and chocolate cake)
Order(id=2, date=2022-01-11, orderTotal=83.87, description=two medium vanilla birthday cakes)

Nos trechos de código anteriores, especificamos os critérios de classificação usando a classe de construtor Sorts . Embora seja possível especificar critérios de classificação usando qualquer classe que implemente a interface Bson , recomendamos que você especifique os critérios de classificação por meio do construtor Sorts . Para obter mais informações sobre a classe de construtor Sorts , consulte o guia de construtor Sort .

Para obter mais informações sobre as classes e interfaces nesta seção, consulte a seguinte Documentação da API:

• FindFlow

• Agregados

• Tipos

• BSON

• Documento

Direção de classificação

A direção da sua classificação pode ser ascendente ou descendente. Uma classificação crescente ordena seus resultados do menor para o maior. Uma classificação decrescente ordena seus resultados do maior para o menor.

Aqui estão alguns exemplos de dados classificados em ordem crescente:

• Números: 1, 2, 3, 43, 43, 55, 120

• Datas: 10/03/1990, 01/1995, 30/10/2005, 21/12/2005

• Palavras (ASCII): Banana, endro, cenoura, pepino, homus

Aqui estão alguns exemplos de dados classificados em ordem decrescente:

• Números: 100, 30, 12, 12, 9, 3, 1

• Datas: 01/2020, 11/12/1998, 10/12/1998, 22/07/1975

• Palavras (ASCII reverso): pêra, Uva, Maçã, Queque

As subseções a seguir mostram como especificar esses critérios de classificação.

collection.find().sort(Sorts.ascending("<field name>"))

val resultsFlow = collection.find()
    .sort(Sorts.ascending(Order::orderTotal.name))
resultsFlow.collect { println(it) }

Order(id=6, date=2022-01-23, orderTotal=10.99, description=1 bagel, 1 orange juice, 1 muffin)
Order(id=1, date=2022-01-03, orderTotal=17.86, description=1/2 lb cream cheese and 1 dozen bagels)
Order(id=3, date=2022-01-11, orderTotal=19.49, description=1 dozen vanilla cupcakes)
Order(id=4, date=2022-01-15, orderTotal=43.62, description=2 chicken lunches and a diet coke)
Order(id=5, date=2022-01-23, orderTotal=60.31, description=one large vanilla and chocolate cake)
Order(id=2, date=2022-01-11, orderTotal=83.87, description=two medium vanilla birthday cakes)

val resultsFlow = collection.find()
    .sort(Sorts.descending(Order::orderTotal.name))
resultsFlow.collect { println(it) }

Order(id=2, date=2022-01-11, orderTotal=83.87, description=two medium vanilla birthday cakes)
Order(id=5, date=2022-01-23, orderTotal=60.31, description=one large vanilla and chocolate cake)
Order(id=4, date=2022-01-15, orderTotal=43.62, description=2 chicken lunches and a diet coke)
Order(id=3, date=2022-01-11, orderTotal=19.49, description=1 dozen vanilla cupcakes)
Order(id=1, date=2022-01-03, orderTotal=17.86, description=1/2 lb cream cheese and 1 dozen bagels)
Order(id=6, date=2022-01-23, orderTotal=10.99, description=1 bagel, 1 orange juice, 1 muffin)

collection.find().sort(Sorts.ascending(Order::date.name))

collection.find().sort(Sorts.ascending(Order::date.name, Order::orderTotal.name))

Order(id=1, date=2022-01-03, orderTotal=17.86, description=1/2 lb cream cheese and 1 dozen bagels)
Order(id=3, date=2022-01-11, orderTotal=19.49, description=1 dozen vanilla cupcakes)
Order(id=2, date=2022-01-11, orderTotal=83.87, description=two medium vanilla birthday cakes)
Order(id=4, date=2022-01-15, orderTotal=43.62, description=2 chicken lunches and a diet coke)
Order(id=6, date=2022-01-23, orderTotal=10.99, description=1 bagel, 1 orange juice, 1 muffin)
Order(id=5, date=2022-01-23, orderTotal=60.31, description=one large vanilla and chocolate cake)

val orderBySort = Sorts.orderBy(
    Sorts.descending(Order::date.name), Sorts.ascending(Order::orderTotal.name)
)
val results = collection.find().sort(orderBySort)
results.collect {println(it) }

Order(id=6, date=2022-01-23, orderTotal=10.99, description=1 bagel, 1 orange juice, 1 muffin)
Order(id=5, date=2022-01-23, orderTotal=60.31, description=one large vanilla and chocolate cake)
Order(id=4, date=2022-01-15, orderTotal=43.62, description=2 chicken lunches and a diet coke)
Order(id=3, date=2022-01-11, orderTotal=19.49, description=1 dozen vanilla cupcakes)
Order(id=2, date=2022-01-11, orderTotal=83.87, description=two medium vanilla birthday cakes)
Order(id=1, date=2022-01-03, orderTotal=17.86, description=1/2 lb cream cheese and 1 dozen bagels)

Pesquisa de texto

Você pode especificar a ordem dos resultados de uma de texto Atlas Search considerando a proximidade dos string valores de de cada campo de resultado especificados pelo índice de texto da coleção à sua Atlas Search string do . O texto do Atlas Search atribui uma pontuação numérica de texto para indicar até que ponto cada resultado corresponde à Atlas Search string do . Use o método de fábrica estática Sorts.metaTextScore() para criar seus critérios de classificação para classificar pela pontuação de texto.

No exemplo de código a seguir, mostramos como você pode usar o método Sorts.metaTextScore() para classificar os resultados de um Atlas Search de texto na coleção de amostras. O exemplo de código utiliza os construtores Filtros, Índices e Projeções .

O exemplo de código executa a seguinte ação:

1. Cria um índice de texto para sua coleção de amostra no campo description . Se você chamar createIndex() especificando um índice que já existe na coleção, a operação não criará um novo índice.

2. Executa sua pesquisa de texto para a frase "vanilla".

3. Projeta pontuações de texto em seus resultados de query como o campo score .

4. Classifica seus resultados por pontuação de texto (primeira correspondência).

Os dados são modelados com a seguinte classe de dados Kotlin:

data class OrderScore(
   @BsonId val id: Int,
   val description: String,
   val score: Double
)

import com.mongodb.client.model.Sorts
import com.mongodb.client.model.Projections
import com.mongodb.client.model.Filters
import com.mongodb.client.model.Indexes

collection.createIndex(Indexes.text(Order::description.name))
val metaTextScoreSort = Sorts.orderBy(
    Sorts.metaTextScore(OrderScore::score.name),
    Sorts.descending("_id")
)
val metaTextScoreProj = Projections.metaTextScore(OrderScore::score.name)
val searchTerm = "vanilla"
val searchQuery = Filters.text(searchTerm)
val results = collection.find<OrderScore>(searchQuery)
    .projection(metaTextScoreProj)
    .sort(metaTextScoreSort)
results.collect { println(it) }

OrderScore(id=3, description=1 dozen vanilla cupcakes, score=0.625)
OrderScore(id=5, description=one large vanilla and chocolate cake, score=0.6)
OrderScore(id=2, description=two medium vanilla birthday cakes, score=0.6)

Para obter mais informações sobre as aulas nesta seção, consulte a seguinte documentação da API:

• Filtros

• Índices

• Projeções

• MongoCollection

Para obter mais informações, consulte a classe Classificações Documentação da API. Consulte a documentação manual do servidor para obter mais informações sobre o operador de query $text e o operador de pipeline de agregação $meta .