集計ビルダー

サンプル ドキュメント

次の例では、 Userモデルで表されるコレクションに対して集計パイプラインを実行します。 次のinsert()メソッドを実行してサンプル データを追加できます。

User::insert([
    ['name' => 'Alda Gröndal', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('2002-01-01'))],
    ['name' => 'Francois Soma', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-02-02'))],
    ['name' => 'Janet Doe', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1987-03-03'))],
    ['name' => 'Eliud Nkosana', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1984-04-04'))],
    ['name' => 'Bran Steafan', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-05-05'))],
    ['name' => 'Ellis Lee', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1996-06-06'))],
]);

マッチステージの例

クエリフィルターを指定するには、 match()メソッドを集計パイプラインにチェーンできます。 このステージを省略すると、 aggregate()メソッドは次の ステージのモデルの コレクション内のすべてのドキュメントを出力します。

この集計ステージは、利用可能なインデックスを使用してデータを取得し、後続のステージで処理されるデータ量を減らすために、多くの場合最初に配置されます。

この例では、 MongoDB\Builder\Queryビルダを使用して、一致集計ステージのクエリフィルターを構築します。 一致ステージには、次の条件が含まれます。

• Query::or()関数を使用して、クエリフィルターのいずれかに一致する結果を返します

• occupation関数と 関数を使用して、値が である フィールドを含むドキュメントと一致させます"designer"Query::query()Query::eq()

• name関数と"Eliud Nkosana" Query::query()関数を使用して、 の値を持つ フィールドを含むドキュメントと一致させますQuery::eq()

コードの実行によって返されたドキュメントを確認するには、[ VIEW OUTPUTボタンをクリックします。

$pipeline = User::aggregate()
    ->match(Query::or(
        Query::query(occupation: Query::eq('designer')),
        Query::query(name: Query::eq('Eliud Nkosana')),
    ));
$result = $pipeline->get();

[
  {
    "_id": ...,
    "name": "Janet Doe",
    "occupation": "designer",
    "birthday": {
      "$date": {
        "$numberLong": "541728000000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Eliud Nkosana",
    "occupation": "engineer",
    "birthday": {
      "$date": {
        "$numberLong": "449884800000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Ellis Lee",
    "occupation": "designer",
    "birthday": {
      "$date": {
        "$numberLong": "834019200000"
      }
    }
  }
]

グループ ステージの例

group()メソッドを集計パイプラインにチェーンして、計算を実行し、一般的なフィールド値でグループ化してデータの構造を変更できます。

この集計ステージは、後続のステージで処理されるデータを減らすために、多くの場合、一致ステージの直後に配置されます。

この例では、 MongoDB\Builder\Expressionビルダを使用して、グループ集計ステージでグループキーを定義します。 グループ ステージでは、次のグループ化動作を指定します。

• _idフィールドで表されるグループ キーの値を、 Expressionビルダで定義されたフィールド値に設定します

• Expression::fieldPath()関数を呼び出して、 occupationフィールドのドキュメント値を参照します

コードの実行によって返されたドキュメントを確認するには、[ VIEW OUTPUT ] ボタンをクリックします。

$pipeline = User::aggregate()
    ->group(_id: Expression::fieldPath('occupation'));
$result = $pipeline->get();

[
  { "_id": "engineer" },
  { "_id": "designer" }
]

ソート ステージの例

ドキュメントの出力順序を指定するには、 sort()メソッドを集計パイプラインにチェーンできます。

この集計ステージは、パイプラインのどこにでも追加できます。 グループ化されたデータに依存する可能性があるため、グループ ステージの後に配置されることが多い。 処理されるデータを制限するために、ソート ステージを可能な限りパイプラインの末尾に配置することをお勧めします。

並べ替えを指定するには、フィールド値を 昇順ソート の場合はSort::Asc列挙型に設定し、降順ソートの場合はSort::Desc列挙型に設定します。

この例では、ドキュメントをnameフィールドでSort::Descにソートするsort()集計パイプライン ステージが示されています。これはアルファベットの逆順に対応します。 コードの実行によって返されたドキュメントを確認するには、 VIEW OUTPUTボタンをクリックします。

$pipeline = User::aggregate()
    ->sort(name: Sort::Desc);
$result = $pipeline->get();

[
  {
    "_id": ...,
    "name": "Janet Doe",
    "occupation": "designer",
    "birthday": {
      "$date": {
        "$numberLong": "541728000000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Francois Soma",
    "occupation": "engineer",
    "birthday": {
      "$date": {
        "$numberLong": "886377600000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Ellis Lee",
    "occupation": "designer",
    "birthday": {
      "$date": {
        "$numberLong": "834019200000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Eliud Nkosana",
    "occupation": "engineer",
    "birthday": {
      "$date": {
        "$numberLong": "449884800000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Bran Steafan",
    "occupation": "engineer",
    "birthday": {
      "$date": {
        "$numberLong": "894326400000"
      }
    }
  },
  {
    "_id": ...,
    "name": "Alda Gröndal",
    "occupation": "engineer",
    "birthday": {
      "$date": {
        "$numberLong": "1009843200000"
      }
    }
  }
]

プロジェクト ステージの例

project()メソッドを集計パイプラインにチェーンして、このステージで表示するドキュメントのフィールドを指定できます。

含めるフィールドを指定するには、フィールドの名前と1やtrueなどの真実の値を渡します。 他のすべてのフィールドは出力から省略されます。

あるいは、除外するフィールドを指定するには、各フィールド名と誤った値（ 0やfalseなど）を渡します。 他のすべてのフィールドは出力に含まれます。

この例では、 project()メソッド集計ステージを使用してnameフィールドのみを含め、他のすべてのフィールドを出力から除外する方法を示します。 コードの実行によって返されたデータを確認するには、 VIEW OUTPUTボタンをクリックします。

$pipeline = User::aggregate()
    ->project(_id: 0, name: 1);
$result = $pipeline->get();

[
  { "name": "Alda Gröndal" },
  { "name": "Francois Soma" },
  { "name": "Janet Doe" },
  { "name": "Eliud Nkosana" },
  { "name": "Bran Steafan" },
  { "name": "Ellis Lee" }
]

aggregation pipelineの例

この集計パイプラインの例は、複数のステージに連結されています。 各ステージは、先行する各ステージから取得された出力に対して実行されます。 この例では、 ステージは次の操作を順番に実行します。

• birth_yearフィールドをドキュメントに追加し、値をbirthdayフィールドから抽出された年に設定します。

• occupationフィールドの値でドキュメントをグループ化し、 Accumulator::avg()関数を使用して各グループのbirth_yearの平均値を計算します。 計算の結果をbirth_year_avgフィールドに割り当てます。

• ドキュメントをグループキー フィールドで昇順にソートします。

• グループキー フィールドの値からprofessionフィールドを作成し、 birth_year_avgフィールドを含め、 _idフィールドを省略します。

コードの実行によって返されるデータを確認するには、[ VIEW OUTPUT ] ボタンをクリックします。

$pipeline = User::aggregate()
    ->addFields(
        birth_year: Expression::year(
            Expression::dateFieldPath('birthday'),
        ),
    )
    ->group(
        _id: Expression::fieldPath('occupation'),
        birth_year_avg: Accumulator::avg(Expression::numberFieldPath('birth_year')),
    )
    ->sort(_id: Sort::Asc)
    ->project(profession: Expression::fieldPath('_id'), birth_year_avg: 1, _id: 0);

[
  {
    "birth_year_avg": 1991.5,
    "profession": "designer"
  },
  {
    "birth_year_avg": 1995.5,
    "profession": "engineer"
  }
]