PostgreSQL

The PostgreSQL connector type lets you insert, read, update and delete rows in a PostgreSQL database.

Supported versions

PostgreSQL versions 7.4 and later

Before you begin

Before using the PostgreSQL connector, do the following tasks:

• In your Google Cloud project:
  • Ensure that network connectivity is set up. For information about network patterns, seeNetwork connectivity.
  • Grant theroles/connectors.admin IAM role to the user configuring the connector.
  • Grant the following IAM roles to the service account that you want to use for the connector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more information, seeCreating a service account.

  • Enable the following services:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    To understand how to enable services, seeEnabling services.

  If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

A connection is specific to a data source. Itmeans that if you have many data sources, you must create a separate connectionfor each data source. To create a connection, do the following:

1. In theCloud console, go to theIntegration Connectors > Connections page and then select or create a Google Cloud project.

   Go to the Connections page

2. Click+ Create new to open theCreate Connection page.
3. In theLocation section, choose the location for the connection.
   1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, seeLocations.

   2. ClickNext.
4. In theConnection Details section, complete the following:
   1. Connector: SelectPostgreSQL from the drop down list of available Connectors.
   2. Connector version: Select the Connector version from the drop down list of available versions.
   3. In theConnection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
   4. Optionally, enter aDescription for the connection instance.
   5. Optionally, enableCloud logging, and then select a log level. By default, the log level is set toError.
   6. Service Account: Select a service account that has therequired roles.
   7. Optionally, configure theConnection node settings:
      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

   Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
   8. Database Name: The name of the Postgresql database to connect to.
   9. (Optional) In theAdvanced settings section, select theUse proxy checkbox to configure a proxy server for the connection and configure the following values:
   • Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
     • Basic: Basic HTTP authentication.
     • Digest: Digest HTTP authentication.
   • Proxy User: A user name to be used to authenticate with the proxy server.
   • Proxy Password: The Secret manager secret of the user's password.
   • Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
     • Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
     • Always: The connection is always SSL enabled.
     • Never: The connection is not SSL enabled.
     • Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
   • In theProxy Server section, enter details of the proxy server.
     1. Click+ Add destination.
     2. Select aDestination Type.
        • Host address: Specify the hostname or IP address of the destination.

          If you want to establish a private connection to your backend system, do the following:

          • Create aPSC service attachment.
          • Create anendpoint attachment and then enter the details of the endpoint attachment in theHost address field.
   10. Optionally, click+ Add label to add a label to the Connection in the form of a key/value pair.
   11. Optionally, if you want to use SSL, selectEnable SSL. This displays the SSL configuration details.
       1. Select a trust store type. It can be eitherPublic,Private, orInsecure Connection.
       2. Select the certificates as displayed based on your trust store selection.
       3. If you are using mTLS, select the key store certificates in theKey Store section.
       Note:
       • All your certificates must be X.509 certificates and must be in PEM (Privacy Enhanced Mail) format.
       • You can't directly select a certificate when configuring SSL. You must store all your certificates and private keys as a Secret Manager Secret, and then select the required secret during SSL configuration.
   Note:
   Each of the above SSL options perform a different sslmode operation when negotiating the SSL connection to the PostGresql server:
   • Private -sslmode: verify-full - Hostname verification is rigorously performed. The server certificate is validated against the certificate authority (CA) root certificate, and the hostname specified in the SSL certificate is matched against the hostname used to establish the connection.
   • Public -sslmode: prefer - In this scenario, SSL encryption is requested but not mandatory. Hostname verification behavior may vary based on server configuration.
   • Insecure -sslmode: require - While SSL encryption is enforced, the server's SSL certificate might not undergo hostname verification. Although the connection is still encrypted, there may be a reduced level of assurance regarding the server's identity.
   12. ClickNext.
5. In theDestinations section, enter details of the remote host (backend system) you want to connect to.
   1. Destination Type: Select aDestination Type.
      • To specify the destination hostname or IP address, selectHost address and enter the address in theHost 1 field.
      • To establish a private connection, selectHost Address and add the endpoint attachment created for the SAP Gateway using the HTTPS protocol.
      Note:To understand how to create an endpoint attachment, seePSC service attachment andendpoint attachment. After you have created the endpoint attachment, it will be visible in theEndpoint Attachment list.

      If you want to establish a public connection to your backend systems with additional security, you can considerconfiguring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

      To enter additional destinations, click+Add destination.

   2. ClickNext.
6. In theAuthentication section, enter the authentication details.
   1. Select anAuthentication type and enter the relevant details.

      The following authentication types are supported by the PostgreSQL connection:

      • Username and password

   To understand how to configure these authentication types, seeConfigure authentication.

   2. ClickNext.
7. Review: Review your connection and authentication details.
8. ClickCreate.

Configure authentication

Enter the details based on the authentication you want to use.

• Username and password
  • Username: The Postgresql username to use for the connection.
  • Password: Secret Manager Secret containing the password associated with the Postgresql username.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects ofthe connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Note: You can view the entities, operations, and actions of a connector in theConnectors task.

• Entity:An entity can be thought of as an object, or a collection of properties, in theconnected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case theEntities list will be empty.

• Operation:An operation is the activity that you can perform on an entity. You can performany of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list ofoperations available for the entity. For a detailed description of the operations, see the Connectors task'sentity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in theOperations list.

• Action:An action is a first class function that is made available to the integrationthrough the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case theActions list will be empty.

Note:All entities and actions will have a schema associated with them. For example, an action schema will have the parameter details such as; the parameternames, and its corresponding data type. The schema (metadata) for entities and actions is fetched by the connection atruntime from your backend. If there are any updates to the schema, such updates won't be automatically reflected in your existing connections; you must manually refresh the schema. To refreshthe schema for a connection, open theConnection details page of the connection, and then clickRefresh connection schema.

System limitations

The PostgreSQL connector can process 9 transaction per second, pernode, andthrottles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, seeLimits.

Note: The number ofIntegration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

• If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
• If you are a subscription based customer,contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Supported data types

The following are the supported data types for this connector:

• BIGINT
• BINARY
• BIT
• BOOLEAN
• CHAR
• DATE
• DECIMAL
• DOUBLE
• FLOAT
• INTEGER
• LONGN VARCHAR
• LONG VARCHAR
• NCHAR
• NUMERIC
• NVARCHAR
• REAL
• SMALL INT
• TIME
• TIMESTAMP
• TINY INT
• VARBINARY
• VARCHAR

Create connections using Terraform

You can use theTerraformresource to create a new connection.

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands.

To view a sample terraform template for connection creation, seesample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
database_name	STRING	True	The name of the Postgresql database to connect to.
proxy_enabled	BOOLEAN	False	Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme	ENUM	False	The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user	STRING	False	A user name to be used to authenticate to the ProxyServer proxy.
proxy_password	SECRET	False	A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype	ENUM	False	The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Actions

This connector supports execution of the following actions:

• User-defined stored procedures and functions. If you have any stored procedures and functions in your backend, those are listed in theActions column of theConfigure connector task dialog.
• Custom SQL queries. To execute custom SQL queries, the connector provides theExecute custom query action.

  To create a custom query, follow these steps:

  1. Follow the detailed instructions to add a connectors task.
  2. When youconfigure the connector task, in the type of action you want to perform, selectActions.
  3. In theAction list, selectExecute custom query, and then clickDone.

     

  4. Expand theTask input section, and then do the following:
     1. In theTimeout after field, enter the number of seconds to wait till the query executes.

        Default value:180 seconds.

     2. In theMaximum number of rows field, enter the maximum number of rows to be returned from the database.

        Default value:25.

     3. To update the custom query, clickEdit Custom Script. TheScript editor dialog opens.

        

     4. In theScript editor dialog, enter the SQL query and clickSave.

        You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from theEmployees table that matches the values specified for theLastName column:

        SELECT * FROM Employees where LastName=?

        Note: Data manipulation language (DML) and data definition language (DDL) statements are supported.
     5. If you've used question marks in your SQL query, you must add the parameter by clicking+ Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

        

        To add query parameters, do the following:

        1. From theType list, select the data type of the parameter.
        2. In theValue field, enter the value of the parameter.
        3. To add multiple parameters, click+ Add Query Parameter.
        For a complex query, use $1 instead of ? in your query. The following is an example query that uses $1:

        SELECTod.order_number,od.total_amount,COALESCE(json_agg( json_build_object( 'item_name',      oid.item_name, 'item_quantity', oid.item_quantity,      'item_price', oid.item_price ) ) FILTER (WHERE  oid.order_number IS NOT NULL), '[]') AS order_items,  COALESCE(json_agg( json_build_object( 'discount_type',  odd.discount_type, 'discount_value', odd.discount_value ) ) FILTER (WHERE    oid.order_number IS NOT NULL), '[]') AS order_discountsFROM  order_details odLEFT JOIN  order_items_details oidON  od.order_number = oid.order_numberLEFT JOIN  order_discount_details oddON  od.order_number = odd.order_numberWHERE  od.order_number = $1

Action examples

Example - Find the greater value

This example shows how to execute a user-defined function. Thefind_greater function in this example, compares two integers and returns the integer which is greater.

1. In theConfigure connector task dialog, clickActions.
2. Select thefind_greater action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"$1":1.0,"$2":5.0}

If the action execution is successful, the connector task'sconnectorOutputPayload field will have a value similar to the following:

[{"bignum":5.0}]

Entity operation examples

Example - List records of an entity

This example lists the records of theUsers entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUsers from theEntity list.
3. Select theList operation, and then clickDone.
4. In theTask Input section of theConnectors task, you can set thefilterClause as per your requirement.

   For example, setting the filter clause toemployeeCode='5100' and startDate='2010-01-01 00:00:00', lists only those recordswhose employeeCode is 5100 and startDate is 2010-01-01 00:00:00.

Example - Get a single record from an entity

This example fetches a record from theUsers entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUser from theEntity list.
3. Select theGet operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId andthen enter103032 in theDefault Value field.

   Here,103032 is the primary key value of theUsers entity.

Example - Delete a record from an entity

This example deletes a record from theUsers entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUsers from theEntity list.
3. Select theDelete operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId andthen enter113132 in theDefault Value field.

   Alternately, if the entity has composite primary keys instead of specifying theentityId, you can set thefilterClause. For example,employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Example - Create a record in an entity

This example creates a record in theUsers entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUsers from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"employeeCode":"5100","startDate":"2010-01-01 00:00:00.0","country":"US"}

If the integration is successful, the connector task'sconnectorOutputPayload field will have the response of the create operation.

Example - Update a record in an entity

This example updates a record in theUsers entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectUsers from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"country":"IN"}

5. In theTask Input section of theConnectors task, clickentityId andthen enter113132 in theDefault Value field.

   Alternately, if the entity has composite primary keys instead of specifying theentityId, you can set thefilterClause. For example,employeeCode='5100' and startDate='2010-01-01 00:00:00'.

If the integration is successful, the connector task'sconnectorOutputPayload field will have the response of the update operation.

Use the PostgreSQL connection in an integration

After you create the connection, it becomes available in bothApigee Integration and Application Integration. You can use the connectionin an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, seeConnectors task.
• To understand how to create and use the Connectors task in Application Integration, seeConnectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloudcommunity atCloud Forums.

What's next

• Understand how tosuspend and resume a connection.
• Understand how tomonitor connector usage.
• Understand how toview connector logs.