psql
Relyt supports the PostgreSQL connection protocol, which means any tools or software designed for connecting to PostgreSQL can also be used for Relyt connections.
This topic introduces how to connect to Relyt using psql -- a command line interface (CLI) that is built in PostgreSQL.
1. Install PostgreSQL
If PostgreSQL is already installed in your environment, skip this step. If not, download and install it from the official PostgreSQL website.
2. Connect to a Relyt database
In your CLI, run the following command:
psql -h <endpoint_domain> -p <endpoint_port> -U <dw_user_name> -d <db_name>
The following table describes related parameters.
| Parameter | Description |
|---|---|
| endpoint_domain | The public endpoint for connecting to the Relyt DW service unit. |
| endpoint_port | The port for connecting to the Relyt DW service unit. The default port is 5432. |
| dw_user_name | The name of the DW user that connects to the Relyt DW service unit. |
| db_name | The name of the Relyt database to connect. |
After the connection is established, you can interact with Relyt by using psql commands.