Skip to content

Commit

Permalink
[update] Connect using DBeaver (github#1435)
Browse files Browse the repository at this point in the history 
* added dbeaver instructions

* fixed the link text

* included the links to cloud and mst

* fixed a typo

* updated the image link

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Lana Brindley <github@lanabrindley.com>

* unspaced the table

* fixed link issues

* Update timescaledb/how-to-guides/connecting/dbeaver.md

Co-authored-by: Attila Tóth <hello@attilatoth.dev>

* Incorporated suggestions

* fixed the typo and format

Co-authored-by: Lana Brindley <github@lanabrindley.com>
Co-authored-by: Attila Tóth <hello@attilatoth.dev>
  • Loading branch information
@Rajakavitha1 @Loquacity @zseta
3 people authored Aug 17, 2022
1 parent 1706361 commit a55aa24
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 7 deletions.
116 changes: 110 additions & 6 deletions timescaledb/how-to-guides/connecting/dbeaver.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,119 @@
---
title: DBeaver
excerpt: Connect to your TimescaleDB database with DBeaver
product: mst, cloud, timescaledb
keywords: [connect]
---

# DBeaver
DBeaver is a free database tool that is available for Microsoft Windows, Apple
macOS, or various Linux flavors. You can also use it as a plugin to the Eclipse
IDE platform.
# Connect to TimescaleDB using DBeaver

For more information about DBeaver, including download and installation
instructions, see [dbeaver.io][dbeaver].
[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][dbeaver-downloads].

### Connecting to on-premise TimescaleDB using DBeaver

<procedure>

1. Start `DBeaver`.
1. In the `Database` menu, click `New Database Connection`.
1. In the `Connect to a database` window, search for `TimescaleDB`.
1. Select `TimescaleDB` and click `Next` to continue.
1. 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][connection-settings].
1. Click the `Test Connection` button to check if the connection is successful.
1. Click the `Finish` button to connect to the database server. The server is
listed in the `Database Navigator` pane.

<img class="maincontent__illustration"src="https://s3.amazonaws.com/assets.timescale.com/docs/images/on_premise_dbeaver.png"alt="Connecting to TimescaleDB using DBeaver"/>

</procedure>

### Connecting to Timescale Cloud with DBeaver

<procedure>

1. Sign in to the [Timescale Cloud portal][tsc-portal].
1. In the `Services` tab, find the service you want to connect to, and check
it is marked as `Running`.
1. Click the name of the service you want to connect to, and take a note
of the `Host`, `Port`, `Database name`, and `Username`.
1. **OPTIONAL**If 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.
1. Start `DBeaver`.
1. In the `Database` menu, click `New Database Connection`.
1. In the `Connect to a database` window, search for `TimescaleDB`.
1. Select `TimescaleDB` and click `Next` to continue.
1. 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][connection-settings].
1. Click the `Test Connection` button to check if the connection is successful.
1. Click the `Finish` button to connect to the database server. The server is
listed in the `Database Navigator` pane.

<img class="maincontent__illustration"src="https://s3.amazonaws.com/assets.timescale.com/docs/images/timescale_cloud_dbeaver.png"alt="Connecting to Timescale Cloud using DBeaver"/>

</procedure>

### Connecting to Managed Service for TimescaleDB with DBeaver

<highlight type="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](https://docs.timescale.com/mst/latest/security/).
</highlight>

<procedure>

1. Sign in to the [Managed Service for TimescaleDB portal][mst-portal].
1. In the `Services` tab, find the service you want to connect to, and check
it is marked as `Running`.
1. 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`.
1. Start `DBeaver`.
1. In the `Database` menu, click `New Database Connection`.
1. In the `Connect to a database` window, search for `TimescaleDB`.
1. Select `TimescaleDB` and click `Next` to continue.
1. 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][connection-settings].
1. Click the `Test Connection` button to check if the connection is successful.
1. Click the `Finish` button to connect to the database server. The server is
listed in the `Database Navigator` pane.

<img class="maincontent__illustration"src="https://s3.amazonaws.com/assets.timescale.com/docs/images/mst_dbeaver.png"alt="Connecting to Managed Service for TimescaleDB using Dbeaver"/>

</procedure>

## 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|This option connects to default database. The database name for Timescale Cloud service and Managed Service for TimescaleDB service is `tsdb`. You can also specify the name of the database to connect to.|

[dbeaver]: https://dbeaver.io/
[dbeaver-downloads]: https://dbeaver.io/download/
[connection-settings]: /timescaledb/:currentVersion:/how-to-guides/connecting/dbeaver/#connection-settings-in-connect-to-a-database
[tsc-portal]: https://console.cloud.timescale.com/
[mst-portal]: https://portal.managed.timescale.com
2 changes: 1 addition & 1 deletion timescaledb/how-to-guides/page-index/page-index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ module.exports = [
excerpt: "Install Azure Data Studio to connect to TimescaleDB",
},
{
title: "Install DBeaver",
title: "Connect using DBeaver",
href: "dbeaver",
tags: ["connect", "install", "timescaledb"],
keywords: ["TimescaleDB", "connect", "install"],
Expand Down

0 comments on commit a55aa24

Please sign in to comment.