Reference
Nodes
Resources
PostgreSQL

PostgreSQL Resource

The PostgreSQL Resource makes it easy to pull data out of a PostgreSQL-compatible database (opens in a new tab) and display or process it within Dynaboard.

Configuration Steps

  1. Find the connection parameters or the connection string for your database.
    • Connection strings follow the format postgresql://username:password@hostname:port/databaseName
  2. Fill in the required connection information in the resource properties panel.
    • Secret fields (e.g. passwords or certificates) require clicking the ✓ to the right of the field to save the input.
  3. It's recommended to always enable SSL.
  4. It may be also be required by your provider or DB admin to include additional SSL certificates.
    • If so, download and open the certificates in a text editor. Once open, copy the entire text of the file and paste it into the matching property field.
  5. If your database is behind a firewall (very common), you'll need to allow Dynaboard's outbound IP address (opens in a new tab).
  6. Click "Test connection" at the bottom of the panel to verify everything works!

Common Configuration Errors

  • If the connection errors after a while, you may not have configured the firewall rules properly.
  • A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'host': '0.0.0.0', 'port': '5432', 'database': 'postgres', 'username': 'postgres', 'useSSL': true, 'sslMode': 'required', 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject
Defaultundefined

A profile of this resource for an environment

Host

Propprofiles[].host
Typestring
Defaultundefined

Hostname or IP address to use for the connection. E.g. this-entire-string.is-the-hostname.com

Port

Propprofiles[].port
Typestring
Defaultundefined

Port to use for the connection.

Database

Propprofiles[].database
Typestring
Defaultundefined

The database name to use for the connection.

Username

Propprofiles[].username
Typestring
Defaultundefined

The username to use for the connection.

Password

Propprofiles[].password
Type({ ref: string } | undefined)
Defaultundefined

The password to use for the connection.

Use SSL

Propprofiles[].useSSL
Typeboolean
Defaultundefined

Disable to remove SSL encryption. Not recommended to disable.

SSL Mode

Propprofiles[].sslMode
TypeSSLMode ('required' | 'verify-ca' | 'verify-full')
Defaultundefined

SSL Mode

SSL Certificate Authority

Propprofiles[].sslCA
Type({ ref: string } | undefined)
Defaultundefined

CA (root certificate) to use for the SSL connection.

SSL Client Private Key

Propprofiles[].sslKey
Type({ ref: string } | undefined)
Defaultundefined

Client private key to use for the SSL connection.

SSL Client Certificate

Propprofiles[].sslCert
Type({ ref: string } | undefined)
Defaultundefined

Client certificate to use for the SSL connection.

Environment

Propprofiles[].environment
Typestring
Defaultundefined

The name of the environment with which this profile is associated

Actions

Perform SQL Query

Performs a SQL query on the PostgreSQL database.

ParameterTypeDefault
querystringundefined