DBeaver

DBeaver is a desktop SQL client. Use this page to connect it to your DataMind OS data: you download a connection file from the Universe page, import it into DBeaver and sign in with your DataMind OS email and password.

Download the connection file

  1. In the sidebar, click Universe.
  2. In the Integrations section, find the DBeaver tile.
  3. Click Configuration. Your browser downloads the file as db-beaver-config.json, and a Download successful message confirms it.
  4. Save the file on your computer.
Note

Use a computer. The Universe page is not available on phones.

Import the file into DBeaver

These steps happen in DBeaver, not in DataMind OS.

  1. Import the downloaded file as a connection. DBeaver's own help explains how to import a connection file in your version.
  2. Open the connection that the import added, and connect.
  3. When DBeaver asks for a user name and password, enter your DataMind OS email address as the user name and your DataMind OS password as the password.

The import adds one connection, with the address and port filled in. The file holds no user name, no password and no email address, so DBeaver asks for them when you connect.

If your version of DBeaver cannot import the file, create the connection by hand. Use the Host and Port shown in Connection settings, choose ClickHouse as the database type, and enter your DataMind OS email address and password.

What the file sets

The file sets these values when DBeaver imports it.

SettingWhat it doesDefault
Read-onlyThe connection reads data only. You cannot change data from DBeaver.On
Save passwordDBeaver can remember the password you type.On
Close idle connectionsThe connection closes when it is idle.On
Socket timeoutHow long the connection waits for the server to send data.5 minutes
EncryptionWhether the connection uses encryption.On when the server uses HTTPS, otherwise off

Who can download the file

Any signed-in user can download the DBeaver file. The file holds no sign-in details, so a colleague can import the same file and sign in with their own DataMind OS account.

The data you see in DBeaver depends on your roles, the same as in the Editor. See Roles and permissions and SQL dialect and data scope.

Limits and edge cases

Questions, answered

Which user name and password does DBeaver ask for?

Your DataMind OS email address and your DataMind OS password. These are the same sign-in details the other desktop tools use. See Connection settings.

Can I change data from DBeaver?

No. The connection is read-only, so you can run queries but you cannot change data from DBeaver.

Is the file personal?

No. It holds the server address, the port and the connection settings, with no email address and no password. A colleague can import the same file and sign in with their own DataMind OS account.

Do I need to set up encryption?

No. When DataMind OS runs with encryption, the file turns encryption on for the connection.

Why does the connection close when it is idle?

The file tells DBeaver to close idle connections, so the connection closes when it is idle. Reconnect in DBeaver before you run your next query.

Which database is selected when I connect?

None. The file does not select a database, so browse the databases in DBeaver after you connect.

What do I do if the download fails?

Click Configuration on the DBeaver tile again. If it fails again, read the message DataMind OS shows, then follow Troubleshooting integrations. To connect without the file, use the values in Connection settings.