Cloud SQL for SQL Server

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

支持的版本

SQL Server 版本：2008、2012、2014、2016、2017、2019 和 2022

准备工作

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

  • 在您的 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 SQL Server。
    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. 数据库名称：要连接到的 SQL Server 数据库的名称。
    12. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    13. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 目标类型：选择目标类型。
      • 如需指定目标主机名或 IP 地址，请选择主机地址，然后在主机 1 字段中输入相应地址。
      • 如需建立专用连接，请选择端点连接，然后从端点连接列表中选择所需的连接。

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

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

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

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

      • 用户名和密码

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

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

配置身份验证

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

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

连接配置示例

基本身份验证连接类型

字段名称 详细信息
位置 us-central1
连接器 CloudSQL SQL Server
连接器版本 1
连接名称 cloudsql-server-private
启用 Cloud Logging 是
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
项目 ID connectors-prod-test
数据库区域 us-central1
实例 ID google-cloud-bcone-sql-instance1
数据库名称 sqlcloudprivate_DB
节点数下限 2
节点数上限 2
目标类型 主机地址
主机 主机
端口 PORT
用户名 用户名
密码 PASSWORD
Secret 版本 1

系统限制

Cloud SQL for SQL Server 连接器每节点每秒最多可处理 30 个事务，超出此限制的任何事务都会受到节流。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

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

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

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

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

支持的数据类型

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

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

操作

本部分介绍了此连接器中可用的操作。

Employee_Procedure 操作

此操作会提取员工的数据。

Employee_Procedure 操作的输入参数

参数名称 数据类型 必需 说明
ID 整数 True 员工的 ID。

如需查看如何配置 Employee_Procedure 操作的示例，请参阅操作示例。

操作示例

本部分提供了此连接器中可用操作的示例。

示例 - 提取员工的数据

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

    4. 如果操作成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    [{
  "ID": 3,
  "Name": "Charlie",
  "City": "Paris",
  "SALARY": 6500.0,
  "Department": "IT"
}]

实体操作示例

本部分提供了一些示例，说明了此连接器中可用的实体操作。

示例 - 列出所有人员

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Persons。
  3. 选择 List 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，您可以设置 filterClause 以满足过滤需求。

    5. 您必须使用单引号 (') 将 filterClause 的值括起来。您可以使用 filterClause 根据列过滤记录。

示例 - 获取人员详细信息

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Persons。
  3. 选择 Get 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 1。此 ID 用于指定要检索的记录。

示例 - 删除人员

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Persons。
  3. 选择 Delete 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 9。此 ID 用于指定要删除的记录。

示例 - 创建人物

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Persons。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "LastName": "Charlie",
  "FirstName": "Cruz",
  "Address": "123 Main Street",
  "City": "Paris"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "PersonID": 100.0,
  "LastName": "Charlie",
  "FirstName": "Cruz",
  "Address": "123 Main Street",
  "City": "Paris"
}

示例 - 创建员工详细信息

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SQL_Performance_EmployeeDetails。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "ID": 9.0,
  "FirstName": "Alex",
  "LastName": "Ariel",
  "MyDate": "2021-10-22",
  "MyTime": "13:54:19",
  "MySmallDateTime": "2021-10-22 13:54:00.0",
  "MyDateTime": "2021-10-22 13:54:19.057",
  "MyDateTime2": "2021-10-22 13:54:19.055",
  "MyDateTimeOffset": "2021-10-22 13:54:19.055",
  "MyDecimalColumn": 123.0,
  "MyNumericColumn": 12345.12,
  "salary": 4000.0,
  "Location": "Paris",
  "City": "Paris",
  "Designation": "Consultant",
  "Position": "Junior",
  "Experience": 5.0,
  "Emp_Father_Name": "Taylor",
  "Emp_Spouse": "Yuri",
  "Age": 29.0,
  "Celsius": 35.0,
  "Isregistered": "AA==",
  "Data": "{\"name\": \"Raj\",\"skills\": [\"SSIS\", \"SSRS\", \"JS\"],\"Age\": 30}",
  "Emp_Status": "Active",
  "Emp_Department": "IT",
  "Emp_Zip": 121212.0,
  "Sex": "Male",
  "Manager": "Dana",
  "ManagerId": 10.0,
  "Manager_Location": "Paris",
  "HR_Name": "Sasha",
  "Emp_Technology": "SQL",
  "Company_Name": "Altostrat",
  "Company_Location": "Paris",
  "Emp_Degree": "BE",
  "Emp_10TH": "Y",
  "Emp_12TH": "Y",
  "Emp_10Th_Marks": 70.0,
  "Emp_12TH_Marks": 80.0,
  "Emp_Degree_Marks": 90.0,
  "work": "WFH",
  "Emp_Language": "English",
  "Emp_System": "Laptop",
  "Daily_Hrs": 9.0,
  "Week_Days": 5.0,
  "Weekly_Off": 2.0,
  "Client_Name": "Google",
  "Client_Location": "Lisbon",
  "Team_Size": 15.0,
  "Reports_TO": "Manager"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "ID": 9.0,
  "FirstName": "Alex",
  "LastName": "Ariel",
  "City": "Paris",
  "Salary": 4000.0
}

示例 - 创建员工

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

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "ID": 88.0,
  "NAME": "Dana",
  "AGE": 30,
  "City": "Lisbon",
  "SALARY": 10000.0
}

示例 - 更新人员详细信息

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Persons。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "LastName": "Charlie",
  "FirstName": "Cruz",
  "Address": "8 Rue du Nom Fictif",
  "City": "Paris"
}
    5. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 10。此 ID 用于指定要更新的记录。

    您也可以将 filterClause 设置为 '10'，而不是指定 entityId。

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "LastName": "Charlie",
  "FirstName": "Cruz",
  "Address": "8 Rue du Nom Fictif",
  "City": "Paris"
}

示例 - 更新员工详细信息

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SQL_Performance_EmployeeDetails。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Age": 30
}
    5. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 5。此 ID 用于指定要更新的记录。

    您也可以将 filterClause 设置为 '5'，而不是指定 entityId。

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "Age": 30
}

示例 - 更新员工信息

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Employee。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "AGE": 41,
  "City": "Paris",
  "SALARY": 10000.0
}
  5. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 2。此 ID 用于指定要更新的记录。

    您也可以将 filterClause 设置为 '2'，而不是指定 entityId。

    如果集成成功，连接器任务的 connectorOutputPayload 响应参数将具有类似以下的值：

    {
  "AGE": 41,
  "City": "Paris",
  "SALARY": 10000.0
}

使用 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。

向 Google Cloud 社区寻求帮助

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

后续步骤