MongoDB\Collection::aggregate()

Definición

MongoDB\Collection::aggregate()

Ejecuta un pipeline del marco de agregación operación en la colección.

function aggregate(
    array|Pipeline $pipeline,
    array $options = []
): Traversable

Parámetros

$pipeline : arreglo|pipeline

Especifica una operación de pipeline de agregación. Puedes incluir etapas de agregación en una instancia MongoDB\Builder\Pipeline o en un arreglo.

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
allowDiskUse	booleano	Permite escribir en archivos temporales. Cuando se establece en true, las etapas de agregación pueden guardar datos en el subdirectorio _tmp en el directorio dbPath.
batchSize	entero	Especifica el tamaño de lote para el cursor, que se aplicará tanto al comando inicial aggregate como a cualquier comando getMore posterior. Esto determina el número máximo de documentos que se devolverán en cada respuesta del servidor. Un batchSize de 0 es especial en ese sentido y solo se aplicará al comando inicial aggregate; los comandos getMore posteriores usarán el tamaño de lotes por defecto del servidor. Esto puede ser útil para devolver rápidamente un cursor o un error de aggregate sin realizar un trabajo significativo del lado del servidor.
bypassDocumentValidation	booleano	Si true, permite que la operación de guardar eluda la validación a nivel de documento. Por defecto es false. Esto solo se aplica al usar las etapas $out y $out.
códec	MongoDB\Codec\DocumentCodec	La Codifica datos con códecs de tipo para usar en la codificación o decodificación de documentos. Esta opción es mutuamente excluyente con la opción typeMap. Se configura de forma predeterminada al códec de la colección. La herencia para una opción codec por defecto tiene prioridad sobre la de la opción typeMap. Novedad en la versión 1.17.
intercalación	arreglo|objeto	Intercalación permite a los usuarios especificar reglas específicas del lenguaje para la comparación de cadenas, tales como reglas para mayúsculas y tildes. Al especificar la intercalación, el campo locale es obligatorio; todos los demás campos de intercalación son opcionales. Para obtener descripciones de los campos, consulte Documento de intercalación. Si la intercalación no está especificada pero la colección tiene una intercalación predeterminada, la operación utiliza la intercalación especificada para la colección. Si no se especifica una intercalación para la colección o para la operación, MongoDB utiliza la comparación binaria simple utilizada en versiones anteriores para comparar cadenas.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del perfilador de bases de datos, la salida actualOp() y registros. El comentario puede ser de cualquier tipo válido de BSON para las versiones de servidor 4.4 en adelante. Las versiones anteriores del servidor solo soportan valores string. Nueva en la versión 1.3.
explicar	booleano	Especifica si se debe devolver o no la información sobre el procesamiento del pipeline. Nuevo en la versión 1.4.
hint	cadena|arreglo|objeto	El índice a utilizar. Especifique el nombre del índice como una string o el patrón clave del índice como un documento. Si se especifica, el sistema de query solo considerará los planes que utilicen el índice sugerido. Nueva en la versión 1.3.
permitir	arreglo|objeto	Mapa de nombres de parámetros y valores. Los valores deben ser expresiones constantes o cerradas que no hagan referencia a los campos del documento. Posteriormente, se puede acceder a los parámetros como variables en el contexto de una expresión de agregación (por ejemplo, $$var). Esto no está soportado para versiones del servidor anteriores a la 5.0 y resultará en una excepción en el momento de la ejecución si se usa. Nuevo en la versión 1.9.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación en el siguiente punto de interrupción..
readConcern	MongoDB\Driver\ReadConcern	Nivel de consistencia de lectura para usar en la operación. Por defecto, adopta el nivel de consistencia de lectura de la colección. No es posible especificar un nivel de consistencia de lectura para operaciones individuales como parte de una transacción. En su lugar, configura la opción readConcern al iniciar la transacción.
readPreference	MongoDB\Driver\ReadPreference	Preferencia de lectura a utilizar para la operación. Por defecto, se utiliza la preferencia de lectura de la colección.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación. Nueva en la versión 1.3.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza el mapa de tipos de la colección.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a usar en la operación. Por defecto, se aplica el nivel de confirmación de escritura (write concern) de la colección. No es posible especificar un nivel de confirmación de escritura (write concern) para operaciones individuales como parte de una transacción. En su lugar, configura la opción writeConcern al iniciar la transacción. Esto solo se aplica cuando se especifica una etapa $out o $merge.

Return Values

Un objeto MongoDB\Driver\Cursor o ArrayIterator. En ambos casos, el valor de retorno será Traversable.

Errores/Excepciones

MongoDB\Exception\UnexpectedValueException si la respuesta del comando del servidor era incorrecta.

MongoDB\Exception\UnsupportedException si se usan opciones que no sean compatibles con el servidor seleccionado (p. ej. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\RuntimeException para otros errores a nivel de extensión (por ejemplo, " errores de conexión).

Comportamiento

MongoDB\Collection::aggregate() devuelve un objeto MongoDB\Driver\Cursor.

Ejemplos

El siguiente ejemplo de agregación utiliza una colección llamada names y agrupa el campo first_name, cuenta el número total de resultados en cada grupo y ordena los resultados por nombre.

<?php
$collection = (new MongoDB\Client)->test->names;
$cursor = $collection->aggregate(
    [
        ['$group' => ['_id' => '$first_name', 'name_count' => ['$sum' => 1]]],
        ['$sort' => ['_id' => 1]],
    ]
);

Ver también

• Operaciones de agregación

• MongoDB\Database::aggregate()

• referencia de comando de aggregate en el manual de MongoDB

• Pipelines de agregación documentación en el Manual de MongoDB