Pipeline de agregação

Calcular a Quantidade Total do Pedido

O exemplo de aggregation pipeline abaixo contém dois estágios e retorna a quantidade total do pedido de pizzas médias agrupadas pelo nome da pizza:

db.orders.aggregate( [
   // Stage 1: Filter pizza order documents by pizza size
   {
      $match: { size: "medium" }
   },
   // Stage 2: Group remaining documents by pizza name and calculate total quantity
   {
      $group: { _id: "$name", totalQuantity: { $sum: "$quantity" } }
   }
] )

O estágio $match:

• Filtra os documentos de pedido de pizza em pizzas com um size de medium.

• Repassa os documentos restantes para o estágio $group.

O estágio $group:

• Agrupa os documentos restantes por name da pizza.

• Utiliza $sum para calcular a quantity total do pedido para cada pizza de name. O total é armazenado no campo totalQuantity retornado pelo aggregation pipeline.

Saída de exemplo:

[
   { _id: 'Cheese', totalQuantity: 50 },
   { _id: 'Vegan', totalQuantity: 10 },
   { _id: 'Pepperoni', totalQuantity: 20 }
]

Calcular o Valor Total do Pedido e a Quantidade Média do Pedido

O exemplo a seguir calcula o valor total do pedido de pizza e a quantidade média do pedido entre duas datas:

db.orders.aggregate( [
   // Stage 1: Filter pizza order documents by date range
   {
      $match:
      {
         "date": { $gte: new ISODate( "2020-01-30" ), $lt: new ISODate( "2022-01-30" ) }
      }
   },
   // Stage 2: Group remaining documents by date and calculate results
   {
      $group:
      {
         _id: { $dateToString: { format: "%Y-%m-%d", date: "$date" } },
         totalOrderValue: { $sum: { $multiply: [ "$price", "$quantity" ] } },
         averageOrderQuantity: { $avg: "$quantity" }
      }
   },
   // Stage 3: Sort documents by totalOrderValue in descending order
   {
      $sort: { totalOrderValue: -1 }
   }
 ] )

O estágio $match:

• Filtra os documentos do pedido de pizza para aqueles em um intervalo de datas especificado usando $gte e $lt.

• Repassa os documentos restantes para o estágio $group.

O estágio $group:

• Agrupa os documentos por data usando $dateToString.

• Para cada grupo, calcula:

  • Valor total do pedido usando $sum e $multiply.

  • Quantidade média do pedido usando $avg.

• Passa os documentos agrupados para o estágio $sort.

O estágio $sort:

• Classifica os documentos pelo valor total do pedido para cada grupo em ordem decrescente (-1).

• Retorna os documentos classificados.

Saída de exemplo:

[
   { _id: '2022-01-12', totalOrderValue: 790, averageOrderQuantity: 30 },
   { _id: '2021-03-13', totalOrderValue: 770, averageOrderQuantity: 15 },
   { _id: '2021-03-17', totalOrderValue: 630, averageOrderQuantity: 30 },
   { _id: '2021-01-13', totalOrderValue: 350, averageOrderQuantity: 10 }
]

Expressões e operadores de agregação

Alguns estágios do pipeline de agregação aceitam expressões. Os operadores calculam valores com base em expressões de entrada.

Na MongoDB Query Language, você pode criar expressões a partir dos seguintes componentes:

Por exemplo, { $add: [ 3, "$inventory.total" ] } é uma expressão que consiste no operador $add e em duas expressões de entrada:

• A constante 3

• A expressão do caminho do campo "$inventory.total"

A expressão retorna o resultado da adição de 3 ao valor no caminho inventory.total do documento de entrada.

Caminhos do campo

Expressões de caminho do campo são usadas para acessar campos em documentos de entrada. Para especificar um caminho do campo, prefixe o nome do campo ou o caminho do campo pontilhado (se o campo estiver em um documento incorporado) com um cifrão $. Por exemplo, "$user" para especificar o caminho do campo user ou "$user.name" para especificar o caminho para o campo incorporado "user.name".

"$<field>" é equivalente a "$$CURRENT.<field>", em que CURRENT é uma variável de sistema cujo padrão é a raiz do objeto atual, a menos que seja indicado o contrário em estágios específicos.

Para mais informações e exemplos, veja Caminhos do Campo.

Limitações de Pipeline de Agregação

Um aggregation pipeline tem limitações nos tipos de valor e no tamanho do resultado. Consulte Limites de aggregation pipeline.

Pipelines de Agregação e Coleções Fragmentadas

Um aggregation pipeline oferece suporte a operações em collections fragmentadas. Consulte Pipeline de aggregation e collections fragmentadas.

Pipelines de Agregação como uma Alternativa ao Map-Reduce

A partir do MongoDB 5.0, map-reduce está obsoleto:

• Em vez de map-reduce, você deve usar um pipeline de agregação. Os pipelines de agregação fornecem melhor desempenho e usabilidade do que o map-reduce.

• Você pode reescrever operações de map-reduce utilizando aggregation pipeline stages, como $group, $merge e outros.

• Nas operações de map-reduce que exigem funcionalidade personalizada, você pode usar os operadores de agregação $accumulator e $function. Você pode usar esses operadores para definir expressões de agregação personalizadas no JavaScript.

Para obter exemplos de alternativas de aggregation pipeline para map-reduce, consulte:

• Map-reduce para aggregation pipeline

• Exemplos de map-reduce