MongoDB Compass Aggregation Builder Tutorial

What is the Aggregation Builder?

The Aggregation Builder is a visual tool in MongoDB Compass designed to help users build aggregation pipelines step-by-step.

Instead of writing JSON or JavaScript code, you can add stages through an intuitive interface, configure each stage, and immediately see the results.

• Simplifies pipeline creation for beginners and experts alike.
• Supports all standard aggregation stages.
• Provides real-time feedback on query results.
• Allows easy modification and reordering of stages.

Key Aggregation Stages in Compass

Aggregation pipelines consist of multiple stages, each performing a specific operation on the data.

Common stages you will use in Compass include:

• $match: Filters documents to pass only those that meet specified criteria.
• $group: Groups documents by a specified key and performs aggregations like sum or average.
• $project: Reshapes documents by including, excluding, or adding fields.
• $sort: Orders documents by specified fields.
• $limit: Restricts the number of documents passed to the next stage.

Building an Aggregation Pipeline in Compass

To create a pipeline, open the Aggregation tab in MongoDB Compass and start adding stages.

Each stage can be configured using a form or JSON editor within Compass.

You can add multiple stages, reorder them by dragging, and remove stages as needed.

• Click 'Add Stage' to insert a new pipeline stage.
• Select the stage operator from a dropdown menu.
• Fill in the stage details using the provided editor.
• Use the 'Preview' feature to see the output after each stage.
• Save or export the pipeline once complete.

Example: Aggregating Sales Data

Suppose you have a collection of sales records and want to find the total sales per product category.

Using the Aggregation Builder, you can create a pipeline with the following stages:

• $match: Filter sales within a specific date range.
• $group: Group by product category and sum the sales amount.
• $sort: Order categories by total sales descending.

Exporting and Using Pipelines

Once your pipeline is ready, you can export it as JSON to use in your application code.

Compass provides an export option that copies the pipeline stages in a format compatible with MongoDB drivers.

• Click the 'Export Pipeline' button.
• Choose the desired format (e.g., JavaScript or JSON).
• Paste the exported pipeline into your application code or scripts.