Docs Menu
Docs Home
/
MongoDB Compass

集計パイプラインを作成する

項目一覧

  • このタスクについて
  • 始める前に
  • 手順
  • 詳細

MongoDB Compass の Aggregation Pipeline Builder を使用すると、コレクションまたはビューからのドキュメントを処理し、計算された結果を返す集計パイプラインを作成できます。

MongoDB Compass は、集計パイプラインを作成するためのさまざまなモードを提供します。

  • Stage View Mode は、選択したステージに基づいてパイプライン構文をプリロードするビジュアルパイプラインエディタです。

  • Stage Wizard は Stage View Mode の機能で、シンプルな集計ステージのユースケース用のテンプレートセットを提供します。Stage Wizard には、集計パイプラインを初めて使う際に役立つ簡単なユースケースのみが含まれています。

  • Focus Mode は、一度に 1 つのパイプラインステージを編集するステージビューモードの機能です。Focus Mode は、複雑な、または深くネストされた集計パイプライン ステージを管理するのに役立ちます。

  • Text View Mode は、生のパイプライン構文を受け入れるテキストベースのパイプライン エディターです。

集計パイプラインをビルドするには、コレクションを選択して Aggregationsタブをクリックします。Compass に空白の集計パイプラインが表示されます。Preview of Documents in the Collection セクションには、選択したコレクションからランダムにサンプリングされた 10 個のドキュメントが表示されます。

注意

Atlas Search ステージ

Atlas でホストされているMongoDBデプロイに接続すると、Atlas 専用ステージ $search $searchMeta が 集計パイプラインビルダで利用できるようになります。これらのステージを使用して、Atlas コレクションで 全文検索を 実行します。

集約パイプラインの作成方法を見るには、選択したビューモードに対応するタブを選択します。

1

集計パイプライン ペインで、{} Stagesトグル スイッチが選択されていることを確認します。

ステージビューモードの切り替え
クリックして拡大します
2

集計パイプライン ペインの下部にある + Add Stage ボタンをクリックします。

3

集計ステージ カードの左上隅にある Selectドロップダウン メニューをクリックし、パイプラインの最初のステージに使用する集計パイプライン ステージを選択します。

4

選択したステージを入力します。パイプライン ステージの境界を右にドラッグすると、パイプライン ステージの幅を調整できます。

注意

各パイプラインステージ名の右側にあるトグルで、そのステージをパイプラインに含めるかどうかを設定します。パイプラインステージを切り替えることによってパイプラインプ レビューもアップデートされ、プレビューはそのステージが含まれているかどうかに基づいてアップデートされます。

たとえば、次のパイプラインでは、最初の $match ステージが除外され、$project ステージのみが含まれます。

Aggregation Builder の除外ステージの例
5

最後の集計ステージの後にパイプライン ステージを追加するには、Add Stage をクリックします。最後に追加したステージの前に集計ステージを追加するには、ステージ カードの上にある + アイコンをクリックします。

追加のステージごとにステップ 3 と 4 を繰り返します。

注意

パイプラインステージの順序を変更するには、各ステージ カードのヘッダーをドラッグします。

6

パイプライン ビルダの右上隅にある Run をクリックします。Compass は、ドキュメント ビューに結果を返します。

警告

1

集計パイプライン ペインで、{} Stagesトグル スイッチが選択されていることを確認します。

ステージビューモードの切り替え
クリックして拡大します
2

表示モード トグルの右側にあるステッキのアイコンをクリックして、 Stage Wizard カードを開きます。

表示モードのトグルの右側にあるアイコンをクリックします。
クリックして拡大します
3

Stage Wizard カードでは、ユースケースまたは集計ステージに関連付けられたキーワードを検索して、ユースケースをフィルタリングできます。

4

Stage Wizard カードで、パイプラインの最初のステージのステージ ユースケースを選択します。ステージ カードをクリックしてパイプラインの末尾に追加したり、希望の位置にドラッグしたりできます。

ユースケースを選択すると、Compass は、選択した集計パイプライン ステージに対応するフォームでステージ カードを入力します。

ステージ ウィザードのユースケースには、次の集計ステージが含まれます。

5

選択したステージのフォームに入力し、Apply をクリックします。Apply をクリックすると、フォームはステージ カードに変わり、ステージ ビュー モード、フォーカス モード、またはテキスト ビュー モードで編集できるようになります。

Compass は、ステージ出力に最大 10 個のサンプル出力ドキュメントを入力します。

注意

ステージ ウィザードを使用して既存のステージを編集することはできません。ステージ ウィザードでは新しいステージしか追加できません。既存のステージを編集するには、ステージ ビュー モード、フォーカス モード、またはテキスト ビュー モードを使用します。

6

パイプラインにさらに集計ステージを追加するには、追加するステージごとにステップ 3 と 4 を繰り返します。

Tip

パイプラインステージの順序を変更するには、各ステージ カードのヘッダーをドラッグします。

7

パイプライン ビルダの右上隅にある Run をクリックします。Compass は、ドキュメント ビューに結果を返します。

1

集計パイプライン ペインで、{} Stagesトグル スイッチが選択されていることを確認します。

ステージビューモードの切り替え
クリックして拡大します
2

集計ステージをまだ作成していない場合は、集計パイプライン ペインの下部にある + Add Stage ボタンをクリックします。

3

ステージ カードの右上隅にあるフォーカス モードのアイコンをクリックします。

Focus Mode ボタンを選択します
4

Selectドロップダウン メニューをクリックし、パイプラインの最初のステージに使用する集計パイプライン ステージを選択します。

5

選択したステージを入力します。Compass は、 Stage Outputに最大 10 個のサンプル出力ドキュメントを入力します。

Stage Input 、ステージ エディターおよび Stage Output の幅は、境界線をドラッグして希望のサイズに調整できます。

注意

各パイプラインステージ名の右側にあるトグルで、そのステージをパイプラインに含めるかどうかを設定します。パイプラインステージを切り替えることによってパイプラインプ レビューもアップデートされ、プレビューはそのステージが含まれているかどうかに基づいてアップデートされます。

6

Add Stage ドロップダウンをクリックして、最後の集計ステージの前または後に集計ステージを追加します。ステージの追加ごとにステップ 4 と 5 を繰り返します。

次のキーボード ショートカットを使用してステージを追加できます。

  • 現在のステージの後にステージを追加するには:

    • Windows / Linux: Ctrl + Shift + A

    • Mac: ⌘ + Shift + A

  • 現在のステージの前にステージを追加するには:

    • Windows / Linux: Ctrl + Shift + B

    • Mac: ⌘ + Shift + B

7

異なるステージ間を移動するには、フォーカス モード モーダルの左上隅にある Stage ドロップダウンから編集するステージを選択します。

次のキーボード ショートカットを使用してステージ間を移動できます。

  • 現在のステージの前のステージに移動するには:

    • Windows / Linux: Ctrl + Shift + 9

    • Mac: ⌘ + Shift + 9

  • 現在のステージの前にステージを追加するには:

    • Windows / Linux: Ctrl + Shift + 0

    • Mac: ⌘ + Shift + 0

8

x をクリックしてフォーカス モードを終了し、パイプライン ビルダの右上にある Run を選択します。Compass は、ドキュメント ビューに結果を返します。

1

集計パイプライン ペインで </> Text 切り替えスイッチをクリックして、パイプライン編集のテキストモードを有効にします。

テキストモードをオンに切り替え
クリックして拡大します
2

有効な集計構文をテキストエディタに入力します。テキストエディターは、正しい構文とデバッグ情報のためのリアルタイム リンティングを提供します。

テキスト ビュー モードを使用して、パイプラインをテキストエディターに入力または貼り付けることで、プレーンテキストから集計パイプラインをインポートすることもできます。

たとえば、次のパイプラインはクエリ結果を 4 つのドキュメントに制限します。

[ { "$limit" : 4 } ]

注意

プレビュー結果のすべての埋め込みフィールドと埋め込みドキュメントを展開するには、Output Options をクリックして Expand all fields を選択します。

パイプライン出力プレビュー
3

パイプライン ビルダの右上にある Run をクリックします。Compass は、ドキュメント ビューに結果を返します。

  • Aggregation Pipeline

  • 集計パイプライン ステージ

  • 集計パイプラインビルダーの設定

  • パイプラインを特定言語にエクスポート

戻る

組み込みの MongoDB Shell