Skip to content
Studio 3T - The professional GUI, IDE and client for MongoDB
  • Tools
    • Aggregation Editor
    • IntelliShell
    • Visual Query Builder
    • Export Wizard
    • Import Wizard
    • Query Code
    • SQL Query
    • Connect
    • Schema Explorer
    • Compare
    • SQL ⇔ MongoDB Migration
    • Data Masking
    • Task Scheduler
    • Reschema
    • More Tools and Features
  • Solutions
  • Resources
    • Knowledge Base
    • MongoDB Tutorials & Courses
    • Tool/Feature Documentation
    • Blog
    • Community
    • Testimonials
    • Whitepapers
    • Reports
  • Contact us
    • Contact
    • Sales Support
    • Feedback and Support
    • Careers
    • About Us
  • Store
    • Buy Now
    • Preferred Resellers
    • Team Pricing
  • Download
  • My 3T
search

Academy 3T

  • Explore our courses
    • MongoDB 101: Getting Started
    • MongoDB 201: Querying MongoDB Data
    • MongoDB 301: Aggregation
  • Get certified

Lesson 3, Exercise 1: Filtering the documents in the aggregation pipeline

MongoDB 201: Querying MongoDB Data Working with the MongoDB Aggregation Pipeline Lesson 3, Exercise 1: Filtering the documents in the aggregation pipeline

In this exercise, you will launch the Aggregation Editor and add the first stage to the pipeline.

The stage is based on the $match aggregate operator, which lets you filter the documents in the pipeline so you’re working with only a subset of documents.

Each exercise in this section walks you through the steps necessary to add a stage to the aggregate pipeline.

By the end of the exercises, you will have created an aggregate statement that returns the number of transactions in each city in California, as they’re recorded in the customers collection.

The exercises in this section are based on the sales database and the customers collection. The first section in this course demonstrated how to create the database and import the collection. Refer to that section for details on how to set them up if you haven’t done so already.

To filter the documents in the aggregation pipeline

1. Launch Studio 3T and connect to MongoDB Atlas.

Don’t have a MongoDB Atlas instance? Here’s how to set up a free cluster, or connect to an existing MongoDB database or localhost instead.

2. In the Connection Tree, expand the sales database node and, if necessary, expand the Collections node.

3. Right-click the customers collection node, and then click Open Aggregation Editor. Studio 3T opens the Aggregation Editor in its own tab in the main window. 

The following figure shows the Aggregation tab when you first launch the Aggregation Editor for the customers collection.

The Aggregation tab is divided into two sections.

The top section provides a workspace for building your aggregation, setting statement options, and viewing the final query code.

The bottom section displays the query results when you run your aggregation.

Aggregate tab

4. On the Pipeline tab in the upper section, click the Add button (add symbol) to add a new stage to the pipeline.

The Aggregation Editor adds the Stage 1: match tab to the right of the Pipeline tab and makes the new tab active.

By default, the $match operator is selected in the Filter drop-down list, as shown in the following figure.

The $match operator filters the documents so that only those that match the specified condition will be included in the pipeline.

The top section of the Stage 1 tab provides an editor for adding the expression that’s passed to the $match operator.

The editor is pre-populated with a set of curly braces that will enclose the expression, along with a comment (// enter query here) that serves as a placeholder for the expression.

The bottom section of the Stage 1 tab is where the query results for that stage are displayed. This section is divided into the Stage Input pane and the Stage Output pane.

  • The Stage Input pane displays the results up to but not including the current stage
  • The Stage Output pane displays the results up to and including the current stage

5. Delete the placeholder in the editor window and type the following expression:

"address.state": "California"

The expression specifies that the address.state field value must equal California in order for a document to be returned. You do not include the $match operator itself, only its expression. The Aggregation Editor puts all the pieces together for you.

When adding the expression, be sure to insert a tab or a couple spaces before the expression so it’s indented. This makes it much easier to read your code as it becomes more complex. You final expression should look like the follow code:

{
  "address.state": "California"
}

6. In the Stage Input pane in the bottom section, click the Execute button (Execute entire script). This will execute the pipeline up to but not including the first stage.

The following figure shows part of the results, as they appear in Table View.

Stage input execute

7. In the Stage Output pane in the bottom section, click the Execute button. This will execute the pipeline up to and including the first stage.

The following figure shows part of the results for both panes, as they appear in Table View.

stage input output

The results in Stage Input pane include all 1,000 documents in the customers collection.

The results in the Stage Output pane include only documents whose address.state value is California, which totals 94 documents. These are the documents that are passed on down the pipeline to the next stage.

8. Go to the Query Code tab in the upper section. The tab displays the aggregate statement as it has been defined up to this point. It now includes the $match operator and its expression, as shown in the following figure.

Notice that the aggregate statement also includes the allowDiskUse option, set to false.

If the option were set to true, aggregation operations could write to the _tmp subdirectory in the dbPath directory.

The Aggregation Editor includes this option in the aggregate statement by default. You can set this and other options on the Options tab.

9. Go to the Pipeline tab. Each time you insert a stage, it is added to the pipeline and reflected on this tab.

The Stage 1 row should show the $match operator and its expression (in the Specification column), as shown in the following figure.

10. On the toolbar of the Aggregation tab, click the Execute button. The Aggregation Editor runs the query in its current state and displays the results in the Pipeline output pane, as shown in the following figure.

Pipeline output

11. Leave the Aggregation tab and aggregate statement in place for the next exercise.

Previous Topic
Back to Lesson
Next Topic
  • Course Home Expand All
    Performing MongoDB CRUD Operations
    4 Topics | 1 Quiz
    Lesson 1, Exercise 1: Adding a document to a collection
    Lesson 1, Exercise 2: Viewing a document in a collection
    Lesson 1, Exercise 3: Updating a document in a collection
    Lesson 1, Exercise 4: Deleting a document from a collection
    Test your skills: Performing CRUD Operations
    Building MongoDB find() Queries
    4 Topics | 1 Quiz
    Lesson 2: The MongoDB find method
    Lesson 2, Exercise 1: Using IntelliShell to build and run find statements
    Lesson 2, Exercise 2: Using Visual Query Builder to build and run find statements
    Lesson 2, Exercise 3: Using Query Code and IntelliShell to modify and run a find statement
    Test your skills: Building MongoDB find() Queries
    Working with the MongoDB Aggregation Pipeline
    6 Topics | 1 Quiz
    Lesson 3: Introducing the MongoDB aggregate method
    Lesson 3, Exercise 1: Filtering the documents in the aggregation pipeline
    Lesson 3, Exercise 2: Grouping the documents in the aggregation pipeline
    Lesson 3, Exercise 3: Adding and removing fields in the aggregation pipeline
    Lesson 3, Exercise 4: Changing the field order in the aggregation pipeline
    Lesson 3, Exercise 5: Sorting the documents in the aggregation pipeline
    Test your skills: Working with the MongoDB Aggregation Pipeline
    Querying Arrays Using MongoDB $elemMatch
    4 Topics | 1 Quiz
    Lesson 4, Exercise 1: Using IntelliShell to query single and multiple values in an array
    Lesson 4, Exercise 2: Using Visual Query Builder to query a single array value
    Lesson 4, Exercise 3: Using Visual Query Builder to query multiple array values
    Test your skills: Querying Arrays Using MongoDB $elemMatch
    MongoDB 201 Mid-Course Feedback
    Querying Embedded Documents in MongoDB Arrays
    3 Topics | 1 Quiz
    Lesson 5, Exercise 1: Using the $elemMatch operator to query embedded documents
    Lesson 5, Exercise 2: Using conditional operators to query embedded documents
    Lesson 5, Exercise 3: Using Visual Query Builder to query embedded documents
    Test your skills: Querying Embedded Documents in Arrays
    Querying MongoDB with SQL SELECT Statements
    2 Topics | 1 Quiz
    Lesson 6, Exercise 1: Using the SQL Query tool to run SQL statements
    Lesson 6, Exercise 2: Using the SQL Query tool to aggregate collection data
    Test your skills: Querying MongoDB with SQL
    Working with MongoDB Views
    3 Topics | 1 Quiz
    Lesson 7, Exercise 1: Creating a MongoDB view
    Lesson 7, Exercise 2: Querying a MongoDB view
    Lesson 7, Exercise 3: Modifying and deleting a MongoDB view
    Test your skills: Working with MongoDB Views
    Course Extras
    Return to MongoDB 201: Querying MongoDB Data
  • Studio 3T

    MongoDB Enterprise Certified Technology PartnerSince 2014, 3T has been helping thousands of MongoDB developers and administrators with their everyday jobs by providing the finest MongoDB tools on the market. We guarantee the best compatibility with current and legacy releases of MongoDB, continue to deliver new features with every new software release, and provide high quality support.

    Find us on FacebookFind us on TwitterFind us on YouTubeFind us on LinkedIn

    Education

    • Free MongoDB Tutorials
    • Connect to MongoDB
    • Connect to MongoDB Atlas
    • Import Data to MongoDB
    • Export MongoDB Data
    • Build Aggregation Queries
    • Query MongoDB with SQL
    • Migrate from SQL to MongoDB

    Resources

    • Feedback and Support
    • Sales Support
    • Knowledge Base
    • FAQ
    • Reports
    • White Papers
    • Testimonials
    • Discounts

    Company

    • About Us
    • Blog
    • Careers
    • Legal
    • Press
    • Privacy Policy
    • EULA

    © 2023 3T Software Labs Ltd. All rights reserved.

    • Privacy Policy
    • Cookie settings
    • Impressum

    We value your privacy

    With your consent, we and third-party providers use cookies and similar technologies on our website to analyse your use of our site for market research or advertising purposes ("analytics and marketing") and to provide you with additional functions (“functional”). This may result in the creation of pseudonymous usage profiles and the transfer of personal data to third countries, including the USA, which may have no adequate level of protection for the processing of personal data.

    By clicking “Accept all”, you consent to the storage of cookies and the processing of personal data for these purposes, including any transfers to third countries. By clicking on “Decline all”, you do not give your consent and we will only store cookies that are necessary for our website. You can customize the cookies we store on your device or change your selection at any time - thus also revoking your consent with effect for the future - under “Manage Cookies”, or “Cookie Settings” at the bottom of the page. You can find further information in our Privacy Policy.
    Accept all
    Decline all
    Manage cookies
    ✕

    Privacy Preference Center

    With your consent, we and third-party providers use cookies and similar technologies on our website to analyse your use of our site for market research or advertising purposes ("analytics and marketing") and to provide you with additional functions (“functional”). This may result in the creation of pseudonymous usage profiles and the transfer of personal data to third countries, including the USA, which may have no adequate level of protection for the processing of personal data. Please choose for which purposes you wish to give us your consent and store your preferences by clicking on “Accept selected”. You can find further information in our Privacy Policy.

    Accept all cookies

    Manage consent preferences

    Essential cookies are strictly necessary to provide an online service such as our website or a service on our website which you have requested. The website or service will not work without them.

    Performance cookies allow us to collect information such as number of visits and sources of traffic. This information is used in aggregate form to help us understand how our websites are being used, allowing us to improve both our website’s performance and your experience.

    Google Analytics

    Google Ads

    Bing Ads

    Facebook

    LinkedIn

    Quora

    Hotjar

    Functional cookies collect information about your preferences and choices and make using the website a lot easier and more relevant. Without these cookies, some of the site functionality may not work as intended.

    HubSpot

    Social media cookies are cookies used to share user behaviour information with a third-party social media platform. They may consequently effect how social media sites present you with information in the future.

    Accept selected