/ /

Etapas de la pipeline de agregación

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte Procedimientos de actualización de MongoDB.6.0

En el Con los métodos db.collection.aggregate()ydb.aggregate(), las etapas de la canalización aparecen en una matriz. En la interfaz de usuario de Atlas, puede organizar las etapas de la canalización mediante el generador de canalizaciones de agregación. Los documentos pasan por las etapas en secuencia.

Compatibilidad

Puedes usar etapas del pipeline para implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Etapas

`db.collection.aggregate()` Etapas

Todas las etapas, excepto $out, $merge, $geoNear y $changeStream, pueden aparecer varias veces en una pipeline.

Nota

Para obtener detalles sobre un operador específico, incluida la sintaxis y ejemplos, haga clic en el enlace a la página de referencia del operador.

db.collection.aggregate( [ { <stage> }, ... ] )

Etapa	Descripción
`$addFields`	Agrega nuevos campos a los documentos. De forma similar a `$project`, `$addFields` transforma cada documento en el flujo; específicamente, agregando nuevos campos a los documentos de salida que contienen tanto los campos existentes de los documentos de entrada como los nuevos campos agregados. `$set` es un alias para `$addFields`.
`$bucket`	Clasifica los documentos entrantes en grupos, llamados buckets, basados en una expresión especificada y límites de bucket.
`$bucketAuto`	Clasifica los documentos entrantes en un número específico de grupos, denominados buckets, según una expresión especificada. Los límites de los buckets se determinan de manera automática con el objetivo de distribuir uniformemente los documentos en el número especificado de buckets.
`$changeStream`	Devuelve un cursor de flujo de cambios para la colección. Esta etapa solo puede ocurrir una vez en un pipeline de agregación y debe ser la primera etapa.
`$collStats`	Devuelve estadísticas sobre una colección o vista.
`$count`	Devuelve un recuento del número de documentos en esta etapa del pipeline de agregación. Distinto del acumulador de agregación `$count`.
`$facet`	Procesa múltiples canalizaciones de agregación dentro de una sola etapa en el mismo conjunto de documentos de entrada. Permite la creación de agregaciones multifacéticas capaces de caracterizar datos a través de múltiples dimensiones, o facetas, en una sola etapa.
`$geoNear`	Devuelve un flujo ordenado de documentos en función de la proximidad a un punto geoespacial. Incorpora la funcionalidad de `$match`, `$sort` y `$limit` para datos geoespaciales. Los documentos de salida incluyen un campo adicional de distancia y pueden incluir un campo de identificador de ubicación.
`$graphLookup`	Realiza una búsqueda recursiva en una colección. A cada documento de salida, agrega un nuevo campo de arreglo que contenga los resultados del recorrido de la búsqueda recursiva para ese documento.
`$group`	Agrupa los documentos de entrada mediante una expresión de identificador específica y aplica la expresión del acumulador, si se especifica, a cada grupo. Consume todos los documentos de entrada y produce un documento por cada grupo distinto. Los documentos de salida solo contienen el campo identificador y, si se especifica, los campos acumulados.
`$indexStats`	Devuelve estadísticas sobre el uso de cada índice de la colección.
`$limit`	Pasa los primeros n documentos sin modificar al pipeline donde n es el límite especificado. Para cada documento de entrada, se genera un documento (para los primeros n documentos) o cero documentos (después de los primeros n documentos).
`$listSessions`	Enumera todas las sesiones que han estado activas el tiempo suficiente para propagarse a la colección `system.sessions`.
`$lookup`	Realiza un left outer join a otra colección en la misma base de datos para filtrar documentos de la colección "unida" para su procesamiento.
`$match`	Filtra el flujo de documentos para permitir que solo los documentos coincidentes pasen sin modificaciones a la siguiente etapa del pipeline. `$match` utiliza consultas estándar de MongoDB. Para cada documento de entrada, se genera un documento (si hay coincidencia) o cero documentos (si no hay coincidencia).
`$merge`	Guarda los documentos resultantes del pipeline de agregación en una colección. La etapa puede incorporar (insertar nuevos documentos, fusionar documentos, reemplazar documentos, conservar documentos existentes, fallar la operación, procesar documentos con un pipeline de actualización personalizado) los resultados en una colección de salida. Para usar la etapa `$merge`, debe ser la última etapa del pipeline.
`$out`	Guarda los documentos resultantes del pipeline de agregación en una colección. Para usar la etapa `$out`, debe ser la última etapa del pipeline.
`$planCacheStats`	Devuelve información de la caché de planes para una colección.
`$project`	Reestructura cada documento del flujo, por ejemplo, agregando nuevos campos o removiendo los existentes. Para cada documento de entrada, genera un documento. Consulta también `$unset` para remover campos existentes.
`$redact`	Reconfigura cada documento en la secuencia restringiendo el contenido de cada documento según la información almacenada en los propios documentos. Incorpora la funcionalidad de `$project` y `$match`. Se puede utilizar para implementar la restricción a nivel de campo. Para cada documento de entrada, genera uno o cero documentos.
`$replaceRoot`	Reemplaza un documento con el documento incrustado específico. La operación reemplaza todos los campos existentes en el documento de entrada, incluido el campo `_id`. Especifique un documento incrustado en el documento de entrada para elevar el documento incrustado al nivel superior. `$replaceWith` es un alias para la etapa `$replaceRoot`.
`$replaceWith`	Reemplaza un documento con el documento incrustado específico. La operación reemplaza todos los campos existentes en el documento de entrada, incluido el campo `_id`. Especifique un documento incrustado en el documento de entrada para elevar el documento incrustado al nivel superior. `$replaceWith` es un alias para la etapa `$replaceRoot`.
`$sample`	Selecciona aleatoriamente el número específico de documentos de su entrada.
`$search`	Realiza una búsqueda de texto completo de los campos en una colección de Atlas. `$search` solo está disponible para clústeres MongoDB Atlas y no está disponible para implementaciones autoadministradas.
`$set`	Agrega nuevos campos a los documentos. De forma similar a `$project`, `$set` transforma cada documento en el flujo; específicamente, agregando nuevos campos a los documentos de salida que contienen tanto los campos existentes de los documentos de entrada como los nuevos campos agregados. `$set` es un alias para la etapa `$addFields`.
`$setWindowFields`	Agrupa documentos en ventanas y aplica uno o más operadores a los documentos en cada ventana. Nuevo en la versión 5.0.
`$skip`	Omite los primeros documentos n, donde n es el número de omisión especificado, y pasa los documentos restantes sin modificar al pipeline. Para cada documento de entrada, se genera cero documentos (para los primeros documentos n) o un documento (después de los primeros documentos n).
`$sort`	Reordena el flujo de documentos por una clave de ordenación específica. Solo cambia el orden; los documentos permanecen sin modificar. Para cada documento de entrada, genera un documento.
`$sortByCount`	Agrupa los documentos entrantes según el valor de una expresión especificada y luego calcula el número de documentos en cada grupo distinto.
`$unionWith`	Realiza una unión de dos colecciones, es decir, combina los resultados de la canalización de dos colecciones en un único conjunto de resultados.
`$unset`	Remueve/excluye campos de los documentos. `$unset` es un alias para la etapa `$project` que elimina campos.
`$unwind`	Descompone un campo de arreglo de los documentos de entrada para producir un documento por cada elemento. Cada documento de salida reemplaza el arreglo con un valor de elemento. Para cada documento de entrada, genera documentos n, donde n es el número de elementos del arreglo y puede ser cero para un arreglo vacío.

Para conocer los operadores de expresión de agregación que se utilizarán en las etapas de la canalización, consulte Operadores de canalización de agregación.

`db.aggregate()` Etapas

A partir de la 3.6 versión, MongoDB también proporciona el db.aggregate() método:

db.aggregate( [ { <stage> }, ... ] )

Las siguientes etapas utilizan el método db.aggregate() y no el método db.collection.aggregate().

Etapa	Descripción
`$changeStream`	Devuelve un cursor de flujo de cambios para la colección. Esta etapa solo puede ocurrir una vez en un pipeline de agregación y debe ser la primera etapa.
`$currentOp`	Devuelve información sobre las operaciones activas y/o inactivas de la implementación de MongoDB.
`$listLocalSessions`	Enumera todas las sesiones activas utilizadas recientemente en la instancia actualmente conectada de `mongos` o `mongod`. Es posible que estas sesiones aún no se hayan propagado a la colección `system.sessions`.

Etapas disponibles para actualizaciones

Puedes utilizar el pipeline de agregación para actualizaciones en:

Comando	`mongosh` Métodos
`findAndModify`	db.collection.findOneAndUpdate() db.collection.findAndModify()
`update`	db.collection.updateOne() db.collection.updateMany() Bulk.find.update() Bulk.find.updateOne() Bulk.find.upsert()

Para las actualizaciones, el pipeline puede constar de las siguientes etapas:

$addFields y su alias $set
$project y su alias $unset
$replaceRoot y su $replaceWith alias.

Listado alfabético de etapas

Nombre	Descripción
`$addFields`	Añade nuevos campos a los documentos. Genera documentos que contienen todos los campos existentes en los documentos de entrada y los campos recién añadidos.
`$bucket`	Clasifica los documentos entrantes en grupos, llamados buckets, basados en una expresión especificada y límites de bucket.
`$bucketAuto`	Clasifica los documentos entrantes en un número específico de grupos, denominados buckets, según una expresión especificada. Los límites de los buckets se determinan de manera automática con el objetivo de distribuir uniformemente los documentos en el número especificado de buckets.
`$changeStream`	Devuelve un cursor de flujo de cambios para la colección o base de datos. Esta etapa solo puede ocurrir una vez en una canalización de agregación y debe ser la primera.
`$collStats`	Devuelve estadísticas sobre una colección o vista.
`$count`	Devuelve un recuento del número de documentos en esta etapa del pipeline de agregación. Distinto del acumulador de agregación `$count`.
`$currentOp`	Devuelve información sobre operaciones activas o inactivas en la implementación de MongoDB. Para ejecutarlo, utilice el `db.aggregate()` método.
`$facet`	Procesa múltiples canalizaciones de agregación dentro de una sola etapa en el mismo conjunto de documentos de entrada. Permite la creación de agregaciones multifacéticas capaces de caracterizar datos a través de múltiples dimensiones, o facetas, en una sola etapa.
`$geoNear`	Devuelve un flujo ordenado de documentos en función de la proximidad a un punto geoespacial. Incorpora la funcionalidad de `$match`, `$sort` y `$limit` para datos geoespaciales. Los documentos de salida incluyen un campo adicional de distancia y pueden incluir un campo de identificador de ubicación.
`$graphLookup`	Realiza una búsqueda recursiva en una colección. A cada documento de salida, agrega un nuevo campo de arreglo que contenga los resultados del recorrido de la búsqueda recursiva para ese documento.
`$group`	Agrupa los documentos de entrada mediante una expresión de identificador específica y aplica la expresión del acumulador, si se especifica, a cada grupo. Consume todos los documentos de entrada y produce un documento por cada grupo distinto. Los documentos de salida solo contienen el campo identificador y, si se especifica, los campos acumulados.
`$indexStats`	Devuelve estadísticas sobre el uso de cada índice de la colección.
`$limit`	Pasa los primeros n documentos sin modificar al pipeline donde n es el límite especificado. Para cada documento de entrada, se genera un documento (para los primeros n documentos) o cero documentos (después de los primeros n documentos).
`$listLocalSessions`	Enumera todas las sesiones activas utilizadas recientemente en la instancia actualmente conectada de `mongos` o `mongod`. Es posible que estas sesiones aún no se hayan propagado a la colección `system.sessions`.
`$listSessions`	Enumera todas las sesiones que han estado activas el tiempo suficiente para propagarse a la colección `system.sessions`.
`$lookup`	Realiza un left outer join a otra colección en la misma base de datos para filtrar documentos de la colección "unida" para su procesamiento.
`$match`	Filtra el flujo de documentos para permitir que solo los documentos coincidentes pasen sin modificaciones a la siguiente etapa del pipeline. `$match` utiliza consultas estándar de MongoDB. Para cada documento de entrada, se genera un documento (si hay coincidencia) o cero documentos (si no hay coincidencia).
`$merge`	Guarda los documentos resultantes del pipeline de agregación en una colección. La etapa puede incorporar (insertar nuevos documentos, fusionar documentos, reemplazar documentos, conservar documentos existentes, fallar la operación, procesar documentos con un pipeline de actualización personalizado) los resultados en una colección de salida. Para usar la etapa `$merge`, debe ser la última etapa del pipeline. Nuevo en la versión 4.2.
`$out`	Guarda los documentos resultantes del pipeline de agregación en una colección. Para usar la etapa `$out`, debe ser la última etapa del pipeline.
`$planCacheStats`	Devuelve información de la caché de planes para una colección.
`$project`	Reestructura cada documento del flujo, por ejemplo, agregando nuevos campos o removiendo los existentes. Para cada documento de entrada, genera un documento.
`$redact`	Reconfigura cada documento en la secuencia restringiendo el contenido de cada documento según la información almacenada en los propios documentos. Incorpora la funcionalidad de `$project` y `$match`. Se puede utilizar para implementar la restricción a nivel de campo. Para cada documento de entrada, genera uno o cero documentos.
`$replaceRoot`	Reemplaza un documento con el documento incrustado específico. La operación reemplaza todos los campos existentes en el documento de entrada, incluido el campo `_id`. Especifique un documento incrustado en el documento de entrada para elevar el documento incrustado al nivel superior.
`$replaceWith`	Reemplaza un documento con el documento incrustado específico. La operación reemplaza todos los campos existentes en el documento de entrada, incluido el campo `_id`. Especifique un documento incrustado en el documento de entrada para elevar el documento incrustado al nivel superior. Alias `$replaceRoot` para.
`$sample`	Selecciona aleatoriamente el número específico de documentos de su entrada.
$search	Realiza una búsqueda de texto completo de los campos en una colección de Atlas. Nota `$search` solo está disponible para clústeres MongoDB Atlas y no está disponible para implementaciones autoadministradas.
`$set`	Añade nuevos campos a los documentos. Genera documentos que contienen todos los campos existentes en los documentos de entrada y los campos recién añadidos. Alias `$addFields` para.
`$setWindowFields`	Agrupa documentos en ventanas y aplica uno o más operadores a los documentos en cada ventana. Nuevo en la versión 5.0.
`$skip`	Omite los primeros documentos n, donde n es el número de omisión especificado, y pasa los documentos restantes sin modificar al pipeline. Para cada documento de entrada, se genera cero documentos (para los primeros documentos n) o un documento (después de los primeros documentos n).
`$sort`	Reordena el flujo de documentos por una clave de ordenación específica. Solo cambia el orden; los documentos permanecen sin modificar. Para cada documento de entrada, genera un documento.
`$sortByCount`	Agrupa los documentos entrantes según el valor de una expresión especificada y luego calcula el número de documentos en cada grupo distinto.
`$unionWith`	Realiza una unión de dos colecciones, es decir, combina los resultados de la canalización de dos colecciones en un único conjunto de resultados. Nuevo en la versión 4.4.
`$unset`	Elimina/excluye campos de los documentos. Alias para la etapa que excluye/elimina `$project` campos.
`$unwind`	Descompone un campo de arreglo de los documentos de entrada para producir un documento por cada elemento. Cada documento de salida reemplaza el arreglo con un valor de elemento. Para cada documento de entrada, genera documentos n, donde n es el número de elementos del arreglo y puede ser cero para un arreglo vacío.

Volver

$bit

$addFields

Compatibilidad

Etapas

db.collection.aggregate() Etapas

Nota

db.aggregate() Etapas

Etapas disponibles para actualizaciones

Listado alfabético de etapas

Nota

`db.collection.aggregate()` Etapas

`db.aggregate()` Etapas