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
- Download and install DBeaver.
Connecting to on-premise TimescaleDB using DBeaver
Start
DBeaver
.In the
Database
menu, clickNew Database Connection
.In the
Connect to a database
window, search forTimescaleDB
.Select
TimescaleDB
and clickNext
to continue.In the
Main
tab, type the details for your connection, including theHost
,Port
,Database
,Username
andPassword
. For more information about these settings, see the connection settings section.Click the
Test Connection
button to check if the connection is successful.Click the
Finish
button to connect to the database server. The server is listed in theDatabase Navigator
pane.
Connecting to Timescale Cloud with DBeaver
Sign in to the Timescale Cloud portal.
In the
Services
tab, find the service you want to connect to, and check it is marked asRunning
.Click the name of the service you want to connect to, and take a note of the
Host
,Port
,Database name
, andUsername
.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.
Start
DBeaver
.In the
Database
menu, clickNew Database Connection
.In the
Connect to a database
window, search forTimescaleDB
.Select
TimescaleDB
and clickNext
to continue.In the
Main
tab type the details for your connection, including theHost
,Port
,Database
,Username
andPassword
. 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 enableUse SSL
, setSSL mode
toverify-full
, and in theCA Certificate
field, type the location of the SSL root CA certificate to use.Click the
Test Connection
button to check if the connection is successful.Click the
Finish
button to connect to the database server. The server is listed in theDatabase Navigator
pane.
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.
Sign in to the Managed Service for TimescaleDB portal.
In the
Services
tab, find the service you want to connect to, and check it is marked asRunning
.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
, andPassword
.Start
DBeaver
.In the
Database
menu, clickNew Database Connection
.In the
Connect to a database
window, search forTimescaleDB
.Select
TimescaleDB
and clickNext
to continue.In the
Main
tab type the details for your connection, including theHost
,Port
,Database
,Username
andPassword
. For more information about these settings, see the connection settings section.Click the
Test Connection
button to check if the connection is successful.Click the
Finish
button to connect to the database server. The server is listed in theDatabase Navigator
pane.
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
.
Setting | Example value | Description |
---|---|---|
Host | localhost, postgresql.example.com, <REMOTE_HOST>.tsdb.cloud.timescale.com, <REMOTE_HOST>.timescaledb.io | The fully qualified server name. The host name of your Timescale Cloud service or Managed Service for TimescaleDB service. |
Port | 5432 | The port number of the TimescaleDB server, Timescale Cloud service or Managed Service for TimescaleDB service. |
Username | postgres, tsdbadmin | The user name you want to log in with. Use tsdbadmin for Timescale Cloud service and Managed Service for TimescaleDB service |
Password | password | The password for the database user you are connecting to. |
Save password locally | Check | Check this box if you don’t want to enter the password each time you connect. |
Database | tsdb, defaultdb | This option connects to the default database. The database name for Timescale Cloud service is tsdb and for Managed Service for TimescaleDB service is defaultdb . You can also specify the name of the database to connect to. |