-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
26 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,46 @@ | ||
| --- | ||
| title: pgAdmin | ||
| excerpt: Connect to your Timescale database with pgAdmin | ||
| title: Integrate pgAdmin with Timescale Cloud | ||
| excerpt: Steps to connect to your Timescale Cloud service using pgAdmin | ||
| products: [cloud, mst, self_hosted] | ||
| keywords: [connect] | ||
| keywords: [integrate] | ||
| --- | ||
|
|
||
| # Connect to Timescale using pgAdmin | ||
| import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx"; | ||
|
|
||
| The `pgAdmin` tool is a feature-rich open-source administration and development platform for PostgreSQL. It is available for Chrome, Firefox, Edge, and | ||
| Safari browsers, or can be installed on Microsoft Windows, Apple macOS, or | ||
| various Linux flavors. | ||
| # Integrate pgAdmin with $CLOUD_LONG | ||
|
|
||
| For more information about `pgAdmin`, including download and installation | ||
| instructions, see [pgadmin.org][pgadmin]. | ||
| [pgAdmin][pgadmin] is a feature-rich open-source administration and development platform for PostgreSQL. It is available for Chrome, Firefox, Edge, and | ||
| Safari browsers, or can be installed on Microsoft Windows, Apple macOS, or various Linux flavors. | ||
|
|
||
| ## Before you begin | ||
|  | ||
|
|
||
| * Download and install `pgAdmin`. For the instructions to download and | ||
| install, see [pgadmin.org][pgadmin]. | ||
| This page explains how to integrate pgAdmin with your $SERVICE_LONG. | ||
|
|
||
| <Tabs label="Connect to Timescale with pgAdmin"> | ||
| ## Prerequisites | ||
|
|
||
| <Tab title="Timescale"> | ||
| <IntegrationPrereqs /> | ||
|
|
||
| <Procedure> | ||
|
|
||
| 1. Sign in to the [Timescale 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. Navigate to the `Operations` tab, and click `Reset password`. You can choose | ||
| your own password for the service, or allow Timescale to generate a | ||
| secure password for you. Take a note of your new password. | ||
| 1. Start `pgAdmin`. | ||
| 1. In the `Quick Links` section of the `Dashboard` tab, click `Add New Server`. | ||
| 1. In the `Register - Server` page go to the `General` tab. | ||
| 1. In the `Name` field, type a name for the server, and the description in the | ||
| `Comments` field. | ||
| 1. In the `Connection` tab, fill in the fields using the server name, database, | ||
| user name, port, and password for your Timescale service. For more | ||
| information about these settings, | ||
| see [the connection section][connection-details]. | ||
| 1. Click `Save` to save the configuratiosn that you set. | ||
|
|
||
| <Highlight type="note"> | ||
| If you configured your Timescale service to connect using [SSL | ||
| mode](https://docs.timescale.com/use-timescale/latest/security/strict-ssl/), | ||
| in the `Parameters` tab, set `SSL mode` to `Verify-Full`, and set the | ||
| location of the SSL root CA certificate to use. | ||
| </Highlight> | ||
|
|
||
| 1. Click `Save`. | ||
|
|
||
| <img class="main-content__illustration" | ||
| width={1375} height={944} | ||
| src="https://s3.amazonaws.com/assets.timescale.com/docs/images/pgadmin_timescale_cloud.webp" | ||
| alt="Connecting to Timescale using pgAdmin"/> | ||
|
|
||
| </Procedure> | ||
| - [Download][download-pgadmin] and install pgAdmin. | ||
|
|
||
| </Tab> | ||
| ## Connect pgAdmin to your $SERVICE_LONG | ||
|
|
||
| <Tab title="Self-hosted Timescale"> | ||
| To connect to $CLOUD_LONG: | ||
|
|
||
| <Procedure> | ||
|
|
||
| 1. Start `pgAdmin`. | ||
| 1. In the `Quick Links` section of the `Dashboard` tab, click `Add New Server`. | ||
| 1. In the `Register - Server` page go to the `General` tab. | ||
| 1. In the `Name` field, type a name for the server, and the description in the | ||
| `Comments` field. | ||
| 1. In the `Connection` tab, fill in the fields using the server name, database, | ||
| user name, port, and password for your Timescale service. For more | ||
| information about these settings, | ||
| see [the connection section][connection-details]. | ||
| 1. Click `Save` to save the configuratiosn that you set. | ||
|
|
||
| <img class="maincontent__illustration" | ||
| width={1375} height={944} | ||
| src="https://s3.amazonaws.com/assets.timescale.com/docs/images/pgadmin_self_hosted.webp" | ||
| alt="Connecting to Timescale using pgAdmin"/> | ||
| 1. **Start pgAdmin** | ||
| 1. **In the `Quick Links` section of the `Dashboard` tab, click `Add New Server`** | ||
| 1. **In `Register - Server` > `General`, fill in the `Name` and `Comments` fields with the server name and description, respectively** | ||
| 1. **Configure the connection** | ||
| 1. In the `Connection` tab, configure the connection using your [connection details][connection-info]. | ||
| 1. If you configured your $SERVICE_SHORT to connect using a [stricter SSL mode][ssl-mode], then in the `SSL` tab check `Use SSL`, set `SSL mode` to the configured mode, and in the `CA Certificate` field type the location of the SSL root CA certificate to use. | ||
| 1. **Click `Save`** | ||
|
|
||
| </Procedure> | ||
|
|
||
| </Tab> | ||
|
|
||
| </Tabs> | ||
|
|
||
| ## Settings in the `Connection` | ||
|
|
||
| This table provides the description and example values for the fields in the | ||
| `Connection` dialog. | ||
|
|
||
| |Setting|Example value|Description| | ||
| |-|-|-| | ||
| |Host name/address|`localhost`,`127.0.0.1` `postgresql.example.com`, `<REMOTE_HOST>.tsdb.cloud.timescale.com`|The fully qualified server name or IP address of your TimescaleDB server or the host name of your Timescale service.| | ||
| |Port|`5432`|The port number of the TimescaleDB server or the Timescale service.| | ||
| |Username|`postgres`, `tsdbadmin`|The user name you want to log in with. Use `tsdbadmin` for Timescale services| | ||
| |Password|*password*|The password for the account you are logging in with| | ||
| |Save password|*Toggle*|Enable if you don't want to enter the password each time you connect.| | ||
| |Maintenance database name|`postgres`, `tsdb`|This option is used to specify the initial database that pgAdmin connects to. The database name for a Timescale service is `tsdb`. You can also specify the name of the database to connect to.| | ||
| You have successfully integrated pgAdmin with $CLOUD_LONG. | ||
|
|
||
| [pgadmin]: https://www.pgadmin.org/ | ||
| [connection-details]: #settings-in-the-connection | ||
| [tsc-portal]: https://console.cloud.timescale.com/ | ||
| [download-pgadmin]: https://www.pgadmin.org/download/ | ||
| [connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ | ||
| [ssl-mode]: /use-timescale/:currentVersion:/security/strict-ssl/ |