CloudBeaver Documentation

DOWNLOAD pdf

Create Connection

Table of contents

Creating a new database connection

CloudBeaver provides multiple methods to set up a connection. To create a connection, do one of the following:

Use the new connection wizard

To establish a new connection, follow these steps:

  1. Initiate new connection:

    • Click the + button in the top menu.
    • Select New Connection from the dropdown options.

  2. Select the appropriate driver from the available options.

    Tip: If you cannot find a driver for your database, then probably there is no suitable driver, and you need to create one. Please see the Database Drivers article.

  3. Enter all necessary details in the form fields provided. For detailed steps on filling out these fields, refer to the section below.

  4. Test the connection (optional):

    • Click the Test button to ensure the connection parameters are correct.

  5. After confirming all details, click the Create button.

  6. Access and modify connection:

    • The new connection will appear in the connection navigator menu.
    • To edit the connection details, click the context button next to the connection name and choose Edit Connection.

Use the pre-configured connections

Access these connections through ${WORKSPACE}/GlobalConfiguration/.dbeaver/data-sources.json. They are always visible in the Database Navigator and are not editable, as they are managed by administrators.

Use the template connections

To use and adjust template connections, refer to the guide available in Connection templates management article.

Use the Cloud Explorer

Cloud connections are set up through your cloud service provider and automatically populated in your navigator tree, based on configurations managed by the server administrator. For a comprehensive guide on configuring and managing cloud connections, please refer to the Cloud Explorer article.

Configuring connection settings

In the New connection wizard, on the Main tab, you need to set all primary connection settings.

Here's what you typically need to configure:

Setting Description
Host The address of your database server.
Port The port number used to connect.
Database The name of the database you want to connect to.
Connection name A name you choose for this connection. It shows up in the Database Navigator.
Project Links the connection to a specific project. You can label it as "Shared" or "Private".
Description A short description of the connection.
Authentication Choose the type of authentication the database requires.
Save credentials An option to save your login details on your local machine for faster connections in the future.
Keep alive The time in seconds between signals sent to keep the connection open. Set this to 0 to disable automatic keep-alive.

However, the number and type of connection properties are very dependent on the driver.

Additional settings

When setting up a new connection, you may need to configure additional options:

Additional tab Description
Driver Properties Each driver has its own set of additional properties.
SSH Tunnel Configure an SSH tunnel if your database requires a secure connection.
SSL Enable and configure SSL if your connection requires encryption.

Tip: For secure database connections, store your SSH credentials in data-sources.json as follows:

  • SSH Key: Assign your SSH key to connections.configuration.handlers.ssh_tunnel.properties.keyValue.
  • SSH Username: Store your SSH username under connections.configuration.handlers.ssh_tunnel.user.

Manage access permissions

In the Community, Enterprise and AWS Editions, you can manage access permissions for a database:

  1. Initiate the creation of a new database connection as an administrator.
  2. Find the Project dropdown menu and select Shared project.
  3. Complete the necessary fields based on the selected type of credentials.

  4. Go to Access tab, click Edit, check the box next to their names and click the Add button.

To manage access permissions for a database, ensure the Enable private connections setting is configured correctly in the Server configuration settings:

  • If Enable private connections is turned on, switch the project mode to Shared from the dropdown menu of the Project settings to access the Access tab.
  • If Enable private connections is turned off, the Access tab is available by default.

Share credentials in Team Edition

In the Team Edition, you can share credentials with teams.

To create a shared connection, follow these steps:

  1. Start creating a new database connection.
  2. In the Authentication section, check the Share credentials with teammates checkbox.
  3. Select the required type of credentials.
  4. Navigate to the Credentials tab.
  5. In the Credentials tab, select the team with which you want to share the credentials.
  6. Fill in the necessary fields based on the selected type of credentials.