$addToSet (agregação)

Nesta página

Definição

Sintaxe
Comportamento
Exemplos

Definição

Alterado na versão 5.0.

$addToSet

$addToSet retorna uma array de todos os valores exclusivos que resultam da aplicação de uma expressão a cada documento em um grupo.

A ordem dos elementos na array que retorna não é especificada.

$addToSet está disponível nestes estágios:

$bucket
$bucketAuto
$group
$setWindowFields (Disponível a partir do MongoDB 5.0)

Sintaxe

$addToSet sintaxe:

{ $addToSet: <expression> }

Para mais informações sobre expressões, consulte Expressões.

Comportamento

Se o valor da expressão for uma array, $addToSet a anexará inteira como um único elemento.

Se o valor da expressão for um documento, o MongoDB determinará que o documento é duplicado se outro documento na array corresponder exatamente ao documento adicionado. Especificamente, o documento existente tem exatamente os mesmos campos e valores na mesma ordem.

Exemplos

Usar no estágio `$group`

Considere uma collection sales com os seguintes documentos:

{ "_id" : 1, "item" : "abc", "price" : 10, "quantity" : 2, "date" : ISODate("2014-01-01T08:00:00Z") }
{ "_id" : 2, "item" : "jkl", "price" : 20, "quantity" : 1, "date" : ISODate("2014-02-03T09:00:00Z") }
{ "_id" : 3, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-03T09:05:00Z") }
{ "_id" : 4, "item" : "abc", "price" : 10, "quantity" : 10, "date" : ISODate("2014-02-15T08:00:00Z") }
{ "_id" : 5, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T09:12:00Z") }

Agrupando os documentos até o dia e o ano do campo date, a seguinte operação utiliza o acumulador $addToSet para calcular a lista de itens únicos vendidos para cada grupo:

db.sales.aggregate(
   [
     {
       $group:
         {
           _id: { day: { $dayOfYear: "$date"}, year: { $year: "$date" } },
           itemsSold: { $addToSet: "$item" }
         }
     }
   ]
)

A operação retorna os seguintes resultados:

{ "_id" : { "day" : 46, "year" : 2014 }, "itemsSold" : [ "xyz", "abc" ] }
{ "_id" : { "day" : 34, "year" : 2014 }, "itemsSold" : [ "xyz", "jkl" ] }
{ "_id" : { "day" : 1, "year" : 2014 }, "itemsSold" : [ "abc" ] }

Usar no estágio `$setWindowFields`

Novidades na versão 5.0.

Crie uma collection cakeSales que contenha vendas de bolo nos estados da Califórnia (CA) e de Washington (WA):

db.cakeSales.insertMany( [
   { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"),
     state: "CA", price: 13, quantity: 120 },
   { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"),
     state: "WA", price: 14, quantity: 140 },
   { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"),
     state: "CA", price: 12, quantity: 145 },
   { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"),
     state: "WA", price: 13, quantity: 104 },
   { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"),
     state: "CA", price: 41, quantity: 162 },
   { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"),
     state: "WA", price: 43, quantity: 134 }
] )

Este exemplo usa $addToSet no estágio $setWindowFields para gerar as vendas exclusivas de bolo type para cada state:

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { orderDate: 1 },
         output: {
            cakeTypesForState: {
               $addToSet: "$type",
               window: {
                  documents: [ "unbounded", "current" ]
               }
            }
         }
      }
   }
] )

No exemplo:

partitionBy: "$state" particiona os documentos na collection por state. Existem partições para CA e WA.
sortBy: { orderDate: 1 } classifica os documentos em cada partição por orderDate em ordem crescente (1), para que o orderDate mais antigo seja o primeiro.

output adiciona cada type exclusivo de bolo no campo de array cakeTypesForState utilizando $addToSet, que é executado em uma janela de documentos.
A janela contém documentos entre um limite inferior unbounded e o documento current. Isso significa que $addToSet retorna uma array que contém os campos exclusivos do bolo type para os documentos entre o início da partição e o documento atual.

Neste exemplo de saída, a array do bolo type para CA e WA é mostrada no campo cakeTypesForState:

{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),
  "state" : "CA", "price" : 41, "quantity" : 162,
  "cakeTypesForState" : [ "strawberry" ] }
{ "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),
  "state" : "CA", "price" : 13, "quantity" : 120,
  "cakeTypesForState" : [ "strawberry", "chocolate" ] }
{ "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),
  "state" : "CA", "price" : 12, "quantity" : 145,
  "cakeTypesForState" : [ "strawberry", "vanilla", "chocolate" ] }
{ "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),
  "state" : "WA", "price" : 43, "quantity" : 134,
  "cakeTypesForState" : [ "strawberry" ] }
{ "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),
  "state" : "WA", "price" : 13, "quantity" : 104,
  "cakeTypesForState" : [ "vanilla", "strawberry" ] }
{ "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),
  "state" : "WA", "price" : 14, "quantity" : 140,
  "cakeTypesForState" : [ "vanilla", "chocolate", "strawberry" ] }

Voltar

$add

$allElementsTrue