Docs Menu
Docs Home
Docs Home
Docs Home

Connect from DBeaver

This page describes how to connect to your federated database instance with DBeaver.

Prerequisites

  • A federated database instance mapped to one or more data stores.

    Note

    If some or all of your data comes from an Atlas cluster, you must use MongoDB version 5.0 or greater for that cluster to take advantage of MongoSQL.

  • DBeaver (Community Edition).

  • The MongoDB JDBC Driver.

Procedure

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

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.

Run MongoSQL Queries

To run MongoSQL 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 that is connected to the virtual database you selected opens.

3

Enter a SQL query in the console.

For example queries, see Query with MongoSQL Statements.

4

Click Execute SQL Statement to run your SQL query.

If the query is successful, the results are displayed in a table view below your query.

On this page