Docs Menu

Connect from DBeaver

On this page

  • Prerequisites
  • Procedure
  • Run SQL Queries

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

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

  • DBeaver (Community Edition).
  • The MongoDB JDBC Driver.

To connect to your federated database instance from DBeaver:

1

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

2
3
4
Note

This tutorial uses the JDBC Driver to connect. See Connect for alternative connection methods.

5

Atlas Data Federation provides the following information to connect to your federated database instance:

  • URL
  • Port
  • Database

You'll need this information in a later step.

6
1
2
  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
  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.

    Tip

    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 JDBC URL 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 database from step 5. If you are following the tutorial, this is myFederatedVirtualDatabase.
    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
7

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

To run SQL queries in DBeaver:

1

The DBeaver Database Navigator displays your virtual databases.

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

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

Try running the following Atlas SQL queries against the Get Started sample federated database instance, or modify them to read your own data.

SELECT * FROM Sessions

Atlas SQL returns all documents from the Sessions collection.

SELECT * FROM Users LIMIT 2

Atlas SQL returns two documents from the Users collection.

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 SQL Reference.

←  Connect from JDBC DriverConnect from Tableau →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.