$addFields (agregação)

Usando dois $addFields estágios

Uma coleção chamada scores contém os seguintes documentos:

db.scores.insertMany( [
   {
      _id: 1,
      student: "Maya",
      homework: [ 10, 5, 10 ],
      quiz: [ 10, 8 ],
      extraCredit: 0
   },
   {
      _id: 2,
      student: "Ryan",
      homework: [ 5, 6, 5 ],
      quiz: [ 8, 8 ],
      extraCredit: 8
   }
] )

A operação a seguir usa dois estágios $addFields para incluir três novos campos nos documentos de saída:

db.scores.aggregate( [
   {
     $addFields: {
       totalHomework: { $sum: "$homework" } ,
       totalQuiz: { $sum: "$quiz" }
     }
   },
   {
     $addFields: { totalScore:
       { $add: [ "$totalHomework", "$totalQuiz", "$extraCredit" ] } }
   }
] )

A operação retorna os seguintes documentos:

[
   {
      _id: 1,
      student: "Maya",
      homework: [ 10, 5, 10 ],
      quiz: [ 10, 8 ],
      extraCredit: 0,
      totalHomework: 25,
      totalQuiz: 18,
      totalScore: 43
   },
   {
      _id: 2,
      student: "Ryan",
      homework: [ 5, 6, 5 ],
      quiz: [ 8, 8 ],
      extraCredit: 8,
      totalHomework: 16,
      totalQuiz: 16,
      totalScore: 40
   }
]

Adicionando campos a um documento incorporado

Use a notação de pontos para adicionar novos campos a documentos incorporados.

Por exemplo, crie uma collection chamada vehicles com os seguintes documentos:

db.vehicles.insertMany( [
      { _id: 1, type: "car", specs: { doors: 4, wheels: 4 } },
      { _id: 2, type: "motorcycle", specs: { doors: 0, wheels: 2 } },
      { _id: 3, type: "jet ski" }
] )

A seguinte operação de agregação adiciona um novo campo fuel_type ao documento incorporado specs.

db.vehicles.aggregate( [
   { $addFields: { "specs.fuel_type": "unleaded" } }
] )

A operação retorna os seguintes resultados:

[
   { _id: 1, type: "car",
      specs: { doors: 4, wheels: 4, fuel_type: "unleaded" } },
   { _id: 2, type: "motorcycle",
      specs: { doors: 0, wheels: 2, fuel_type: "unleaded" } },
   { _id: 3, type: "jet ski",
      specs: { fuel_type: "unleaded" } }
]

Substituindo um campo existente

A especificação de um nome de campo existente em uma operação $addFields faz com que o campo original seja substituído.

Uma coleção chamada animals contém o seguinte documento:

db.animals.insertOne(
   { _id: 1, dogs: 10, cats: 15 }
)

A seguinte operação $addFields especifica o campo cats.

db.animals.aggregate( [
  {
    $addFields: { cats: 20 }
  }
] )

A operação retorna o seguinte documento:

[ { _id: 1, dogs: 10, cats: 20 } ]

É possível substituir um campo por outro. No exemplo a seguir, o campo item substitui o campo _id.

Uma coleção chamada fruit contém os seguintes documentos:

db.fruit.insertMany( [
   { _id: 1, item: "tangerine", type: "citrus" },
   { _id: 2, item: "lemon", type: "citrus" },
   { _id: 3, item: "grapefruit", type: "citrus" }
] )

A operação de agregação seguinte usa $addFields para substituir o campo _id de cada documento pelo valor do campo item e substitui o campo item por um valor estático.

db.fruit.aggregate( [
  {
    $addFields: {
      _id : "$item",
      item: "fruit"
    }
  }
] )

A operação retorna o seguinte:

[
   { _id: "tangerine", item: "fruit", type: "citrus" },
   { _id: "lemon", item: "fruit", type: "citrus" },
   { _id: "grapefruit", item: "fruit", type: "citrus" }
]

Adicionar Elemento a uma Array

Crie uma coleção de amostra scores com o seguinte:

db.scores.insertMany( [
   { _id: 1, student: "Maya", homework: [ 10, 5, 10 ], quiz: [ 10, 8 ], extraCredit: 0 },
   { _id: 2, student: "Ryan", homework: [ 5, 6, 5 ], quiz: [ 8, 8 ], extraCredit: 8 }
] )

Você pode usar $addFields com uma expressão $concatArrays para adicionar um elemento a um campo de array existente. Por exemplo, a seguinte operação usa $addFields para substituir o campo homework por uma nova array cujos elementos são a array homework atual concatenada com outra array contendo uma nova pontuação [ 7 ].

db.scores.aggregate( [
   { $match: { _id: 1 } },
   { $addFields: { homework: { $concatArrays: [ "$homework", [ 7 ] ] } } }
] )

A operação retorna o seguinte:

[ { _id: 1, student: "Maya", homework: [ 10, 5, 10, 7 ], quiz: [ 10, 8 ], extraCredit: 0 } ]

removeFields

Você pode usar $addFields com a variável $$REMOVE para remover campos do documento.

Por exemplo, crie uma coleção labReadings:

db.labReadings.insertMany( [
   {
      date: ISODate("2024-10-09"),
      temperature: 80
   },
   {
      date: null,
      temperature: 83
   },
   {
      date: ISODate("2024-12-09"),
      temperature: 85
   }
] )

Para remover o campo date dos documentos labReadings, use $addFields com a variável $$REMOVE:

db.labReadings.aggregate( [
   {
      $addFields: { date: "$$REMOVE" }
   }
] )

Saída:

[
   { _id: ObjectId('671285306fd2c3b24f2e7eaa'), temperature: 80 },
   { _id: ObjectId('671285306fd2c3b24f2e7eab'), temperature: 83 },
   { _id: ObjectId('671285306fd2c3b24f2e7eac'), temperature: 85 }
]

Você também pode usar $$REMOVE para remover campos condicional. Por exemplo, a seguinte agregação remove o campo date dos documentos em que date é null:

db.labReadings.aggregate( [
   {
      $addFields:
         {
            date: {
               $ifNull: [ "$date", "$$REMOVE" ]
            }
         }
   }
] )

Saída:

[
   {
      _id: ObjectId('671285306fd2c3b24f2e7eaa'),
      date: ISODate('2024-10-09T00:00:00.000Z'),
      temperature: 80
   },
   { _id: ObjectId('671285306fd2c3b24f2e7eab'), temperature: 83 },
   {
      _id: ObjectId('671285306fd2c3b24f2e7eac'),
      date: ISODate('2024-12-09T00:00:00.000Z'),
      temperature: 85
   }
]