How to use IBM App Connect with PostgreSQL

PostgreSQL is an open source object-relational database system that runs on numerous operating systems and securely stores and manages complex data workloads.

Availability:
  • App Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.9.0-r3 or later
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release)

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to PostgreSQL

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your PostgreSQL administrator to obtain these values.

PostgreSQL authorization types and connection fields:
Connection field Description
Database hostname The fully qualified hostname or the IP address of the PostgreSQL database. For example, myserver.abc.com or 192.0.2.24.
Database port The port used by the PostgreSQL database to listen for incoming client connections.
Database name The name of the PostgreSQL database you are connected to.

For more information, see Managing Databases on the PostgreSQL documentation page.
Username The username to access your PostgreSQL database account.
Password The password to access your PostgreSQL database account.
Schema (optional) The schema qualifier for the database objects to be accessed. Schema defaults to username if not specified.

For more information, see Schemas on the PostgreSQL documentation page.
Maximum pool size (optional) The maximum number of connections allowed within a single connection pool; defaults to 0 (zero) if unspecified.
Additional parameters (optional) Name or value pairs of additional parameters in the format name1=value1;name2=value2. Some database types require specific parameters; for more information see https://ibm.biz/ac2postgresql.
Private network connection (optional) Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created on the Private networks page. For more information, see Connecting to a private network.

To connect to a PostgreSQL endpoint from the App Connect Designer Catalog page for the first time, expand PostgreSQL, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with PostgreSQL, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

PostgreSQL events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.

PostgreSQL actions

Your flow completes these actions on this application.

Available items are listed when you have connected App Connect to PostgreSQL.