pgvecto.rs

Appearance

Connecting with psql ​

The following instructions require a working installation of psql. The psql client is the native command-line client for Postgres. It provides an interactive session for sending commands to Postgres and running ad-hoc queries. For more information about psql, refer to the psql reference, in the PostgreSQL Documentation.

WARNING

Cluster instance runs Postgres, which means that any Postgres application or standard utility such as psql is compatible with PGVecto.rs Cloud. You can also use Postgres client libraries and drivers to connect. However, please be aware that some older client libraries and drivers, including older psql executables, are built without Server Name Indication (SNI) support and require a workaround.

The easiest way to connect to PGVecto.rs Cloud using psql is to use a connection endpoint. You can obtain a connection endpoint from the cluster details on the dashboard.

We provide two types of connection endpoints:

  • Super User Endpoint: This connection string is used to connect to the cluster as a superuser(postgres). You can use this connection string to create databases, users, and manage the cluster.
  • Vector User Endpoint: This connection string is used to connect to the cluster as a vector user. You can use this connection string to store and query vector data.

If Enable Connection Pooler is selected when create cluster, you can get the pooler connection endpoint via clicking the Show Pooler Endpoint button.

From your terminal or command prompt, run the psql client with the connection endpoint copied from the Dashboard.

shell
$ psql postgres://[user]:[password]@[hostname]/[dbname]

WARNING

PGVecto.rs Cloud requires that all connections use SSL/TLS encryption, but you can increase the level of protection by appending an sslmode parameter setting to your connection string.