PostgreSQL

PostgreSQL Start Guide

1. Connections

Connection example:

{
  "name": "PGSQL",
  "server": "localhost",
  "driver": "PostgreSQL",
  "port": 5433,
  "database": "test_db",
  "username": "root",
  "askForPassword": false,
  "password": "root",
  "connectionTimeout": 15
}

1.1 Specific Options

PostgreSQL driver specific options can be passed using pgOptions settings.

{
  "name": "PGSQL",
  "server": "localhost",
  "driver": "PostgreSQL",
  "port": 5433,
  "database": "test_db",
  "username": "root",
  "askForPassword": false,
  "password": "root",
  "connectionTimeout": 15,
  "pgOptions": {
    ... // options
  }
}

You can use any options defined in https://node-postgres.com/features/connecting#programmatic in pgOptions.

They will be passed to the pool constructor directly. See https://github.com/mtxr/vscode-sqltools/blob/master/packages/core/driver/pgsql/index.ts .

SSL Options

Example: Azure Postgres

This example enables SSL for connecting to an Azure Postgres instance.

{
    "name": "PGSQL",
    "server": "HOSTNAME.postgres.database.azure.com",
    "driver": "PostgreSQL",
    "port": 5432,
    "database": "dbnamehere",
    "username": "username@hostname",
    "askForPassword": false,
    "password": "password",
    "connectionTimeout": 15,
    "pgOptions": {
        "ssl": "true"
    }
}

You can get more information about SSL connections here: https://node-postgres.com/features/ssl. Also try to edit your connection using the connection assitant, it has a lot of descriptions for the properties you may need.

1.2 Alternative Connection Strings

ConnectionStrings or connectionURIs are supported as defined in node-postgres library. See Connection URI for more information.

Using a connectionURI for the same configurations from the previous example:

{
  "name": "PGSQL",
  "server": "localhost",
  "driver": "PostgreSQL",
  "connectString": "postgresql://root:root@localhost:5433/test_db",
  "askForPassword": false,
  "connectionTimeout": 15
}