Connect to and Query Data with Free SQL Tools

This tutorial guides you through connecting to a federated database instance with the free tools MongoDB JDBC Driver and DBeaver (Community Edition).

If you followed the Advanced Configuration guide, this tutorial also guides you through querying sample data.

Install Client Software

Install the following client software to connect to and query your data with Atlas SQL.

Install DBeaver

DBeaver is a free, universal database tool. You can use it to explore your sample data in this tutorial. Download and install DBeaver (Community Edition).

Install JDBC Driver

Download the latest MongoDB JDBC Driver version from the MongoDB download center if you haven't already.

Connect to Your Federated Database Instance

To connect to your federated database instance from DBeaver:

Navigate to your federated database instance.

If it isn't already displayed, select Data Federation from the left navigation panel.

Click Connect to open the federated database instance connection modal.

Select Connect using the Atlas SQL Interface.

Select JDBC Driver.

Note

This tutorial uses the JDBC Driver to connect. See Connect Using the Atlas SQL Interface for alternative connection methods.

Copy your connection information.

Atlas Data Federation provides a connection string to connect to your federated database instance. You'll need this in a later step.

Connect from DBeaver.

Launch DBeaver.

Add a new driver.

In DBeaver, click Database and select Driver Manager from the dropdown menu.
Click New to open the Create new driver modal.

In the Settings tab, enter the following information:


Driver Name	`MongoDB`
Class Name	`com.mongodb.jdbc.MongoDriver`

In the Libraries tab, click Add File and add your JDBC driver all.jar file.
Click Find Class.
Click OK. The Create new driver modal closes.

Create a database connection.

In DBeaver, click Database and select New Database Connection from the dropdown menu to open the Connect to a database modal.
From the list of databases, select the MongoDB database driver that you created in the previous step.
Tip
If you don't see MongoDB, select the All category inside the modal.
Click Next.
In the Main tab, enter the following information:
JDBC URL
Your connection string from step 5.
Username
The MongoDB user to connect with.
Password
The MongoDB user's password.


JDBC URL	Your connection string from step 5.
Username	The MongoDB user to connect with.
Password	The MongoDB user's password.

In the Driver properties tab, expand User Properties. Add the following key-value properties:


database	The name of your virtual database.
user	The MongoDB user to connect with. Not required if you entered a `Username` in the previous step.
password	The MongoDB user's password. Not required if you entered a `Password` in the previous step.

Click Finish.

(Optional) Confirm that you can access your federated database instance data.

In the Database Navigator, expand your MongoDB connection to verify that the federated database instance store mapped to your data is accessible.

To learn more about the different methods you can use to connect to a federated database instance, see Connect Using the Atlas SQL Interface.

Run Atlas SQL Queries

To run Atlas SQL queries in DBeaver:

Expand your MongoDB connection.

The DBeaver Database Navigator displays your virtual databases.

Open a SQL console.

Right-click the virtual database you want to query.
Select SQL Editor.
Select Open SQL console.
A new SQL console window opens connected to the virtual database you selected.

Enter a SQL query in the console.

Click Execute SQL Statement to run your SQL query.

If the query is successful, Atlas SQL displays the results in a table view below your query.

Example Atlas SQLQueries

If you followed the Advanced Configuration guide using sample data, try running the following Atlas SQL queries against the sample data in your federated database instance.

Otherwise, you can modify these example queries for your namespaces.

SELECT Statement

SELECT *
FROM Sessions

Atlas SQL returns all documents from the Sessions collection.

LIMIT Statement

SELECT *
FROM Users
LIMIT 2

Atlas SQL returns two documents from the Users collection.

WHERE Statement

SELECT *
FROM Users
WHERE name = 'Jon Snow'

Atlas SQL returns documents from the Users collection where the user's name is Jon Snow.

For an Atlas SQL command reference, see Atlas SQL Language Reference.

← Tutorials Atlas SQL Language Reference →