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
    • Reports
    • Case Studies
    • Whitepapers
    • Blog
    • Testimonials
    • Community
  • Contact us
    • Contact
    • Sales Support
    • Feedback and Support
    • Career
    • About Us
  • Store
    • Buy Now
    • Preferred Resellers
    • Team Pricing
  • My License
  • Download
search

Studio 3T Knowledge Base

  • Documentation
  • Tutorials
  • Workshops
Take the fastest route to learning MongoDB. Cover the basics in two hours with MongoDB 101, no registration required.
Start the free course

MongoDB $out Example | The MongoDB Aggregation Pipeline

Posted on: 26/11/2019 (last updated: 09/03/2022) by Kathryn Vargas

This is Stage 3 of a three-part aggregation query example that uses the $lookup, $project & $out stages and Studio 3T. Download it here.

The $out stage

The $out stage is used to export output documents of an aggregation query to a new collection. It must always be last stage of your aggregation pipeline.

To illustrate how a full aggregation query works with an $out stage, we recommend building other stages first:

  • Stage 1 – Join two collections using $lookup
  • Stage 2 – Project fields using $project

In case you haven’t yet, download Studio 3T here.

$out syntax

Once you’re ready to save your aggregation pipeline results, you can write the $out command which has a straightforward syntax:

{ $out: "<output-collection>" }

Replace <output-collection> with your desired new collection name.

$out in Aggregation Editor

Follow the steps in our $project stage example. To finish off our three-stage example, we will add a third and final stage to our pipeline.

Click on the green plus icon. This will open a new tab called Stage 3.

Choose $out from the dropdown menu. 

MongoDB $out stage should always be the last stage in the pipeline

All we need to do is replace <output-collection> – make sure to remove the brackets but keep the quotes! – and type the collection name where we’d like to store our aggregation query’s output documents. 

Let’s type customers-affordable-housing and click on the play button in the toolbar to execute the full pipeline.

Execute the $mongodb out stage

Refresh your current database by right-clicking and choosing Refresh Selected Item or Refresh All.

You should then see your new collection on the list. 

New collection created by $out

$out in mongo shell

To see how $out looks like within the full MongoDB aggregation query, let’s go back to the Aggregation Editor and click on Query Code. 

The full mongo shell code with the $out stage

You should see the mongo shell code with the $out stage included, which you can easily paste into IntelliShell.

db.getCollection("customers").aggregate(
    [
        { 
            "$lookup" : {
                "from" : "housing", 
                "localField" : "address.zip_code", 
                "foreignField" : "Zip Code", 
                "as" : "address.zip_code.affordable_housing_options"
            }
        }, 
        { 
            "$project" : {
                "first" : 1.0, 
                "last" : 1.0, 
                "address.city" : 1.0, 
                "address.state" : 1.0, 
                "address.zip_code.affordable_housing_options.Property Type" : 1.0, 
                "address.zip_code.affordable_housing_options.Property Name" : 1.0, 
                "address.zip_code.affordable_housing_options.Units" : 1.0, 
                "address.zip_code.affordable_housing_options.Zip Code" : 1.0
            }
        }, 
        { 
            "$out" : "customers-affordable-housing"
        }
    ], 
    { 
        "allowDiskUse" : false
    }
);

Now that you’ve reached the end of our three-part aggregation query example:

  • Read more about the Aggregation Editor and its handy features
  • Check out The Beginner’s Guide to MongoDB Aggregation
  • Revisit Stage 1: $lookup or Stage 2: $project

How helpful was this article?
This article was hideous
This article was bad
This article was ok
This article was good
This article was great
Thank you for your feedback!

About The Author

Kathryn Vargas

When she's not writing about working with MongoDB, Kathryn spends her free time exploring Berlin's food scene, playing the drums, learning languages (current mission: German), and hiking.

Article navigation

Related articles

  • MongoDB $project Example | The MongoDB Aggregation Pipeline
  • MongoDB $lookup Example | The MongoDB Aggregation Pipeline
  • Test your skills: Working with the MongoDB Aggregation Pipeline
  • 3 Best MongoDB Aggregation Pipeline Builders
  • Working with the MongoDB Aggregation Pipeline

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
  • Case Studies
  • White Papers
  • Testimonials
  • Discounts

Company

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

© 2022 3T Software Labs GmbH. All rights reserved.

  • Privacy Policy
  • Cookie settings
  • Impressum
When you click "Accept", you are agreeing to cookies being on your device. They may improve site navigation, site usage analysis, or the relevance of messages. It is up to you which cookies are enabled. Read our Privacy Policy.
Manage cookies
Accept
✕

Privacy Preference Center

A cookie is a small file of letters and numbers that is downloaded on to your computer when you visit a website. Cookies are used by many websites and can do a number of things, eg remembering your preferences, recording what you have put in your shopping basket, and counting the number of people looking at a website. In the form below you can choose which cookies, except for essential cookies, to allow or disable.

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.

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.

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