Docs Menu
Docs Home
/
MongoDB Atlas
/ / /

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.

  • 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.

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

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

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

  3. If the Clusters page is not already displayed, click Database in the sidebar.

2

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

A connection dialog box opens.

3
4

Note

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, select Data Federation from the left navigation panel. Your federated database instance appears under Quick Start Atlas SQL federated database instance. You cannot modify this federated database instance.

5
6

Select a database from the Database dropdown.

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

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.

← Enable the Atlas SQL Interface