Create an Aggregation Pipeline

Select the Stages view

In the aggregation pipeline pane, ensure the {} Stages toggle switch is selected.

click to enlarge

Add an aggregation stage

At the bottom of the aggregation pipeline pane, click the + Add Stage button.

Select an aggregation pipeline stage

On the upper-left corner of the aggregation stage card, click the Select drop-down menu and select the aggregation pipeline stage to use for the first stage of the pipeline.

Fill in your pipeline stage

Fill in your selected stage. You can adjust the width of the pipeline stage by dragging its border to the right.

Note

The toggle to the right of each pipeline stage name dictates whether that stage is included in the pipeline. Toggling a pipeline stage also updates the pipeline preview, which updates based on whether or not that stage is included.

For example, the following pipeline excludes the first $match stage and only includes the $project stage:

Add additional pipeline stages

To add an additional pipeline stage after your last aggregation stage, click Add Stage. To add an aggregation stage before your most recently added stage, click the + icon above the stage card.

Repeat steps 3 and 4 for each additional stage.

Run the pipeline

At the top-right corner of the pipeline builder, click Run. Compass returns your results in the document view.

Select the Stages view

In the aggregation pipeline pane, ensure the {} Stages toggle switch is selected.

click to enlarge

Open the Stage Wizard card

To the right of the view mode toggle, click the wand icon to open the Stage Wizard card.

click to enlarge

(Optional) Search for an aggregation use case

On the Stage Wizard card, you can filter the use cases by searching for keywords associated with the use case or aggregation stage.

Select an aggregation pipeline stage use case

On the Stage Wizard card, select a stage use case for the first stage of your pipeline. You can click the stage card to add it to the end of your pipeline or drag it to your preferred position.

After you select a use case, Compass populates the stage card with a form that corresponds to the selected aggregation pipeline stage.

The Stage Wizard use cases include the following aggregation stages:

• $group

• $lookup

• $match

• $project

• $sort

Fill in your pipeline stage

Fill in the form for your selected stage and click Apply. After you click Apply, the form will turn into a stage card that you can edit in Stage View Mode, Focus Mode, or Text View Mode.

Compass populates the Stage Output with up to ten sample output documents.

Add additional pipeline stages

To add more aggregation stages to your pipeline, repeat steps 3 and 4 for each additional stage.

Run the pipeline

At the top-right corner of the pipeline builder, click Run. Compass returns your results in the document view.

Select the Stages view

In the aggregation pipeline pane, ensure the {} Stages toggle switch is selected.

click to enlarge

Add an aggregation stage

If you have not already created an aggregation stage, click the + Add Stage button at the bottom of the aggregation pipeline pane.

Open Focus Mode

On the upper-right corner of the stage card, click the Focus Mode icon.

Select an aggregation pipeline stage

Click the Select drop-down menu and select the aggregation pipeline stage to use for the first stage of the pipeline.

Fill in your pipeline stage

Fill in your selected stage. Compass populates the Stage Output with up to ten sample output documents.

You can adjust the width of the Stage Input, stage editor, and the Stage Output by dragging their border to the desired size.

Add additional pipeline stages

Click the Add Stage dropdown to add additional aggregation stages before or after your last aggregation stage. Repeat steps 4 and 5 for each additional stage.

You can add stages with the following keyboard shortcuts:

• To add a stage after the current stage:

  • Windows / Linux: Ctrl + Shift + A

  • Mac: ⌘ + Shift + A

• To add a stage before the current stage:

  • Windows / Linux: Ctrl + Shift + B

  • Mac: ⌘ + Shift + B

Navigate between stages

To navigate between different stages, select the stage you want to edit from the Stage dropdown in the upper-left corner of the Focus Mode modal.

You can navigate between stages with the following keyboard shortcuts:

• To go to the stage before the current stage:

  • Windows / Linux: Ctrl + Shift + 9

  • Mac: ⌘ + Shift + 9

• To add a stage before the current stage:

  • Windows / Linux: Ctrl + Shift + 0

  • Mac: ⌘ + Shift + 0

Run the pipeline

Click x to exit Focus Mode and select Run at the top right of the pipeline builder. Compass returns your results in the document view.

Select the Text view

In the aggregation pipeline pane, click the </> Text toggle switch to enable text mode for pipeline editing.

click to enlarge

Enter your aggregation pipeline

Enter valid aggregation syntax into the text editor. The text editor provides real-time linting for correct syntax and debugging information.

You can also use Text View Mode to import aggregation pipelines from plain text by typing or pasting your pipeline into the text editor.

For example, following pipeline limits the query results to 4 documents.

[ { "$limit" : 4 } ]

Note

To expand all embedded fields and documents within the preview results, click Output Options and select Expand all fields.

Run the pipeline

Click Run at the top right of the pipeline builder. Compass returns your results in the document view.