Workiva Support Center

With the Postgres connector, you can use commands in a chain to perform structured query language (SQL) operations in PostgreSQL database systems, such as Amazon® Aurora®. For example, with this connector, you can:

• Execute SQL commands, including a CREATE or UPDATE statement or SELECT query
• Retrieve details about a table in a PostgreSQL database
• Insert records into a PostgreSQL database

Prerequisites

To enable the connection to the PostgreSQL database, the connector uses Java database connectivity (JDBC), secured with basic username and password authentication. To set up the connector, you'll need:

• A designated integration user created in the database for the connector
• The integration user's username and password
• The JDBC connection's URL, such as jdbc:postgresql://localhost:5432/sample
• To connect to an on-premise database, a GroundRunner for the connection

Note: To connect to a cloud PostgreSQL database, use the default CloudRunner.

Set up the Postgres connector

Note: To make the connector available for use in your organization's chains, an org security administrator first enables it from Configuration.

1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
2. Under Connector Connection, select Postgres and the runner to use with the connection.
   
3. Under Basic Info, enter a unique name and description to help identify the connection.
4. Under Properties, enter the connector's details:
   
   

   Property	Details
   Username	Enter the username of the connector's integration user.
   Password	Enter the password for the Username property.
   Connection URL	Enter the URL for the JDBC connection, such as jdbc:postgresql://<server>:<port>/<database>. To include optional properties for the connection, append them as a query string, such as jdbc:postgresql://localhost:5432/sample?<options>. For example, to establish a Secure Sockets Layer (SSL) connection, append ?ssl=true. Note: By default, the port is 5432; however, this may be different for your environment.

   Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption. For security purposes, avoid including user credentials as optional properties within the Connection URL property.

5. Select the environments to use with the connection, and click Save.
6. To test the connection, create and run a chain with the connector's Get Table Definition command, and verify it returns a valid output.

Troubleshooting

If the connection to the PostreSQL database fails:

• • Verify the integration user's authentication credentials.
  • Check the URL for the JDBC connection, including its server and port.
  • If connecting to an on-premise database, check the GroundRunner selected for the connector.

  If the connection fails to perform a command, verify its inputs—such as its SQL syntax or table—are valid.