Operador de canalización de agregación $first de MongoDB

MongoDB 4.4 introdujo el $first operador de tubería de agregación.

Este operador devuelve el primer elemento de una matriz.

Ejemplo

Supongamos que tenemos una colección llamada jugadores con los siguientes documentos:

{ "_id" : 1, "player" : "Homer", "scores" : [ 1, 5, 3 ] }
{ "_id" : 2, "player" : "Marge", "scores" : [ 8, 17, 18 ] }
{ "_id" : 3, "player" : "Bart", "scores" : [ 15, 11, 8 ] }

Podemos ver que cada documento tiene un scores campo que contiene una matriz.

Podemos usar $first para devolver el primer elemento de cada una de esas matrices.

Ejemplo:

db.players.aggregate([ 
  {
    $project: {
        "firstScore": { 
          $first: "$scores" 
        }
    }
  } 
])

Resultado:

{ "_id" : 1, "firstScore" : 1 }
{ "_id" : 2, "firstScore" : 8 }
{ "_id" : 3, "firstScore" : 15 }

Podemos ver que se devolvió el primer elemento de la matriz para cada documento.

Este es el equivalente de usar $arrayElemAt operador con valor cero (0 ):

db.players.aggregate([
  {
    $project: {
      "firstScore": { $arrayElemAt: [ "$scores", 0 ] }
    }
  }
])

Arreglos vacíos

Si proporciona una matriz vacía, $first no devolverá un valor.

Supongamos que insertamos el siguiente documento en nuestra colección:

{ "_id" : 4, "player" : "Farnsworth", "scores" : [ ] }

Ejecutemos el código de nuevo:

db.players.aggregate([ 
  {
    $project: {
        "firstScore": { 
          $first: "$scores" 
        }
    }
  } 
])

Resultado:

{ "_id" : 1, "firstScore" : 1 }
{ "_id" : 2, "firstScore" : 8 }
{ "_id" : 3, "firstScore" : 15 }
{ "_id" : 4 }

En este caso, el documento 4 no devolvió ningún valor para la matriz. De hecho, ni siquiera devolvió el nombre del campo.

Valores nulos y perdidos

Si el operando es nulo o falta, $first devuelve null .

Supongamos que insertamos el siguiente documento:

{ "_id" : 5, "player" : "Meg", "scores" : null }

Ejecutemos el código de nuevo:

db.players.aggregate([ 
  {
    $project: {
        "firstScore": { 
          $first: "$scores" 
        }
    }
  } 
])

Resultado:

{ "_id" : 1, "firstScore" : 1 }
{ "_id" : 2, "firstScore" : 8 }
{ "_id" : 3, "firstScore" : 15 }
{ "_id" : 4 }
{ "_id" : 5, "firstScore" : null }

Esta vez devolvió el campo con un valor de null .

Operando no válido

El operando para $first debe resolverse en una matriz, nula o faltante. Proporcionar un operando no válido da como resultado un error.

Para demostrar esto, intentemos usar $first contra el player campo (que no es una matriz):

db.players.aggregate([ 
  {
    $project: {
        "firstPlayer": { 
          $first: "$player" 
        }
    }
  } 
])

Resultado:

Error: command failed: {
	"ok" : 0,
	"errmsg" : "$first's argument must be an array, but is string",
	"code" : 28689,
	"codeName" : "Location28689"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:618:17
example@sqldat.com/mongo/shell/assert.js:708:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1046:12
@(shell):1:1

Como era de esperar, devolvió un error.