Docs Menu

Docs HomeMongoDB Atlas

Create From the UI

On this page

  • Prerequisites
  • Procedure

This page describes how to deploy a federated database instance for accessing data in an Atlas cluster.

Before you begin, you will need to:

  • Create a MongoDB Atlas account, if you do not have one already.

  • Create an Atlas Cluster, if you do not have one already. Atlas Data Federation supports Atlas clusters deployed to AWS, Azure, or Google Cloud.


    To use your Atlas cluster as a data store, you must deploy it to the same project as your federated database instance.

  • Add data to at least one collection on your Atlas cluster if you have not already.

  1. Click the Create New Federated Database dropdown.

  2. Select Manual Setup.

  • For a guided experience, click Visual Editor.

  • To edit the raw JSON, click JSON Editor.

  1. (Optional) Click the for the:

    • Data Lake to specify a name for your federated database instance. Defaults to Data Lake[n].

    • Database to edit the database name. Defaults to Database[n].

      Corresponds to databases.[n].name JSON configuration setting.

    • Collection to edit the collection name. Defaults to Collection[n].

      Corresponds to databases.[n].collections.[n].name JSON configuration setting.

    • View to edit the view name.

    You can click:

    • Create Database to add databases and collections.

    • associated with the database to add collections to the database.

    • associated with the collection to add views on the collection. To create a view, you must specify:

      • The name of the view.

      • The pipeline to apply to the view.


        The view definition pipeline cannot include the $out or the $merge stage. If the view definition includes nested pipeline stages such as $lookup or $facet, this restriction applies to those nested pipelines as well.

      To learn more about views, see:

    • associated with the database, collection, or view to remove it.

  2. Select External from the dropdown in the Datasets section.

  3. Drag and drop the data store to map with the collection.

    Corresponds to databases.[n].collections.[n].dataSources JSON configuration setting.

←  Atlas ClusterGenerate Wildcard Collections →
Share Feedback
© 2023 MongoDB, Inc.


  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.