Connect to TimescaleDB using DBeaver

DBeaver is a free and open source database tool that is available for Microsoft Windows, Apple macOS, and many Linux versions. DBeaver provides a powerful SQL editor, administration features, ability to migrate data and schema, and the ability to monitor database connection sessions. You can connect to TimescaleDB hosted on your local machine or on a remote server. You can also connect to Timescale Cloud, and Managed Service for TimescaleDB services.

Before you begin

Connecting to on-premise TimescaleDB using DBeaver

  1. Start DBeaver.

  2. In the Database menu, click New Database Connection.

  3. In the Connect to a database window, search for TimescaleDB.

  4. Select TimescaleDB and click Next to continue.

  5. In the Main tab, type the details for your connection, including the Host, Port,Database, Username and Password. For more information about these settings, see the connection settings section.

  6. Click the Test Connection button to check if the connection is successful.

  7. Click the Finish button to connect to the database server. The server is listed in the Database Navigator pane.

    Connecting to TimescaleDB using DBeaver

Connecting to Timescale Cloud with DBeaver

  1. Sign in to the Timescale Cloud portal.

  2. In the Services tab, find the service you want to connect to, and check it is marked as Running.

  3. Click the name of the service you want to connect to, and take a note of the Host, Port, Database name, and Username.

  4. OptionalIf you do not know the password for the service, navigate to the `Operations` tab, and click `Reset password`. You can choose your own password for the service, or allow Timescale Cloud to generate a secure password for you. Take a note of your new password.

  5. Start DBeaver.

  6. In the Database menu, click New Database Connection.

  7. In the Connect to a database window, search for TimescaleDB.

  8. Select TimescaleDB and click Next to continue.

  9. In the Main tab type the details for your connection, including the Host, Port,Database, Username and Password. For more information about these settings, see the connection settings section.

    note

    If you configured your Timescale Cloud service to connect using SSL mode ssl-mode, then in the SSL tab enable Use SSL, set SSL mode to verify-full, and in the CA Certificate field, type the location of the SSL root CA certificate to use.

  10. Click the Test Connection button to check if the connection is successful.

  11. Click the Finish button to connect to the database server. The server is listed in the Database Navigator pane.

    Connecting to Timescale Cloud using DBeaver

Connecting to Managed Service for TimescaleDB with DBeaver

important

To ensure a secure network access to your Managed Service for TimescaleDB service, make sure you add the IP address of the machine running DBeaver to the Allowed IP Addresses. For more information about network security in Managed Service for TimescaleDB, see the security section.

  1. Sign in to the Managed Service for TimescaleDB portal.

  2. In the Services tab, find the service you want to connect to, and check it is marked as Running.

  3. Click the name of the service you want to connect to see the connection information. Take a note of the Host, Port, Database Name, User, and Password.

  4. Start DBeaver.

  5. In the Database menu, click New Database Connection.

  6. In the Connect to a database window, search for TimescaleDB.

  7. Select TimescaleDB and click Next to continue.

  8. In the Main tab type the details for your connection, including the Host, Port,Database, Username and Password. For more information about these settings, see the connection settings section.

  9. Click the Test Connection button to check if the connection is successful.

  10. Click the Finish button to connect to the database server. The server is listed in the Database Navigator pane.

    Connecting to Managed Service for TimescaleDB using Dbeaver

Connection settings in Connect to a database

This table provides the description and example values for the fields that appear in the Main tab of Connection settings.

SettingExample valueDescription
Hostlocalhost, postgresql.example.com, <REMOTE_HOST>.tsdb.cloud.timescale.com, <REMOTE_HOST>.timescaledb.ioThe fully qualified server name. The host name of your Timescale Cloud service or Managed Service for TimescaleDB service.
Port5432The port number of the TimescaleDB server, Timescale Cloud service or Managed Service for TimescaleDB service.
Usernamepostgres, tsdbadminThe user name you want to log in with. Use tsdbadmin for Timescale Cloud service and Managed Service for TimescaleDB service
PasswordpasswordThe password for the database user you are connecting to.
Save password locallyCheckCheck this box if you don’t want to enter the password each time you connect.
Databasetsdb, defaultdbThis option connects to the default database. The database name for Timescale Cloud service is tsdband for Managed Service for TimescaleDB service is defaultdb. You can also specify the name of the database to connect to.