/ /

$first (operador de acumulación)

Definición

$first

Modificado en la versión 5.0.

Devuelve el resultado de un expresión para el primer documento de un grupo de documentos. Solo es significativo cuando los documentos están en un orden definido.

$first está disponible en estas etapas:

$bucket
$bucketAuto
$group
$setWindowFields (Disponible a partir de MongoDB 5.0)

Sintaxis

$first sintaxis:

{ $first: <expression> }

Comportamientos

Definir el orden de documentos

Para definir el orden de los documentos para $first en $setWindowFields, establece el campo sortBy.
Para definir el orden de los documentos para $first en otras etapas de pipeline, se añade una etapa $sort anterior.

Operador de arreglos

Si la expresión se resuelve en un arreglo:

Para un grupo de documentos, $first devuelve todo el arreglo del primer documento. No atraviesa elementos del arreglo. Este es el caso de fases como $group y $setWindowFields.
Para un documento individual, $first devuelve el primer elemento del arreglo. Este es el caso de etapas como $addFields.

Valores ausentes

En los documentos de un grupo pueden faltar campos o pueden tener campos a los que les faltan valores.

Si no hay documentos de la etapa de pipeline anterior, la etapa $group no devuelve nada.
Si falta el campo en procesamiento por parte del acumulador de $first, $first devuelve null.
Cuando se usa con $setWindowFields, $first devuelve null para ventanas vacías. Por ejemplo, cuando se tiene una ventana { documents:[ -1, -1] } documents en el primer documento de una partición.

Para obtener más información, consulta el ejemplo de datos faltantes más adelante en este tema.

Ejemplos

Usar en la etapa `$group`

Crear la colección sales:

db.sales.insertMany( [
   { "_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:05:00Z") },
   { "_id" : 6, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-15T12:05:10Z") },
   { "_id" : 7, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T14:12:12Z") }
] )

Agrupando los documentos por el campo item, la siguiente operación utiliza el acumulador $first para devolver la primera fecha de venta de cada artículo:

db.sales.aggregate(
   [
     { $sort: { item: 1, date: 1 } },
     {
       $group:
         {
           _id: "$item",
           firstSale: { $first: "$date" }
         }
     }
   ]
)

La operación devuelve los siguientes resultados:

[
   { _id: 'jkl', firstSale: ISODate("2014-02-03T09:00:00.000Z") },
   { _id: 'xyz', firstSale: ISODate("2014-02-03T09:05:00.000Z") },
   { _id: 'abc', firstSale: ISODate("2014-01-01T08:00:00.000Z") }
]

Datos faltantes

A algunos documentos de la colección badData les faltan campos y a otros les faltan valores.

Crear la colección badData:

db.badData.insertMany( [
   { "_id": 1, "price": 6, "quantity": 6 },
   { "_id": 2, "item": "album", "price": 5 , "quantity": 5  },
   { "_id": 7, "item": "tape", "price": 6, "quantity": 6 },
   { "_id": 8, "price": 5, "quantity": 5  },
   { "_id": 9, "item": "album", "price": 3, "quantity": '' },
   { "_id": 10, "item": "tape", "price": 3, "quantity":  4 },
   { "_id": 12, "item": "cd", "price": 7  }
] )

Se puede hacer un query a la colección badData, agrupando la salida en el campo item:

db.badData.aggregate( [
   { $sort: { item: 1, price: 1 } },
   { $group:
      {
         _id: "$item",
         inStock: { $first: "$quantity" }
      }
   }
] )

La etapa $sort ordena los documentos y los pasa a la etapa $group.

[
  { _id: null, inStock: 5 },
  { _id: 'album', inStock: '' },
  { _id: 'cd', inStock: null },
  { _id: 'tape', inStock: 4 }
]

$first selecciona el primer documento de cada grupo de resultados:

El grupo _id: null está incluido.
Cuando el campo acumulador, $quantity en este ejemplo, falta, $first devuelve null.

Usar en la etapa `$setWindowFields`

Nuevo en la versión 5.0.

Crea una colección de cakeSales que incluya ventas de pasteles en el estado de California (CA) y 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 ejemplo utiliza $first en la etapa $setWindowFields para generar el primer pedido de venta de pastel type para cada state:

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

En el ejemplo:

partitionBy: "$state" particiona los documentos de la colección en state. Existen particiones para CA y WA.
sortBy: { orderDate: 1 } ordena los documentos de cada partición por orderDate en orden ascendente (1), de modo que el orderDate más antiguo sea el primero.

output establece el campo firstOrderTypeForState al primer orden type desde la ventana documents.
El window contiene documentos entre un límite inferior de unbounded y el documento current en el resultado. Esto significa que $first devuelve el primer orden type para los documentos entre el inicio de la partición y el documento actual.

En este resultado, el primer valor de type para CA y WA se muestra en el campo firstOrderTypeForState:

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

Volver

$count

$firstN

Definición

Sintaxis

Comportamientos

Definir el orden de documentos

Operador de arreglos

Valores ausentes

Ejemplos

Usar en la etapa $group

Datos faltantes

Usar en la etapa $setWindowFields

Usar en la etapa `$group`

Usar en la etapa `$setWindowFields`