MongoDB\Collection::aggregate()

定義

MongoDB\Collection::aggregate()

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

パラメーター

$pipeline : array|パイプライン

集計パイプライン操作を指定します。集計ステージは MongoDB\Builder\Pipelineインスタンスまたは配列に含めることができます。

$options : 配列

必要なオプションを指定する配列。

名前	タイプ	説明
allowDiskUse	ブール値	一時ファイルへの書込みを有効にします。 `true`に設定すると、集計ステージは`dbPath`ディレクトリの`_tmp`サブディレクトリにデータを書込むことができます。
batchSize	integer	カーソルのバッチサイズを指定します。これは最初の`aggregate`コマンドと後続の`getMore`コマンドの両方に適用されます。これにより、サーバーからの応答ごとに返されるドキュメントの最大数が決まります。 `0`の BatchSize はその点で特別であり、最初の`aggregate`コマンドにのみ適用されます。後続の`getMore`コマンドは、サーバーのデフォルトのバッチサイズを使用します。これは、サーバー側での目立った作業なしに、 `aggregate`からのカーソルやエラーをすばやく返すのに役立つ場合があります。
bypassDocumentValidation	ブール値	`true`の場合、書込み操作によってドキュメントレベルの検証を回避できます。デフォルトは`false`です。これは、 $ out ステージと$outステージを使用する場合にのみ適用されます。
コーデック	MongoDB\Codec\DocumentCodec	ドキュメントのエンコードまたはデコードに使用するタイプコーデックでデータをエンコードする。このオプションは `typeMap` オプションと相互に排他的です。デフォルトはコレクションのコーデック。デフォルトの`codec`オプションの継承は、 `typeMap`オプションの継承よりも優先されます。 1.17バージョンの新機能。:
collation	array\|object	照合順序を指定すると、大文字や小文字、アクセント記号など、string を比較するための言語独自のルールを指定できます。照合を指定する場合、 `locale`フィールドは必須です。その他の照合フィールドはすべてオプションです。フィールドの説明については、「照合ドキュメント」を参照してください。照合が指定されていないが、コレクションにデフォルトの照合がある場合、操作はコレクションに指定された照合を使用します。コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって string が比較されます。
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。コメントには、サーバーバージョン 4.4 以上の有効な BSON タイプであればどれでもかまいません。以前のサーバーバージョンでは string 値のみがサポートされていました。 1.3バージョンの新機能。:
explain	ブール値	パイプラインの処理に関する情報を返すかどうかを指定します。 1.4バージョンの新機能。:
hint	string\|array\|object	使用するインデックス。インデックス名を string またはインデックスキーパターンをドキュメントとして指定します。指定すると、クエリシステムはヒント指定したインデックスを使用するプランのみを考慮します。 1.3バージョンの新機能。:
let	array\|object	パラメーター名と値のマップ。値は、ドキュメントフィールドを参照しない定数または閉じた式である必要があります。その後、パラメーターには集計式コンテキストで変数としてアクセスできます（例: `$$var` ）。これは 5.0 より前のサーバーバージョンではサポートされていないため、使用された場合は実行時に例外が発生します。 1.9バージョンの新機能。:
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。 MongoDB は、次の割り込みポイントが最も近い時点で操作を中止します。
ReadConcern	MongoDB\Driver\ReadConcern	操作に使用する読み取り保証。デフォルトはコレクションの読み取り保証 (read concern) です。トランザクションの一部である個々の操作に対して読み取り保証 (read concern)を指定することはできません。代わりに、トランザクションを開始するときに`readConcern` オプションを設定します。
readPreference	MongoDB\Driver\ReadPreference	操作に使用する読み取り設定。コレクションの読み込み設定（read preference）がデフォルトで設定されます。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。 1.3バージョンの新機能。:
typeMap	配列	カーソルに適用するタイプマップ。BSON ドキュメントをPHP値に変換する方法を決定します。コレクションのタイプマップがデフォルトになります。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。コレクションの書込み保証 (write concern) のデフォルトです。トランザクションの一部である個々の操作に対して書込み保証 (write concern)を指定することはできません。代わりに、トランザクションを開始するときに`writeConcern` オプションを設定します。これは、 $outまたは$mergeステージが指定されている場合にのみ適用されます。

Return Values

MongoDB\Driver\Cursor または ArrayIteratorオブジェクト。どちらの場合も、戻り値は Triggers になります。

エラーと例外

MongoDB\Exception\UnexpectedValueException サーバーからのコマンド応答が不正な形式であった場合、。

MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合はです。

MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。

動作

MongoDB\Collection::aggregate() は MongoDB\Driver\Cursor オブジェクトを返します。

例

次の集計例では、 namesというコレクションを使用してfirst_nameフィールドをグループ化し、各グループの結果の合計数をカウントし、結果を名前でソートします。

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

その他の参照

集計操作
MongoDB\Database::aggregate()
集計コマンド参照（MongoDB マニュアル）
MongoDB マニュアルの集計パイプラインに関するドキュメント