Agrupamentos

Exemplo de find() e sort()

O exemplo seguinte chama find() e sort() em uma coleção que utiliza o agrupamento binário padrão. Usamos o agrupamento alemão definindo o valor do parâmetro locale como "de".

myColl.find({ city: "New York" }, { collation: { locale: "de" } })
  .sort({ name: 1 });

Exemplo de findOneAndUpdate ()

O exemplo seguinte chama a operação findOneAndUpdate() em uma coleção que utiliza o agrupamento binário padrão. A coleção contém os seguintes documentos:

{ "_id" : 1, "first_name" : "Hans" }
{ "_id" : 2, "first_name" : "Gunter" }
{ "_id" : 3, "first_name" : "Günter" }
{ "_id" : 4, "first_name" : "Jürgen" }

Considere a seguinte operação do findOneAndUpdate() nesta coleção que não especifica um agrupamento:

myColl.findOneAndUpdate(
  { first_name : { $lt: "Gunter" } },
  { $set: { verified: true } }
);

Como "Gunter" é o primeiro resultado classificado ao usar um agrupamento binário, nenhum dos documentos vem lexicalmente antes e corresponde ao operador de comparação $lt no documento de consulta. Como resultado, a operação não atualiza nenhum documento.

Considere a mesma operação com um agrupamento especificado com a localidade configurada para de@collation=phonebook. Essa localidade especifica a opção collation=phonebook que contém regras para priorizar nomes próprios, identificados pela capitalização da primeira letra. A localidade e a opção de@collation=phonebook classificam os caracteres com umlauts antes dos mesmos caracteres sem umlauts.

myColl.findOneAndUpdate(
  { first_name: { $lt: "Gunter" } },
  { $set: { verified: true } },
  { collation: { locale: "de@collation=phonebook" } },
);

Como "Günter" vem lexicalmente antes de "Gunter" usando o agrupamento de@collation=phonebook especificado em findOneAndUpdate(), a operação retorna o seguinte documento atualizado:

{ lastErrorObject: { updatedExisting: true, n: 1 },
  value: { _id: 3, first_name: 'Günter' },
  ok: 1 }

Exemplo de findOneAndDelete()

O exemplo a seguir chama a operação findOneAndDelete() em uma coleção que usa o agrupamento binário padrão e contém os seguintes documentos:

{ "_id" : 1, "a" : "16" }
{ "_id" : 2, "a" : "84" }
{ "_id" : 3, "a" : "179" }

Neste exemplo, definimos o parâmetro de agrupamento numericOrdering como true para classificar strings com base em sua ordem numérica em vez de sua ordem lexical.

myColl.findOneAndDelete(
  { a: { $gt: "100" } },
  { collation: { locale: "en", numericOrdering: true } },
);

Após executar a operação acima, a coleção contém os seguintes documentos:

{ "_id" : 1, "a" : "16" }
{ "_id" : 2, "a" : "84" }

Ao executar a mesma operação em uma coleção original de três documentos sem agrupamento, a correspondência será feita de acordo com o valor lexicográfico das strings ("16", "84" e "179") e excluirá o primeiro documento encontrado que corresponda aos critérios de consulta.

await myColl.findOneAndDelete({ a: { $gt: "100" } });

Como todos os documentos contêm valores lexicais no campo a que correspondem aos critérios (maior que o valor lexical de "100"), a operação remove o primeiro resultado. Após executar a operação acima, a coleção contém os seguintes documentos:

{ "_id" : 2, "a" : "84" }
{ "_id" : 3, "a" : "179" }

Exemplo de agregação

Para usar o agrupamento com a operação agregada, passe o documento de agrupamento no campo de opções, após a array de estágios do pipeline.

O exemplo a seguir mostra um pipeline de agregação em uma coleção que usa o agrupamento binário padrão. A agregação agrupa o campo first_name, conta o número total de resultados em cada grupo e classifica os resultados pela ordem da Agenda telefônica alemã ("de@collation=phonebook" localidade).

myColl.aggregate(
  [
    { $group: { "_id": "$first_name", "nameCount": { "$sum": 1 } } },
    { $sort: { "_id": 1 } },
  ],
  { collation: { locale: "de@collation=phonebook" } },
);