Azure Synapse

借助 Azure Synapse 连接器，您可以连接到 Azure Synapse SQL 池并使用 SQL 检索和更新 Azure Synapse 数据。

准备工作

在使用 Azure Synapse 连接器之前，请执行以下任务：

• 在您的 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. 连接器：从可用连接器下拉列表中选择 Azure Synapse。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

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

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

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

   注意：只有在 即随用随付的客户。
   7. Azure 租户：此属性指定用于访问数据的 Microsoft Azure 租户。
   8. 数据库：此属性指定无服务器 SQL 池或专用 SQL 池中 Synapse 数据库的名称。
   9. 在 目标 下，输入以下属性：
   • Destination Type（目标类型）：从下拉列表中选择主机地址
   • 主机 1：输入 SQL 池端点
   • 端口 1：输入 SQL 端点的端口
   。
   10. （可选）为 SSL 输入以下属性：
       • 启用 SSL：此复选框属性指定是否启用 SSL。
       • 信任库：此属性用于指定信任库。您可以选中相应的单选按钮，从“Pubic”“Private”或“Insecure Connection”中选择受信任证书存储区。
       • Custom Trust Store：此属性用于选择包含 PEM 格式的自定义信任存储区的 Secret。
       • SSL 客户端证书：此属性用于指定 SSL 客户端证书。
       • SSL 客户端私钥：此属性以 PEM 格式指定 SSL 客户端私钥。
       • SSL 客户端证书密钥密码：此属性用于指定 SSL 客户端私钥密码。
   11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   12. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

      Azure Synapse 连接支持以下身份验证类型：

      • 用户密码
      • Azure AD

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

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

配置身份验证

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

• 用户密码
  • 用户名：输入数据库用户名。
  • Password：包含与用户名关联的密码的 Secret Manager Secret。

• Azure AD
  • 客户端 ID：用于请求访问令牌的客户端 ID。您可以在 Azure 门户中创建的已关联应用的概览中找到此信息。
  • 范围：所需范围的逗号分隔列表。
  • 客户端密钥：包含账号访问密钥的 Secret Manager Secret。
  • 授权网址：创建客户端时生成的授权网址。

创建连接后的其他步骤

如果您选择了 OAuth 2.0 - Authorization code 作为身份验证方法，则必须在创建连接后执行以下额外步骤：

1. 在“连接”页面中，找到新创建的连接。

   请注意，新连接器的状态将为需要授权。

2. 点击需要授权。

   此时将显示修改授权窗格。

3. 将重定向 URI 值复制到您的外部应用。
4. 验证授权详情。
5. 点击 Authorize（授权）。

   如果授权成功，连接状态将在 “连接”页面。

为授权代码重新授权

如果您使用的是 Authorization code 身份验证类型，并在 Azure Synapse 应用中更改了配置， 您必须重新授权 Azure Synapse 连接。如需重新授权关联，请执行以下步骤：

1. 在“连接”页面中，点击所需的连接。

   系统随即会打开连接详情页面。

2. 点击修改以修改关联详情。
3. 验证 Authentication（身份验证）部分中的 OAuth 2.0 - Authorization code（OAuth 2.0 - 授权代码）详细信息。

   根据需要进行必要的更改。

4. 点击保存。系统随即会转到连接详情页面。
5. 点击身份验证部分中的修改授权。此时将显示授权窗格。
6. 点击 Authorize（授权）。

   如果授权成功，“连接”页面中的连接状态将设置为有效。

实体、操作和动作

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

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

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

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

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

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

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

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

系统限制

Azure Synapse 连接器每个节点每秒最多可以处理 4 笔事务，并会对超出此限制的所有事务进行节流。默认情况下，集成连接器会为连接分配 2 个节点（以提高可用性）。

如需了解适用于集成连接器的限制，请参阅限制。

注意：Integration Connectors 节点的数量会动态地自动扩缩 根据您的使用情况不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。更多 节点处理更多连接事务。反之，节点数量越少 如果连接处理的事务较少，则必需项。配置节点 值，请执行以下操作：

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

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

支持的数据类型

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

• BIGINT
• BINARY
• BIT
• CHAR
• DATE
• DATETIME
• DATETIME2
• DATETIMEOFFSET
• DECIMAL
• FLOAT
• DECIMAL
• FLOAT
• INT
• 货币
• NCHAR
• NVARCHAR
• REAL
• LSEG
• SMALLDATETIME
• SMALLINT
• SMALLMONEY
• TINYINT
• 唯一标识符
• VARBINARY
• VARCHAR

操作

借助 Azure Synapse 连接器，您可以执行存储过程和自定义 SQL 将查询配置为 Azure Synapse 支持的格式。如需执行自定义 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. 要添加多个参数，请点击 + 添加查询参数。

实体操作示例

示例 - 列出实体的记录

以下示例列出了 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 并 然后在 Default Value 字段中输入 103032。

   其中，103032 是 Users 实体的主键值。

示例 - 从实体中删除记录

此示例会从 Users 实体中删除一条记录。

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

   或者，如果实体具有复合主键，则无需指定 entityId，可以执行以下操作： 设置 filterClause。例如 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"
   }

如果集成成功，连接器任务的 connectorOutputPayload 字段将包含创建操作的响应。

示例 - 更新实体中的记录

此示例会更新 Users 实体中的记录。

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

   {
   "country": "IN"
   }

5. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 113132。

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

如果集成成功，连接器任务的 connectorOutputPayload 字段将包含更新操作的响应。

在集成中使用 Azure Synapse 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤

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