Create a PostgreSQL connection

Stay organized with collections Save and categorize content based on your preferences.

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The PostgreSQL Connector type lets you insert, read, update and delete rows in a PostgreSQL database and use the resulting output in an integration. This page provides a reference for configuring a PostgreSQL connection and using the PostgreSQL connection with Apigee Integration.

Before you begin

Supported PostgreSQL versions: 7.4 and later

Before creating a PostgreSQL connection, do the following in your Google Cloud project:

  • Grant the following roles to the service account that you want to use to create the connection:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor
  • Enable the following services:
    • apigee.googleapis.com (Apigee API)
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connector Platform API)

    If these services have not been enabled for your project previously, you are prompted to enable them when creating the connection in the Create Connection page.

Create a connection

  1. In the Cloud console, go to Apigee > Connectors page and select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. Configure the connection:
    1. In the Create Connection section, complete the following:
      • Connector: Select PostgreSQL from the drop down list of available Connectors.
      • Connector version: Select the Connector version from the drop down list of available versions.
      • In the Connection 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 63 characters.
      • Optionally, add a Description of the connection instance.
      • Service Account: Select a service account that has the required roles.
      • Databsase Name: Enter the database to connect.
      • Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
      • Click NEXT.
    2. Destinations: Enter details of the remote host (backend system) you want to connect.
      • Destination Type: You can specify the destination details either as a host address or a service attachment. Select any of the following destination types:
        • Host address: If you want to specify the hostname or IP address of the destination.
        • Service attachment: If you want to specify the private endpoint for your internal IP addresses. The service attachment, lets you hide your internal IP addresses from the external network. You can create a service attachment in Google Cloud, by using the Private Service Connect feature. For information on configuring a Private Service Connect, see Publish managed services.

        Based on your selection of destination type, enter the host address or the service attachment name.

      • To enter additional destinations, click +ADD DESTINATION.
      • Click NEXT.
    3. Location: Choose the location for the connection.
      • Select a location where Apigee is available from the Region drop-down list.

        Supported regions for connectors include:

        • asia-east1
        • asia-northeast1
        • asia-south1
        • asia-southeast1
        • australia-southeast1
        • europe-west1
        • europe-west2
        • europe-west3
        • europe-west4
        • europe-west6
        • northamerica-northeast1
        • southamerica-east1
        • us-central1
        • us-east1
        • us-east4
        • us-west1
        • us-west2
      • Click NEXT.
    4. Authentication: For PostgreSQL connections, you can provide credentials in the form of a User and Password combination. To configure authentication using a User and Password combination, enter the following information:
      • Username: Enter the PostgreSQL username for the connection.
      • Password: Enter the Secret Manager secret containing the password associated with the PostgreSQL username.
        • If you have previously created a secret, and it is not available in the drop down list, select DON'T SEE YOUR SECRET? ENTER SECRET RESOURCE ID. In the Add a secret by resource ID dialog, copy and paste the resource ID from the Secret Manager.
          • To use the latest version, copy and paste the resource ID from the parent secret, in the format: "projects/project-number/secrets/secret-name"
          • To select a specific version, copy and paste the resource ID for that specific version, in the format "projects/project-number/secrets/secret-name/versions/1"

          Click ADD SECRET to add the secret and close the dialog.

        • If you have not created a secret for use with PostgreSQL, click ADD A NEW SECRET. In the Create Secret dialog enter the following details:
          • Name: Enter the secret name.
          • Secret value: Enter the contents of the secret.
          • Optionally, click + ADD LABEL to add a label in the form of a key/value pair.
      • Secret version: Select the version of the Password secret from the list of available versions in the drop-down.
      • Click NEXT.
    5. Review: Review your connections's configuration details. In this section, the Connection details and Authentication details of the new connection are displayed for your review.
  4. Click Create.

Create a Connectors task

After you create a PostgreSQL connection, it becomes available in Apigee integrations. You can then use the connection to configure the Connectors tasks in your integrations. For more information, see Configure the Connectors task.