PostgreSQL

借助 PostgreSQL 连接器类型,您可以在 PostgreSQL 数据库中插入、读取、更新和删除行。

支持的版本

PostgreSQL 版本 7.4 及更高版本

准备工作

在使用 PostgreSQL 连接器之前,请先完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号

    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

配置连接器

配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:

  1. Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表,请参阅位置

    2. 点击下一步
  4. 连接详情部分中,完成以下操作:
    1. 连接器:从可用连接器的下拉列表中选择 PostgreSQL
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 连接名称字段中,输入连接实例的名称。

      连接名称必须符合以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. (可选)输入连接实例的说明
    5. 您可以选择启用 Cloud Logging,然后选择日志级别。默认情况下,日志级别设置为 Error
    6. 服务账号:选择具有所需角色的服务账号。
    7. (可选)配置连接节点设置

      • 节点数下限:输入连接节点数下限。
      • 节点数上限:输入连接节点数上限。

      节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。

    8. 数据库名称:要连接到的 PostgreSQL 数据库的名称。
    9. 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
      • 代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
        • 基本:基本 HTTP 身份验证。
        • 摘要:摘要 HTTP 身份验证。
      • 代理用户:用于向代理服务器进行身份验证的用户名。
      • 代理密码:用户密码的 Secret Manager 密文。
      • 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
        • 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
        • 始终:连接始终启用 SSL。
        • 永不:连接未启用 SSL。
        • 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
      • 代理服务器部分中,输入代理服务器的详细信息。
        1. 点击+ 添加目标
        2. 选择目标类型
          • 主机地址:指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接,请执行以下操作:

    10. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    11. (可选)如果要使用 SSL,请选择启用 SSL。此时会显示 SSL 配置详细信息。
      1. 选择信任库类型。可以为公共专用不安全连接
      2. 根据您选择的信任库选择证书。
      3. 如果您使用的是 mTLS,请在密钥库部分中选择密钥库证书。
    12. 点击下一步
  5. 目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
    1. 目的地类型:选择目的地类型
      • 从列表中选择主机地址,以指定目标的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接,请从列表中选择端点连接,然后从端点连接列表中选择所需的端点连接。

      如果要与后端系统建立公共连接以提高安全性,您可以考虑为连接配置静态出站 IP 地址,然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      如需输入其他目标,请点击 + 添加目标

    2. 点击下一步
  6. Authentication(身份验证)部分中,输入身份验证详细信息。
    1. 选择身份验证类型,然后输入相关详细信息。

      PostgreSQL 连接支持以下身份验证类型:

      • 用户名和密码
    2. 如需了解如何配置这些身份验证类型,请参阅配置身份验证

    3. 点击下一步
  7. 查看:查看您的连接和身份验证详细信息。
  8. 点击创建

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码
    • 用户名:用于连接的 PostgreSQL 用户名。
    • 密码:包含与 PostgreSQL 用户名关联的密码的 Secret Manager Secret。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。

    但是,连接器可能不支持或不支持任何实体,在这种情况下, “Entities”列表将为空。

  • 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:

    从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则 Operations 列表中不会列出此类不受支持的操作。

  • 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作将具有一些输入参数和一个输出参数。但可能的情况是,连接器不支持任何动作,在这种情况下,Actions 列表将为空。

系统限制

PostgreSQL 连接器每秒可以处理 9 个事务, 每节点, 并throttles任何事务 。 默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。

如需了解适用于 Integration Connectors 的限制,请参阅限制

支持的数据类型

以下是此连接器支持的数据类型:

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

使用 Terraform 创建连接

您可以使用 Terraform 资源以创建新连接。

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

如需查看用于创建连接的 Terraform 模板示例,请参阅示例模板

使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:

参数名称 数据类型 必需 说明
database_name STRING True 要连接到的 PostgreSQL 数据库的名称。
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括:AUTO、ALWAYS、NEVER、TUNNEL

操作

此连接器支持执行以下操作:

  • 用户定义的存储过程和函数。如果您在后端有任何存储过程和函数,这些都会列出 在 Configure connector task 对话框的 Actions 列中。
  • 自定义 SQL 查询。为了执行自定义 SQL 查询,连接器提供执行自定义查询操作。

    如需创建自定义查询,请按照以下步骤操作:

    1. 按照详细说明添加连接器任务
    2. 配置连接器任务时,在要执行的动作类型中选择动作
    3. 操作列表中,选择执行自定义查询,然后点击完成

      此图片展示了 execute-custom-query-action 此图片展示了 execute-custom-query-action

    4. 展开任务输入部分,然后执行以下操作:
      1. 在以下时间后超时字段中,输入查询执行前要等待的秒数。

        默认值:180 秒。

      2. 最大行数字段中,输入要从数据库返回的最大行数。

        默认值:25

      3. 要更新自定义查询,请点击修改自定义脚本。系统随即会打开脚本编辑器对话框。

        此图片展示了 custom-sql-query 此图片展示了 custom-sql-query

      4. 脚本编辑器对话框中,输入 SQL 查询,然后点击保存

        您可以在 SQL 语句中使用问号 (?) 表示必须在查询参数列表中指定的单个参数。例如,以下 SQL 查询会选择 Employees 表中与为 LastName 列指定的值匹配的所有行:

        SELECT * FROM Employees where LastName=?

      5. 如果您在 SQL 查询中使用了问号,则必须点击 + 添加参数名称,针对每个问号添加参数。执行集成时,这些参数按顺序替换 SQL 查询中的问号 (?)。例如,如果您添加了三个问号 (?),那么必须按顺序添加三个参数。

        此图片展示了 add-query-param 此图片展示了 add-query-param

        如需添加查询参数,请执行以下操作:

        1. 类型列表中,选择参数的数据类型。
        2. 字段中,输入参数的值。
        3. 要添加多个参数,请点击 + 添加查询参数
        对于复杂查询,请使用 $1 而非 ?。 以下是使用 $1 的示例查询:
        SELECT
        od.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_discounts
        FROM
          order_details od
        LEFT JOIN
          order_items_details oid
        ON
          od.order_number = oid.order_number
        LEFT JOIN
          order_discount_details odd
        ON
          od.order_number = odd.order_number
        WHERE
          od.order_number = $1
        

操作示例

示例 - 找出较大的值

以下示例展示了如何执行用户定义的函数。find_greater 函数,它会比较两个整数并返回较大的整数。

  1. Configure connector task 对话框中,点击 Actions
  2. 选择 find_greater 操作,然后点击完成
  3. 连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
    "$1": 1.0,
    "$2": 5.0
    }
  4. 如果操作执行成功,则连接器任务的 connectorOutputPayload 字段的值类似于以下内容:

    [{
    "bignum": 5.0
    }]

实体操作示例

示例 - 列出实体的记录

此示例列出了 Users 实体的记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Users
  3. 选择 List 操作,然后点击完成
  4. 连接器任务的任务输入部分,您可以根据需要设置 filterClause

    例如,将过滤条件子句设置为 employeeCode='5100' and startDate='2010-01-01 00:00:00' 后,系统只会列出 employeeCode 为 5100 且 startDate 为 2010-01-01 00:00:00 的记录。

示例 - 从实体中获取单个记录

此示例会从 Users 实体中提取记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 User
  3. 选择 Get 操作,然后点击 完成
  4. 连接器任务的任务输入部分,点击 entityId,然后在默认值字段中输入 103032

    其中,103032Users 实体的主键值。

示例 - 从实体中删除记录

以下示例将从 Users 实体中删除一条记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Users
  3. 选择 Delete 操作,然后点击 完成
  4. 连接器任务的任务输入部分,点击 entityId 并 然后在 Default Value 字段中输入 113132

    或者,如果实体具有复合主键,您可以设置 filterClause,而不是指定 entityId。例如 employeeCode='5100' and startDate='2010-01-01 00:00:00'

示例 - 在实体中创建记录

此示例在 Users 实体中创建一条记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Users
  3. 选择 Create 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 connectorInputPayload,然后在 Default Value 字段:
    {
    "employeeCode": "5100",
    "startDate": "2010-01-01 00:00:00.0",
    "country": "US"
    }
  5. 如果集成成功,连接器任务的 connectorOutputPayload 字段将 拥有创建操作的响应。

示例 - 更新实体中的记录

此示例将更新 Users 实体中的一条记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Users
  3. 选择 Update 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 connectorInputPayload,然后在 Default Value 字段:
    {
    "country": "IN"
    }
  5. 连接器任务的任务输入部分,点击 entityId 并 然后在 Default Value 字段中输入 113132

    或者,如果实体具有复合主键,您可以设置 filterClause,而不是指定 entityId。例如 employeeCode='5100' and startDate='2010-01-01 00:00:00'

  6. 如果集成成功,连接器任务的 connectorOutputPayload 字段将 收到更新操作的响应。

在集成中使用 PostgreSQL 连接

创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以使用连接 通过连接器任务在集成中进行集成。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在应用集成中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤