Cloud Spanner

借助 Cloud Spanner 连接器，您可以对 Google Cloud Spanner 数据库执行插入、删除、更新和读取操作。

准备工作

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

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

      服务账号是一种特殊类型的 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. 连接器：从可用连接器的下拉列表中选择 Cloud Spanner。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

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

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

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

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

    7. 项目 ID：Spanner 实例所在的 Google Cloud 项目的 ID。
    8. 数据库区域：Spanner 实例所在的区域的名称。
    9. 实例 ID：要连接到的 Spanner 实例的 ID。
    10. 数据库名称：要连接到的 Spanner 数据库的名称。
    11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    12. 点击下一步。
  5. 在身份验证部分中，输入身份验证详细信息。
    1. Cloud Spanner 连接不需要任何身份验证。
    2. 点击下一步。
  6. 查看：查看您的连接和身份验证详细信息。
  7. 点击创建。

实体、操作和动作

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

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

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

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

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

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

操作

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

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

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

    1. 按照详细说明 添加连接器任务。
    2. 在配置连接器任务时，在要执行的操作类型中选择操作。
    3. 在操作列表中，选择执行自定义查询，然后点击完成。
    4. 展开任务输入部分，然后执行以下操作：
      1. 在超时后字段中，输入查询执行之前等待的秒数。

        默认值：180 秒。

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

        默认值为 25。

      3. 要更新自定义查询，请点击修改自定义查询。系统会打开脚本编辑器对话框。
      4. 在脚本编辑器对话框中，输入 SQL 查询，然后点击保存。

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

        SELECT * FROM Employees where LastName=?

      5. 如果您在 SQL 查询中使用了问号，则必须针对每个问号点击 + 添加参数名称，以添加参数。在执行集成时，这些参数会按顺序替换 SQL 查询中的问号 (?)。例如，如果您添加了三个问号 (?)，则必须按顺序添加三个参数。如需添加查询参数，请执行以下操作：
        1. 从类型列表中，选择参数的数据类型。
        2. 在值字段中，输入参数的值。
        3. 如需添加多个参数，请点击 + 添加查询参数。

支持的数据类型

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

  • BIGINT
  • BINARY
  • BIT
  • BOOLEAN
  • CHAR
  • 日期
  • DECIMAL
  • DOUBLE
  • FLOAT
  • INTEGER
  • LONGN VARCHAR
  • LONG VARCHAR
  • NCHAR
  • NUMERIC
  • NVARCHAR
  • REAL
  • 室内
  • 时间
  • TIMESTAMP
  • 暗含
  • VARBINARY
  • VARCHAR

使用 Terraform 创建连接

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

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

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

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

参数名称 数据类型 需要 说明
project_id STRING True Spanner 实例所在的 Google Cloud 项目的 ID。
database_region STRING True Spanner 实例所在区域的名称。
instance_id STRING True 要连接的 Spanner 实例的 ID。
database_name STRING True 要连接的 Spanner 数据库的名称。
database_dialect ENUM True 指定 Spanner 数据库的数据库方言类型。支持的值包括：GoogleStandardSQL、PostgreSQL

在集成中使用 Cloud Spanner 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤