$facet

Nuevo a partir de la versión 8.0.2.

La fase de $facet agregación de Amazon DocumentDB procesa varias canalizaciones de agregación en una sola etapa en el mismo conjunto de documentos de entrada. Cada campo de salida define su propia canalización y cada canalización recibe los mismos documentos de entrada. Esto le permite calcular varias agregaciones independientes, como recuentos, agrupaciones y estadísticas resumidas, en una sola consulta, en lugar de ejecutar la recopilación a través de varias consultas independientes.

Cada subcanalización se ejecuta de forma independiente y produce una matriz de documentos que se almacena en su campo de salida correspondiente. Como las subcanalizaciones no comparten el estado, la salida de una canalización no afecta a la otra.

Sintaxis

{
  $facet: {
    <outputField1>: [ <stage1>, <stage2>, ... ],
    <outputField2>: [ <stage1>, <stage2>, ... ],
    ...
  }
}

Parámetros

• outputField(obligatorio): el nombre de un campo de salida que contiene la matriz de resultados de su canalización de agregación asociada. Puede especificar uno o más campos de salida. Cada campo de salida se asigna a una matriz de etapas del proceso de agregación que se aplica a los documentos de entrada.

Salida

La $facet etapa devuelve un único documento. Cada campo de salida que especifique contiene una matriz de documentos producidos por su subcanalización correspondiente.

Limitaciones

• Una $facet subcanalización no puede incluir las siguientes etapas:$changeStream,$collStats, $facet (no se permite el anidamiento),,$geoNear,$indexStats,$listSearchIndexes,$merge,, $out $planCacheStats$search, $searchMeta y. $vectorSearch

• El documento que devuelva la $facet etapa debe mantenerse dentro del límite de tamaño del documento BSON de 16 MB.

• Una $sort etapa que precede a una $facet etapa no puede determinar el orden de un acumulador sensible a los pedidos ($first,,$last, $push $firstN$lastN, o$mergeObjects) en una $bucketAuto etapa $group$bucket, o en la que ese pedido tendría que aplicarse más allá del límite. $facet Esto se aplica tanto si la fase de agrupamiento se encuentra dentro de una $facet subcanalización como después de la fase. $facet En este caso, Amazon DocumentDB devuelve un error en lugar de ejecutar la canalización. Para pedir un acumulador de este tipo, coloque la $sort etapa dentro de la $facet subcanalización, inmediatamente antes de la etapa de agrupamiento. Order-insensitive los acumuladores, como,, y,$sum, $min$max, no se ven afectados. $count

Ejemplo (MongoDB Shell)

El siguiente ejemplo muestra cómo usar el $facet escenario para calcular varias agregaciones de los mismos datos de ventas en una sola consulta.

Cree documentos de muestra

db.sales.insertMany([
  { item: "abc", price: 10, quantity: 2, date: new Date("2020-09-01") },
  { item: "def", price: 20, quantity: 1, date: new Date("2020-10-01") },
  { item: "ghi", price: 5, quantity: 3, date: new Date("2020-11-01") },
  { item: "jkl", price: 15, quantity: 2, date: new Date("2020-12-01") },
  { item: "abc", price: 25, quantity: 1, date: new Date("2021-01-01") }
]);

Ejemplo de consulta

El siguiente comando se utiliza $facet para calcular, en una sola etapa, la cantidad total vendida por artículo, las estadísticas generales de precios y el recuento total de documentos:

db.sales.aggregate([
  {
    $facet: {
      "totalByItem": [
        { $group: { _id: "$item", totalQuantity: { $sum: "$quantity" } } }
      ],
      "priceStats": [
        { $group: { _id: null, avgPrice: { $avg: "$price" }, maxPrice: { $max: "$price" } } }
      ],
      "documentCount": [
        { $count: "total" }
      ]
    }
  }
])

Salida

El comando devuelve el siguiente resultado:

[
  {
    totalByItem: [
      { _id: "abc", totalQuantity: 3 },
      { _id: "def", totalQuantity: 1 },
      { _id: "ghi", totalQuantity: 3 },
      { _id: "jkl", totalQuantity: 2 }
    ],
    priceStats: [
      { _id: null, avgPrice: 15, maxPrice: 25 }
    ],
    documentCount: [
      { total: 5 }
    ]
  }
]

Ejemplos de código

Para ver un ejemplo de código sobre el uso del $facet comando, elige la pestaña del idioma que quieres usar:

Node.js

const { MongoClient } = require('mongodb');

async function example() {
  const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
  const db = client.db('test');
  const sales = db.collection('sales');

  const result = await sales.aggregate([
    {
      $facet: {
        "totalByItem": [
          { $group: { _id: "$item", totalQuantity: { $sum: "$quantity" } } }
        ],
        "priceStats": [
          { $group: { _id: null, avgPrice: { $avg: "$price" }, maxPrice: { $max: "$price" } } }
        ],
        "documentCount": [
          { $count: "total" }
        ]
      }
    }
  ]).toArray();

  console.log(result);
  client.close();
}

example();

Python

from pymongo import MongoClient

def example():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
    db = client['test']
    sales = db['sales']

    result = list(sales.aggregate([
        {
            '$facet': {
                'totalByItem': [
                    {'$group': {'_id': '$item', 'totalQuantity': {'$sum': '$quantity'}}}
                ],
                'priceStats': [
                    {'$group': {'_id': None, 'avgPrice': {'$avg': '$price'}, 'maxPrice': {'$max': '$price'}}}
                ],
                'documentCount': [
                    {'$count': 'total'}
                ]
            }
        }
    ]))

    print(result)
    client.close()

example()