Oracle DB（版本 2）

借助 Oracle 数据库连接器，您可以连接到 Oracle 数据库（11.2 版或更高版本）实例并执行受支持的数据库操作。

准备工作

在使用 Oracle 数据库连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 将 IAM 角色 roles/connectors.admin 授予配置连接器的用户。
  • 将以下 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. 连接器：从可用连接器的下拉列表中选择 Oracle 数据库。
   2. 连接器版本：从可用版本下拉列表中选择版本 2。
   3. 在连接名称字段中，输入连接实例的名称。

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
   4. （可选）输入连接实例的说明。
   5. （可选）选择启用 Cloud Logging 以启用云日志记录。
   6. 服务账号：选择具有所需角色的服务账号。
   7. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. ServiceName：Oracle 数据库的服务名称。
   9. DataSource：Oracle Net Services 名称、连接描述符（也称为 TNS 连接字符串），或用于标识要连接的数据库的简单连接命名。
   10. （可选）选择包含同义词。
   11. Abandoned Connection Timeout（放弃连接超时）：输入超时值（以秒为单位），指定借用的连接在被视为放弃之前可以保持未使用状态的时间。
   12. 无效连接超时：输入连接超时值（以秒为单位）。
   13. Max Connection Reuse Time（最大连接重复使用时间）：输入连接重复使用时间（以秒为单位）。
   14. TTL Connection Timeout（TTL 连接超时）：输入连接保持使用状态的最长时间（以秒为单位）。
   15. 可浏览架构：输入要在提取实体和操作时使用的架构名称（以英文逗号分隔）。例如 schemaA, schemaB, schemaC。
   16. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   17. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意 ：如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将出现在端点连接列表中。

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

      要输入其他目标，请点击 + 添加目标。

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

      Oracle 数据库连接支持以下身份验证类型：

      • 用户名和密码

   如需了解如何配置这些身份验证类型，请参阅配置身份验证。

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

配置身份验证

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

• 用户名和密码
  • 用户名：用于身份验证的 Oracle 账号的用户名
  • 密码：包含与 Oracle 账号用户名关联的密码的 Secret Manager Secret。

实体、操作和动作

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

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

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

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

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • List（列出）
  • 获取
  • 创建
  • 更新
  • 删除

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

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

注意 ：所有实体和操作都具有与之关联的架构。例如，操作架构将包含参数详细信息（如参数名称）及其对应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新不会自动反映在现有连接中；您必须手动刷新架构。如需刷新连接的架构，请打开该连接的连接详情页面，然后点击刷新连接架构。

系统限制

Oracle 数据库连接器针对每个节点每秒最多可以处理 70 个事务，并对超出此限制的任何事务进行限制。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

注意：Integration Connectors 节点的数量将根据您的使用情况动态自动扩缩。但是，如果您想为大量卷预留容量，而不等待自动扩缩，则可以调整连接的最小节点值。需要更多节点才能为连接处理更多事务。相反，如果连接处理的事务较少，则所需的节点数量也会减少。如需配置节点值，请执行以下操作：

• 如果您是随用随付的客户，请在“修改连接”页面中配置最小和最大节点值。
• 如果您是订阅客户，请与支持团队联系。

节点可以处理的最大事务量取决于各种因素。因此，在调整节点数下限以获得更高的吞吐量之前，建议您检查后端系统的设置是否以处理所需流量为优化目标。

支持的数据类型

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

• BIGINT
• BINARY
• BIT
• BOOLEAN
• CHAR
• DATE
• DECIMAL
• DOUBLE
• FLOAT
• INTEGER
• 长 VARCHAR
• LONG VARCHAR
• NCHAR 编号
• NUMERIC
• NVARCHAR
• REAL
• 小范围
• 时间
• TIMESTAMP
• 小小的内侧
• VARBINARY
• VARCHAR

操作

借助 Oracle 数据库连接器，您可以使用 Oracle 数据库支持的格式执行存储过程、函数和自定义 SQL 查询。为了执行自定义 SQL 查询，连接器提供执行自定义查询操作。

要创建自定义查询，请按以下步骤操作：

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

   

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

      默认值：180 秒。

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

      默认值为 25。

   3. 要更新自定义查询，请点击修改自定义脚本。此时将打开脚本编辑器对话框。

      

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

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

      SELECT * FROM Employees where LastName=?

      注意：支持数据操纵语言 (DML) 和数据定义语言 (DDL) 语句。
   5. 如果您在 SQL 查询中使用了问号，则必须为每个问号点击 + 添加参数名称以添加参数。执行集成时，这些参数会依序替换 SQL 查询中的问号 (?)。例如，如果您添加了三个问号 (?)，则必须按顺序添加三个参数。

      

      如需添加查询参数，请执行以下操作：

      1. 在类型列表中，选择参数的数据类型。
      2. 在值字段中，输入参数的值。
      3. 要添加多个参数，请点击 + 添加查询参数。

如需了解如何使用自定义查询操作，请参阅操作示例。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - 执行分组依据查询

1. 在配置连接器任务对话框中，选择操作。
2. 选择执行自定义查询操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击修改自定义查询。此时将打开自定义查询对话框。
4. 在自定义查询对话框中，输入以下 SQL 查询，然后点击保存：

         Select E.EMPLOYEE_ID, E.EMPLOYEE_NAME, E.CITY
         FROM EMPLOYEES E
         LEFT JOIN EMPLOYEE_DEPARTMENT ED ON E.EMPLOYEE_ID=ED.ID 
         WHERE E.EMPLOYEE_NAME = 'John'
         GROUP BY E.CITY,E.EMPLOYEE_ID,E.EMPLOYEE_NAME
       

   此示例从 EMPLOYEES 和 EMPLOYEE_DEPARTMENT 表中选择员工记录。如果操作成功，连接器任务的 connectorOutputPayload 响应参数将包含查询结果集。

示例 - 执行参数化查询

1. 在配置连接器任务对话框中，选择操作。
2. 选择执行自定义查询操作，然后点击完成。
3. 在连接器任务的任务输入部分，为该字段设置以下值：
   1. 超时时间： 10
   2. 行数上限： 3
4. 点击 + 添加参数名称，输入以下值：
   1. 类型：VARCHAR
   2. 值：John
5. 点击修改自定义查询。此时将打开自定义查询对话框。
6. 在自定义查询对话框中，输入以下 SQL 查询，然后点击保存：

     Select C.ID,C.NAME,C.CITY,C.O_DATE,E.EMPLOYEE_ID 
     FROM customqueries C,Employees E 
     WHERE C.ID=E.Employee_id and C.NAME=?
   

以下示例选择员工姓名为 John 的员工记录。请注意，员工姓名已参数化。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"NAME": "John",
"O_DATE": "2023-06-01 00:00:00.0",
"EMPLOYEE_ID": 1.0
}, {
"NAME": "John",
"O_DATE": "2021-07-01 00:00:00.0",
"EMPLOYEE_ID": 3.0
}, {
"NAME": "John",
"O_DATE": "2022-09-01 00:00:00.0",
"EMPLOYEE_ID": 4.0
}]

示例 - 使用序列值插入记录

1. 在配置连接器任务对话框中，选择操作。
2. 选择执行自定义查询操作，然后点击完成。
3. 在自定义查询对话框中，输入以下 SQL 查询，然后点击保存：

     INSERT INTO AUTHOR(id,title) VALUES(author_table_id_seq.NEXTVAL,'Sample_book_title')
   

此示例通过使用现有的 author_table_id_seq 序列对象在 AUTHOR 表中插入记录。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
}]

示例 - 使用聚合函数执行查询

1. 在配置连接器任务对话框中，选择操作。
2. 选择执行自定义查询操作，然后点击完成。
3. 在自定义查询对话框中，输入以下 SQL 查询，然后点击保存：

     SELECT SUM(SALARY) as Total FROM EMPLOYEES
     

以下示例计算 EMPLOYEES 表中的工资汇总值。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"TOTAL": 13000.0
}]  
  

示例 - 创建新表

1. 在配置连接器任务对话框中，选择操作。
2. 选择执行自定义查询操作，然后点击完成。
3. 在自定义查询对话框中，输入以下 SQL 查询，然后点击保存：

       CREATE TABLE TEST1 (ID INT, NAME VARCHAR(40),DEPT VARCHAR(20),CITY VARCHAR(10))
    

以下示例会创建 TEST1 表。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
}]

实体操作示例

示例 - 列出所有员工

以下示例列出了 Employee 实体中的所有员工。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Employee。
3. 选择 List 操作，然后点击完成。
4. （可选）在连接器任务的任务输入部分，您可以通过指定过滤条件子句来过滤结果集。

示例 - 获取员工详细信息

此示例从 Employee 实体获取 ID 为 45 的员工的详细信息。

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

   其中，45 是 Employee 实体的主键值。

示例 - 创建员工记录

此示例在 Employee 实体中添加了一条新的员工记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Employee。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "EMPLOYEE_ID": 69.0,
   "EMPLOYEE_NAME": "John",
   "CITY": "Bangalore"
   }

   如果集成成功，则连接器任务的 connectorOutputPayload 字段的值将如下所示：

    {
   "ROWID": "AAAoU0AABAAAc3hAAF"
   }

示例 - 更新员工记录

此示例将更新 Employee 实体中 ID 为 69 的员工记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Employee。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "EMPLOYEE_NAME": "John",
   "CITY": "Mumbai"
   }

5. 点击 entityId，然后在 Default Value 字段中输入 69。

   或者，您也可以将 filterClause 设置为 69，而不是指定 entityId。

   如果集成成功，则连接器任务的 connectorOutputPayload 字段的值将类似于以下内容：

   {
   }

示例 - 删除员工记录

此示例将删除 Employee 实体中 ID 为 35 的员工记录。

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

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	必填	说明
service_name	STRING	False	Oracle 数据库的服务名称。
data_source	STRING	False	Oracle 网络服务名称、连接描述符（也称为 TNS 连接字符串），或用于标识要连接的数据库的简单连接命名。
include_synonyms	BOOLEAN	False	查询同义词的元数据，并将其作为实体提供。将此属性设置为 false 可以提高元数据性能。
abandoned_connection_timeout	INTEGER	False	放弃连接超时时间（以秒为单位）决定了借用的连接可以保持未使用状态多长时间，直到连接池将其视为被放弃并收回。
inactive_connection_timeout	INTEGER	False	非活跃连接超时（以秒为单位）决定了可用连接在从连接池中移除之前在连接池中保留的时间。
max_connection_reuse_time	INTEGER	False	连接重用时间上限（以秒为单位）用于指定任何连接可在多久之后重复使用，之后池将移除并关闭连接。
ttl_connection_timeout	INTEGER	False	连接可保持使用状态的时间上限（以秒为单位）。
browsable_schemas	STRING	False	以英文逗号分隔的架构（例如SchemaA、SchemaB）。默认使用用户的架构

在集成中使用 Oracle 数据库连接

创建连接后，它在 Apigee Integration 和 Application Integration 中都可用。您可以通过连接器任务在集成中使用该连接。

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

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

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。