Docs Menu
Docs Home
/
MongoDB Atlas
/
Query Federated Data
/
SQL
/
Enable the Interface

Quick Start

On this page

  • Prerequisites
  • Enable Atlas SQL for Your Cluster Data
  • Next Steps

This page guides you through enabling the Atlas SQL Interface quickly. If you follow the Quick Start steps, it results in an Atlas SQL-specific federated database instance that maps to data on the cluster that you used to enable Atlas SQL. You cannot modify this federated database instance, but you can delete it.

Prerequisites

  • Any Atlas cluster running MongoDB version 5.0 or higher and containing data. You can use your own data or import MongoDB sample data.

  • A MongoDB database user with which to connect.

Enable Atlas SQL for Your Cluster Data

To enable the Atlas SQL Interface with an Atlas-managed federated database instance:

1

In Atlas, go to the Clusters page for your project.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If it's not already displayed, click Clusters in the sidebar.

    The Clusters page displays.

2

On the deployment you want to query with SQL, connect with Atlas SQL.

Click the Connect link at the bottom of your deployment card, under Atlas SQL.

A connection dialog box opens.

3

Select Quick Start.

4

Click Create to create an Atlas SQL connection for your cluster.

Atlas creates and manages a federated database instance in the background to support the SQL connection.

To view or delete the federated database instance created with Quick Start:

In Atlas, go to the federated database instance for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Data Federation under the Services heading.

    The Data Federation page displays.

5

From the Select your driver dropdown, select a driver.

6

Select a database and copy your connection settings.

Select a database from the Database dropdown.

Save your connection information. You'll need this in a later step.

Next Steps

You have now successfully enabled Atlas SQL on a federated database instance that maps data on the database in the Atlas cluster that you specified.

To connect to this federated database instance and query your data with Atlas SQL, see Connect.

Back

Enable the Interface

Next

Advanced Configuration