Cloud SQL for MySQL

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

支持的版本

MySQL 版本 5.0 到 8.0

准备工作

在使用 Cloud SQL for MySQL 连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
  • 将 roles/connectors.admin IAM 角色授予配置连接器的用户 。
  • 将以下 IAM 角色授予您要用其来使用连接器的服务帐号：
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor
    • roles/cloudsql.editor

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

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

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

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

• 启用 sqladmin.googleapis.com (Cloud SQL Admin API) 服务。

配置连接器

一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：

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

   转到“连接”页面

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

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

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

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

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

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

   注意：仅当您是 随用随付客户时，才能自定义连接节点值。
   8. 项目 ID：CloudSQL 实例所在的 Google Cloud 项目的 ID。
   9. 数据库区域：CloudSQL 实例所在的区域名称。
   10. 实例 ID：要连接到的 CloudSQL 实例的 ID。
   11. 数据库名称：要连接到的 MySQL 数据库的名称。
   12. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   13. 点击下一步 。
5. 在目标 部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目标类型：选择目标类型。
      • 如需指定目标主机名或 IP 地址，请选择 主机地址 ，然后 在 host 1 字段中输入地址。
      • 如需建立专用连接，请选择端点连接 。在 端点连接 列表中，选择为后端系统创建的端点连接。
      注意： 如需了解如何创建端点连接， 请参阅专用 网络连接。创建端点连接后，它会显示在 端点连接 列表中。

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

   2. 主机类型 （可选）：选择主机的网络连接类型。
      • SOCKS5：如果您通过 SOCKS5 代理服务器连接到专用 Cloud SQL 实例，请选择此选项。这是为了向后兼容而采用的默认设置。
      • Private Service Connect (PSC)：如果您想使用 PSC 端点连接 IP 直接路由流量，而无需使用 SOCKS5 代理，请选择此选项。
   3. 端点连接：如果您选择 Private Service Connect (PSC) 作为主机类型，请从下拉列表中选择为实例创建的端点连接。
      注意： 如需了解如何创建端点连接，请参阅托管服务的网络连接。创建端点连接后，它会显示在端点连接 列表中。
      重要提示 ：Cloud SQL for MySQL 连接器仅支持未加密的流量。请确保您的 Cloud SQL 实例配置为“允许未加密的网络流量”。不支持连接到配置为“仅允许 SSL 连接”的实例。

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

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

      Cloud SQL for MySQL 连接支持以下身份验证类型：

      • 用户名和密码

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

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

配置身份验证

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

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

实体、操作和动作

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

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

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

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

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

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

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

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

系统限制

Cloud SQL for MySQL 连接器可以处理每个节点每秒 10 个事务， 每个 节点， 并 限制 超出此限制的任何事务 。 默认情况下，Integration Connectors 会为连接分配 2 个节点（以便提高可用性）。

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

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

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

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

支持的数据类型

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

• 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

操作

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

• 用户定义的存储过程和函数。如果您的后端中有任何存储过程和函数，这些过程和函数会列在 Actions 对话框的 Configure connector task 列中。
• 自定义 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. 要添加多个参数，请点击 + 添加查询参数。

     执行自定义查询 操作不支持数组变量。

操作示例

示例 - 查找较大值

此示例展示了如何执行用户定义的函数。在此示例中，find_greater 函数会比较两个整数，并返回较大的整数。

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

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

如果操作执行成功，连接器任务的 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。

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

示例 - 从实体删除记录

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

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Users。
3. 选择 Delete 操作，然后点击完成 。
4. 在连接器 任务的任务输入 部分中，点击 entityId ，然后在默认值 字段中输入 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"
   }

如果集成成功，连接器任务的 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 字段将 包含更新操作的响应。

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	必需	说明
project_id	STRING	True	包含 Cloud SQL 实例的项目的项目 ID。例如 myproject。
database_region	STRING	True	实例的云区域。例如 us-central1。
instance_id	STRING	True	数据库实例 ID。不包括项目 ID。例如 myinstance。
database_name	STRING	True	实例中数据库的名称。例如 mydatabase。

在集成中使用 Cloud SQL for MySQL 连接

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

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

另请参阅对 MySQL 数据库执行 CRUD 操作教程 ，该教程介绍了如何创建 MySQL 连接，以及如何在集成中使用连接来执行读取和写入操作。

向 Google Cloud 社区寻求帮助

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

后续步骤

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