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

Find the connection parameters or the connection string for your database.
- Connection strings follow the format postgresql://username:password@hostname:port/databaseName
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.
It's recommended to always enable SSL.
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.
If your database is behind a firewall (very common), you'll need to allow Dynaboard's outbound IP address (opens in a new tab).
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

Prop	`profiles`
Type	`array`
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

Prop	`profiles[]`
Type	`object`
Default	`undefined`

A profile of this resource for an environment

Host

Prop	`profiles[].host`
Type	`string`
Default	`undefined`

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

Port

Prop	`profiles[].port`
Type	`string`
Default	`undefined`

Port to use for the connection.

Database

Prop	`profiles[].database`
Type	`string`
Default	`undefined`

The database name to use for the connection.

Username

Prop	`profiles[].username`
Type	`string`
Default	`undefined`

The username to use for the connection.

Password

Prop	`profiles[].password`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

The password to use for the connection.

Use SSL

Prop	`profiles[].useSSL`
Type	`boolean`
Default	`undefined`

Disable to remove SSL encryption. Not recommended to disable.

SSL Mode

Prop	`profiles[].sslMode`
Type	`SSLMode ('required' \| 'verify-ca' \| 'verify-full')`
Default	`undefined`

SSL Mode

SSL Certificate Authority

Prop	`profiles[].sslCA`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

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

SSL Client Private Key

Prop	`profiles[].sslKey`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

Client private key to use for the SSL connection.

SSL Client Certificate

Prop	`profiles[].sslCert`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

Client certificate to use for the SSL connection.

Environment

Prop	`profiles[].environment`
Type	`string`
Default	`undefined`

The name of the environment with which this profile is associated

Actions

Perform SQL Query

Performs a SQL query on the PostgreSQL database.

Parameter	Type	Default
`query`	`string`	`undefined`

OpenID Connect Python Server