Docs Menu
Docs Home
/
MongoDB Atlas
/
Query Federated Data
/
SQL
/
SQL Tutorials

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.

1

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

2

Install JDBC Driver

  1. Download the latest MongoDB JDBC Driver version.

  2. Verify the integrity of the downloaded package:

    The MongoDB release team digitally signs all software packages to certify that a particular MongoDB package is a valid and unaltered MongoDB release. MongoDB signs each release branch with a different PGP key in .asc format.

    1. Run the following command to download the .asc file from the Maven Central Repository.

      curl -O https://repo1.maven.org/maven2/org/mongodb/mongodb-jdbc/2.1.2/mongodb-jdbc-2.1.2.jar.asc

    2. Run the following command to download then import the key file. Replace {server_url} with one of the current GPG key servers supported by Maven:

      • keyserver.ubuntu.com

      • keys.openpgp.org

      • pgp.mit.edu

      gpg --keyserver {server_url} --recv-keys 91A2157730666110
      gpg: key 91A2157730666110: public key "Huan Li <huan.li@10gen.com>" imported
      gpg: Total number processed: 1
      gpg:               imported: 1

    3. Run the following command to verify the MongoDB JDBC Driver installation file.

      gpg --verify mongodb-jdbc-2.1.2.jar.asc mongodb-jdbc-2.1.2.jar

      GPG should return a response similar to the following:

      gpg: Signature made Wed May 22 13:24:36 2024 MDT
      gpg:                using RSA key 91A2157730666110
      gpg: Good signature from "Huan Li <huan.li@10gen.com>"

      If the package is properly signed, but you don't yet trust the signing key in your local trustdb, gpg will also return the following message:

      gpg: WARNING: This key is not certified with a trusted signature!
      gpg:          There is no indication that the signature belongs to the owner.
      Primary key fingerprint: D2C4 5B7E 66A5 DCA1 8B76  57A8 91A2 1577 3066 6110

      If you receive the following error message, confirm that you imported the correct public key:

      gpg: Can't check signature: public key not found

Connect to Your Federated Database Instance

To connect to your federated database instance from DBeaver:

1

In Atlas, go to your 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.

2

Click Connect to open the federated database instance connection modal.

3

Select Atlas SQL.

4

Select JDBC Driver.

Note

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

5

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.

6

Connect from DBeaver.

  1. Launch DBeaver.

  2. Add a new driver.

    1. In DBeaver, click Database and select Driver Manager from the dropdown menu.

    2. Click New to open the Create new driver modal.

    3. In the Settings tab, enter the following information:

      Driver Name

      MongoDB

      Class Name

      com.mongodb.jdbc.MongoDriver

    4. In the Libraries tab, click Add File and add your JDBC driver all.jar file.

      Click Find Class.

    5. Click OK. The Create new driver modal closes.

  3. Create a database connection.

    1. In DBeaver, click Database and select New Database Connection from the dropdown menu to open the Connect to a database modal.

    2. From the list of databases, select the MongoDB database driver that you created in the previous step.

      If you don't see MongoDB, select the All category inside the modal.

      Click Next.

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

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

  4. Click Finish.

7

(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:

1

Expand your MongoDB connection.

The DBeaver Database Navigator displays your virtual databases.

2

Open a SQL console.

  1. Right-click the virtual database you want to query.

  2. Select SQL Editor.

  3. Select Open SQL console.

    A new SQL console window opens connected to the virtual database you selected.

3

Enter a SQL query in the console.

4

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.

Back

SQL Tutorials

Next

Errors