Agrupamentos

Visão geral

Neste guia, você pode aprender como usar agrupamentos para ordenar seus resultados de operação de busca ou agregação por valores de string. Um agrupamento é um conjunto de convenções de ordenação de caracteres que correspondem a um idioma e localidade específicos.

Este guia inclui as seguintes seções:

• Agrupamentos do MongoDB descreve como o MongoDB classifica os valores de string de acordo com o agrupamento padrão e agrupamentos personalizados

• Especificar um agrupamento descreve como criar uma instância de estrutura Collation

• Definir um agrupamento em uma coleção descreve como definir o agrupamento para uma nova coleção

• Definir um agrupamento em um índice descreve como definir o agrupamento para um índice

• Definir um agrupamento em uma operação descreve como aplicar um agrupamento a determinadas operações CRUD

• Informações adicionais fornecem links para recursos e documentação da API para os tipos e métodos mencionados neste guia

Agrupamentos do MongoDB

O MongoDB classifica strings utilizando agrupamento binário por padrão. Esse método de agrupamento usa os valores de caracteres padrão ASCII para comparar e ordenar strings. Alguns idiomas e localidade têm convenções específicas de ordenação de caracteres que diferem do padrão ASCII.

Por exemplo, no francês canadense, o caractere mais acentuado à direita determina a ordem das strings quando os outros caracteres são os mesmos. Considere as seguintes palavras do francês canadense:

• cote

• coté

• côte

• côté

Ao usar o agrupamento binário padrão, o MongoDB classifica as palavras na seguinte ordem:

cote
coté
côte
côté

Nessa ordem de classificação, "coté" é colocado antes de "côte" porque o padrão ASCII posiciona o caractere "o" antes do caractere "o".

Ao usar o agrupamento francês canadense, o MongoDB classifica as palavras na seguinte ordem:

cote
côte
coté
côté

Nessa ordem de classificação, "coté" é colocado depois de "côte" porque as regras de agrupamento francesas canadenses posicionam o caractere "e" antes do caractere "é".

Especificar um agrupamento

Você pode definir um agrupamento especificando uma localidade de agrupamento e outras opções em uma instância de estrutura do Collation . Para começar a construir uma instância do Collation , chame o método Collation::builder() .

A tabela seguinte descreve os métodos de construtor que você pode utilizar para configurar campos de uma instância do Collation . Você deve usar o método locale() para construir uma estrutura Collation válida, mas todos os outros métodos de construtor são opcionais:

let collation = Collation::builder()
    .locale("en_US")
    .build();

Definir um agrupamento em uma coleção

Ao criar uma nova collection, você pode definir o agrupamento para operações futuras chamadas nessa collection. Defina o agrupamento encadeando a função collation() ao método create_collection() , passando sua instância Collation como parâmetro para collation().

let collation = Collation::builder()
    .locale("fr")
    .strength(CollationStrength::Primary)
    .build();
let result = my_db.create_collection("books")
    .collation(collation)
    .await?;

{ "name" : "Emma", "length" : "474" }
{ "name" : "Les Misérables", "length": "1462" }
{ "name" : "Infinite Jest", "length" : "1104" }
{ "name" : "Cryptonomicon", "length" : "918" }
{ "name" : "Ça", "length" : "1138" }

let query = doc! { "name": doc! { "$lt": "Infinite Jest" } };
let mut cursor = my_coll.find(query).await?;
while let Some(doc) = cursor.try_next().await? {
   println!("{}", doc);
}

{ "name": "Emma", "length": 474 }
{ "name": "Cryptonomicon", "length": 918 }
{ "name" : "Ça", "length" : "1138" }

Definir um agrupamento em um índice

Ao criar um novo índice em uma collection, você pode definir o agrupamento para operações que são cobertas pelo índice. Para executar uma operação que usa o índice e seu agrupamento, sua operação e o índice devem especificar o mesmo agrupamento.

Defina o agrupamento do índice usando a função collation() para construir uma instância IndexOptions . Em seguida, passe seu IndexOptions como um argumento para uma função do construtor IndexModel e passe seu IndexModel como um argumento para o método create_index() .

let collation = Collation::builder()
    .locale("en_US")
    .build();
let index_opts = IndexOptions::builder()
    .collation(collation)
    .build();
let index = IndexModel::builder()
    .keys(doc! { "name": 1 })
    .options(index_opts)
    .build();
let result = my_coll.create_index(index).await?;
println!("Created index: {}", result.index_name);

 Created index: name_1

Definir um agrupamento em uma operação

As operações que leem, atualizam e excluem documentos de uma coleção podem usar agrupamentos. A aplicação de um agrupamento a uma operação substitui qualquer agrupamento definido anteriormente para uma coleção ou índice.

Se você aplicar um agrupamento a uma operação que difere do agrupamento de um índice, não poderá usar esse índice. Como resultado, a operação pode não ser executada de forma tão eficiente quanto uma coberta por um índice. Para obter mais informações sobre as desvantagens de classificar operações não cobertas por um índice, consulte Usando índices para classificar resultados de query no manual do servidor.

let collation = Collation::builder()
    .locale("en_US")
    .numeric_ordering(true)
    .build();
let filter = doc! { "length": doc! { "$gt": "1000" } };
let mut cursor = my_coll.find(filter)
    .collation(collation)
    .await?;
while let Some(result) = cursor.try_next().await? {
    println!("{}", result);
};

{ "name" : "Les Misérables", "length": "1462" }
{ "name" : "Infinite Jest", "length" : "1104" }
{ "name" : "Ça", "length" : "1138" }

Informações adicionais

Para saber mais sobre o método find() , consulte o guia Localizar documentos .

Para saber mais sobre agrupamentos, consulte as seguintes páginas de manual do servidor:

• Agrupamentos

• Locais de Agrupamento e Parâmetros Padrão