使用 Dataflow 构建变更数据流连接

本页介绍了如何创建 Dataflow 流水线，以便使用变更数据流来使用和转发 Spanner 更改数据。您可以使用本页中的示例代码构建自定义流水线。

核心概念

以下是适用于变更数据流的 Dataflow 流水线的一些核心概念。

Dataflow

Dataflow 是一项快速且经济实惠的无服务器服务，同时支持流式处理和批量处理。它支持使用开源 Apache Beam 库编写的处理作业的可移植性，并自动执行基础架构预配和集群管理。从变更数据流读取时，Dataflow 会提供近乎实时的流式传输。

您可以使用 Dataflow 通过 SpannerIO 连接器使用 Spanner 变更数据流，该连接器提供了一个用于查询变更数据流的 Spanner API 抽象。借助此连接器，您无需管理变更数据流分区生命周期，而当您直接使用 Spanner API 时，则必须管理该生命周期。该连接器会为您提供数据更改记录流，以便您可以更专注于应用逻辑，而无需过多关注特定 API 详细信息和动态更改流分区。在大多数情况下，如果您需要读取变更数据流数据，我们建议您使用 SpannerIO 连接器，而不是 Spanner API。

Dataflow 模板是实现常见用例的预构建 Dataflow 流水线。如需了解概览，请参阅 Dataflow 模板。

Dataflow 流水线

Spanner 变更数据流 Dataflow 流水线由四个主要部分组成：

1. 包含变更数据流的 Spanner 数据库
2. SpannerIO 连接器
3. 用户定义的转换和接收器
4. Apache Beam Sink I/O Writer

Spanner 变更数据流

如需详细了解如何创建变更数据流，请参阅创建变更数据流。

Apache Beam SpannerIO 连接器

这是前面“Dataflow”部分中介绍的 SpannerIO 连接器。它是一种源 I/O 连接器，用于将数据更改记录的 PCollection 发送到流水线的后续阶段。每个发出的更改数据记录的事件时间将是提交时间戳。请注意，发出的记录是无序的，并且 SpannerIO 连接器可保证不会有延迟记录。

使用变更数据流时，Dataflow 会使用检查点。因此，每个工作器可能会在缓冲更改时等待长达配置的检查点间隔时间，然后再发送更改以进行进一步处理。

用户定义的转换

借助用户定义的转换，用户可以在 Dataflow 流水线中汇总、转换或修改处理数据。常见的用例包括移除个人身份信息、满足下游数据格式要求和排序。如需查看有关转换的编程指南，请参阅 Apache Beam 官方文档。

Apache Beam Sink I/O Writer

Apache Beam 包含内置 I/O 连接器，可用于将数据从 Dataflow 流水线写入 BigQuery 等数据接收器。系统对大多数常见的数据接收器提供原生支持。

Dataflow 模板

Dataflow 模板提供了一种方法，可使用 Google Cloud 控制台、 Google Cloud CLI 或 Rest API 调用，根据预构建的 Docker 映像为常见用例创建 Dataflow 作业。

对于 Spanner 变更数据流，我们提供了三个 Dataflow Flex 模板：

• Spanner 变更数据流 to BigQuery

• Spanner 变更数据流流到 Google Cloud Storage

• Spanner 变更数据流 to Pub/Sub

为 Dataflow 模板设置 IAM 权限

在使用所列的三个灵活模板创建 Dataflow 作业之前，请确保您对以下服务账号拥有所需的 IAM 权限：

• Dataflow 服务账号
• 工作器服务账号

如果您没有所需的 IAM 权限，则必须指定用户管理的工作器服务账号才能创建 Dataflow 作业。如需了解详情，请参阅 Dataflow 安全性和权限。

如果您尝试从没有所有必要权限的 Dataflow Flex 模板运行作业，则作业可能会失败，并显示读取结果文件失败错误或资源权限被拒绝错误。如需了解详情，请参阅排查 Flex 模板问题。

构建 Dataflow 流水线

本部分介绍了连接器的初始配置，并提供了与 Spanner 变更数据流功能的常见集成示例。

若要按照这些步骤操作，您需要 Dataflow 的 Java 开发环境。如需了解详情，请参阅使用 Java 创建 Dataflow 流水线。

创建变更流

如需详细了解如何创建变更数据流，请参阅创建变更数据流。如需继续执行后续步骤，您必须有一个已配置变更数据流的 Spanner 数据库。

授予精细访问权限控制特权

如果您希望任何精细访问权限控制用户都能运行 Dataflow 作业，请确保向这些用户授予对数据库角色的访问权限，该角色对变更数据流具有 SELECT 特权，对变更数据流的表值函数具有 EXECUTE 特权。此外，请确保主账号在 SpannerIO 配置或 Dataflow Flex 模板中指定了数据库角色。

如需了解详情，请参阅精细访问权限控制简介。

将 SpannerIO 连接器添加为依赖项

Apache Beam SpannerIO 连接器封装了直接使用 Cloud Spanner API 使用变更数据流的复杂性，将包含更改数据流数据记录的 PCollection 发送到流水线的后续阶段。

这些对象可在用户 Dataflow 流水线的其他阶段使用。变更数据流集成是 SpannerIO 连接器的一部分。如需使用 SpannerIO 连接器，您需要将该依赖项添加到 pom.xml 文件中：

<dependency>
  <groupId>org.apache.beam</groupId>
  <artifactId>beam-sdks-java-io-google-cloud-platform</artifactId>
  <version>${beam-version}</version> <!-- available from version 2.38.0 -->
</dependency>

创建元数据数据库

在运行 Apache Beam 流水线时，连接器需要跟踪每个分区。它会将这些元数据保存在连接器在初始化期间创建的 Spanner 表中。您可以在配置连接器时指定要用于创建此表的数据库。

如变更数据流最佳实践中所述，我们建议您为此创建一个新的数据库，而不是允许连接器使用应用的数据库来存储其元数据表。

重要提示： 如果您希望精细访问权限控制用户运行 Dataflow 作业，则必须创建单独的数据库。如需了解详情，请参阅精细访问权限控制简介。

使用 SpannerIO 连接器的 Dataflow 作业的所有者需要对此元数据库设置以下 IAM 权限：

• spanner.databases.updateDdl
• spanner.databases.beginReadOnlyTransaction
• spanner.databases.beginOrRollbackReadWriteTransaction
• spanner.databases.read
• spanner.databases.select
• spanner.databases.write
• spanner.sessions.create
• spanner.sessions.get

配置连接器

Spanner 变更数据流连接器可以按如下方式配置：

SpannerConfig spannerConfig = SpannerConfig
  .create()
  .withProjectId("my-project-id")
  .withInstanceId("my-instance-id")
  .withDatabaseId("my-database-id")
  .withDatabaseRole("my-database-role");    // Needed for fine-grained access control only

Timestamp startTime = Timestamp.now();
Timestamp endTime = Timestamp.ofTimeSecondsAndNanos(
   startTime.getSeconds() + (10 * 60),
   startTime.getNanos()
);

SpannerIO
  .readChangeStream()
  .withSpannerConfig(spannerConfig)
  .withChangeStreamName("my-change-stream")
  .withMetadataInstance("my-meta-instance-id")
  .withMetadataDatabase("my-meta-database-id")
  .withMetadataTable("my-meta-table-name")
  .withRpcPriority(RpcPriority.MEDIUM)
  .withInclusiveStartAt(startTime)
  .withInclusiveEndAt(endTime);

以下是 readChangeStream() 选项的说明：

Spanner 配置（必需）

用于配置创建变更数据流并应从中查询变更数据流的项目、实例和数据库。此外，还可以选择指定在运行 Dataflow 作业的 IAM 主账号是精细访问权限控制用户时要使用的数据库角色。作业会假定此数据库角色，以便访问变更数据流。如需了解详情，请参阅精细访问权限控制简介。

变更流名称（必填）

此名称可唯一标识更改流。此处的名称必须与创建时使用的名称相同。

元数据实例 ID（可选）

这是用于存储连接器用于控制变更数据流 API 数据用量的元数据的实例。

元数据数据库 ID（必需）

这是用于存储连接器用于控制变更数据流 API 数据用量的元数据的数据库。

元数据表名称（可选）

此参数仅应在更新现有流水线时使用。

这是连接器要使用的现有元数据表名称。连接器使用此参数来存储元数据，以控制变更数据流 API 数据的使用。如果省略此选项，Spanner 会在连接器初始化时创建一个使用生成的名称的新表。

RPC 优先级（可选）

要用于更改流查询的请求优先级。如果省略此参数，则系统会使用 high priority。

InclusiveStartAt（必需）

系统会将给定时间戳的更改返回给调用方。

InclusiveEndAt（可选）

系统会将截至给定时间戳的更改返回给调用方。如果省略此参数，系统将无限期地发出更改。

添加转换和接收器以处理更改数据

完成上述步骤后，配置好的 SpannerIO 连接器就可以发出包含 DataChangeRecord 对象的 PCollection 了。如需查看以各种方式处理此流式数据的多个示例流水线配置，请参阅示例转换和接收器。

请注意，SpannerIO 连接器发出的变更数据流记录是无序的。 这是因为 PCollection 不提供任何排序保证。如果您需要有序流，则必须在流水线中将记录分组并排序：请参阅示例：按键值排序。您可以扩展此示例，以便根据记录的任何字段（例如交易 ID）对记录进行排序。

转换和接收器示例

您可以定义自己的转换，并指定要将数据写入的接收器。Apache Beam 文档提供了可应用的众多转换，以及可用于将数据写入外部系统的现成I/O 连接器。

示例：按键排序

此代码示例使用 Dataflow 连接器发出按提交时间戳排序且按主键分组的数据更改记录。

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(ParDo.of(new BreakRecordByModFn()))
  .apply(ParDo.of(new KeyByIdFn()))
  .apply(ParDo.of(new BufferKeyUntilOutputTimestamp()))
  // Subsequent processing goes here

此代码示例使用状态和计时器来缓冲每个键的记录，并将计时器的到期时间设置为未来某个用户配置的时间 T（在 BufferKeyUntilOutputTimestamp 函数中定义）。当 Dataflow 水印超过时间 T 时，此代码会刷新缓冲区中时间戳小于 T 的所有记录，按提交时间戳对这些记录进行排序，并输出键值对，其中：

• 键是输入键，即经过哈希处理并转换为大小为 1000 的存储桶数组的主键。
• 该值是针对键缓冲的有序数据更改记录。

对于每个密钥，我们都提供以下保证：

• 计时器保证按到期时间戳的顺序触发。
• 下游阶段保证会按照元素的生成顺序接收这些元素。

例如，如果键的值为 100，则计时器会分别在 T1 和 T10 触发，并在每个时间戳生成一组数据更改记录。由于在 T1 输出的数据更改记录是在 T10 输出的数据更改记录之前生成的，因此下一个阶段也一定会先收到在 T1 输出的数据更改记录，然后再收到在 T10 输出的数据更改记录。此机制有助于我们保证每个主键的提交时间戳严格有序，以便进行下游处理。

此过程会重复执行，直到流水线结束并处理完所有数据更改记录（如果未指定结束时间，则会无限期重复）。

请注意，此代码示例使用状态和计时器（而非窗口）按键执行排序。原因在于，我们无法保证按顺序处理窗口。这意味着，较早的窗口可能会比较新的窗口晚处理，这可能会导致处理顺序混乱。

BreakRecordByModFn

每个数据更改记录都可能包含多个 mod。每个 mod 代表对单个主键值执行的插入、更新或删除操作。此函数会将每个数据更改记录拆分为单独的数据更改记录，每个 mod 对应一个。

private static class BreakRecordByModFn extends DoFn<DataChangeRecord,
                                                     DataChangeRecord>  {
  @ProcessElement
  public void processElement(
      @Element DataChangeRecord record, OutputReceiver<DataChangeRecord>
    outputReceiver) {
    record.getMods().stream()
      .map(
          mod ->
              new DataChangeRecord(
                  record.getPartitionToken(),
                  record.getCommitTimestamp(),
                  record.getServerTransactionId(),
                  record.isLastRecordInTransactionInPartition(),
                  record.getRecordSequence(),
                  record.getTableName(),
                  record.getRowType(),
                  Collections.singletonList(mod),
                  record.getModType(),
                  record.getValueCaptureType(),
                  record.getNumberOfRecordsInTransaction(),
                  record.getNumberOfPartitionsInTransaction(),
                  record.getTransactionTag(),
                  record.isSystemTransaction(),
                  record.getMetadata()))
      .forEach(outputReceiver::output);
  }
}

KeyByIdFn

此函数接受 DataChangeRecord，并输出一个键值为经过哈希处理为整数值的 Spanner 主键的 DataChangeRecord。

private static class KeyByIdFn extends DoFn<DataChangeRecord, KV<String, DataChangeRecord>>  {
  // NUMBER_OF_BUCKETS should be configured by the user to match their key cardinality
  // Here, we are choosing to hash the Spanner primary keys to a bucket index, in order to have a deterministic number
  // of states and timers for performance purposes.
  // Note that having too many buckets might have undesirable effects if it results in a low number of records per bucket
  // On the other hand, having too few buckets might also be problematic, since many keys will be contained within them.
  private static final int NUMBER_OF_BUCKETS = 1000;

  @ProcessElement
  public void processElement(
      @Element DataChangeRecord record,
      OutputReceiver<KV<String, DataChangeRecord>> outputReceiver) {
    int hashCode = (int) record.getMods().get(0).getKeysJson().hashCode();
    // Hash the received keys into a bucket in order to have a
    // deterministic number of buffers and timers.
    String bucketIndex = String.valueOf(hashCode % NUMBER_OF_BUCKETS);

    outputReceiver.output(KV.of(bucketIndex, record));
  }
}

BufferKeyUntilOutputTimestamp

计时器和缓冲区是按键分配的。此函数会缓冲每个数据更改记录，直到水印超出我们要输出缓冲数据更改记录的时间戳为止。

以下代码使用循环计时器来确定何时刷新缓冲区：

1. 当它首次看到某个键的数据更改记录时，会将计时器设置为在数据更改记录的提交时间戳 + incrementIntervalSeconds（用户可配置的选项）时触发。
2. 计时器触发时，它会将缓冲区中时间戳小于计时器到期时间的所有数据更改记录添加到 recordsToOutput。如果缓冲区中包含时间戳大于或等于计时器的到期时间的数据更改记录，则会将这些数据更改记录重新添加到缓冲区，而不是输出它们。然后，将下一个计时器设置为当前计时器的到期时间加上 incrementIntervalInSeconds。
3. 如果 recordsToOutput 不为空，该函数会按提交时间戳和事务 ID 对 recordsToOutput 中的数据更改记录进行排序，然后输出这些记录。

private static class BufferKeyUntilOutputTimestamp extends
    DoFn<KV<String, DataChangeRecord>, KV<String, Iterable<DataChangeRecord>>>  {
  private static final Logger LOG =
      LoggerFactory.getLogger(BufferKeyUntilOutputTimestamp.class);

  private final long incrementIntervalInSeconds = 2;

  private BufferKeyUntilOutputTimestamp(long incrementIntervalInSeconds) {
    this.incrementIntervalInSeconds = incrementIntervalInSeconds;
  }

  @SuppressWarnings("unused")
  @TimerId("timer")
  private final TimerSpec timerSpec = TimerSpecs.timer(TimeDomain.EVENT_TIME);

  @StateId("buffer")
  private final StateSpec<BagState<DataChangeRecord>> buffer = StateSpecs.bag();

  @StateId("keyString")
  private final StateSpec<ValueState<String>> keyString =
      StateSpecs.value(StringUtf8Coder.of());

  @ProcessElement
  public void process(
      @Element KV<String, DataChangeRecord> element,
      @StateId("buffer") BagState<DataChangeRecord> buffer,
      @TimerId("timer") Timer timer,
      @StateId("keyString") ValueState<String> keyString) {
    buffer.add(element.getValue());

    // Only set the timer if this is the first time we are receiving a data change
    // record with this key.
    String elementKey = keyString.read();
    if (elementKey == null) {
      Instant commitTimestamp =
          new Instant(element.getValue().getCommitTimestamp().toSqlTimestamp());
      Instant outputTimestamp =
          commitTimestamp.plus(Duration.standardSeconds(incrementIntervalInSeconds));
      timer.set(outputTimestamp);
      keyString.write(element.getKey());
    }
  }

  @OnTimer("timer")
  public void onExpiry(
      OnTimerContext context,
      @StateId("buffer") BagState<DataChangeRecord> buffer,
      @TimerId("timer") Timer timer,
      @StateId("keyString") ValueState<String> keyString) {
    if (!buffer.isEmpty().read()) {
      String elementKey = keyString.read();

      final List<DataChangeRecord> records =
          StreamSupport.stream(buffer.read().spliterator(), false)
              .collect(Collectors.toList());
      buffer.clear();

      List<DataChangeRecord> recordsToOutput = new ArrayList<>();
      for (DataChangeRecord record : records) {
        Instant recordCommitTimestamp =
            new Instant(record.getCommitTimestamp().toSqlTimestamp());
        final String recordString =
            record.getMods().get(0).getNewValuesJson().isEmpty()
                ? "Deleted record"
                : record.getMods().get(0).getNewValuesJson();
        // When the watermark passes time T, this means that all records with
        // event time < T have been processed and successfully committed. Since the
        // timer fires when the watermark passes the expiration time, we should
        // only output records with event time < expiration time.
        if (recordCommitTimestamp.isBefore(context.timestamp())) {
          LOG.info(
             "Outputting record with key {} and value {} at expiration " +
             "timestamp {}",
              elementKey,
              recordString,
              context.timestamp().toString());
          recordsToOutput.add(record);
        } else {
          LOG.info(
              "Expired at {} but adding record with key {} and value {} back to " +
              "buffer due to commit timestamp {}",
              context.timestamp().toString(),
              elementKey,
              recordString,
              recordCommitTimestamp.toString());
          buffer.add(record);
        }
      }

      // Output records, if there are any to output.
      if (!recordsToOutput.isEmpty()) {
        // Order the records in place, and output them. The user would need
        // to implement DataChangeRecordComparator class that sorts the
        // data change records by commit timestamp and transaction ID.
        Collections.sort(recordsToOutput, new DataChangeRecordComparator());
        context.outputWithTimestamp(
            KV.of(elementKey, recordsToOutput), context.timestamp());
        LOG.info(
            "Expired at {}, outputting records for key {}",
            context.timestamp().toString(),
            elementKey);
      } else {
        LOG.info("Expired at {} with no records", context.timestamp().toString());
      }
    }

    Instant nextTimer = context.timestamp().plus(Duration.standardSeconds(incrementIntervalInSeconds));
    if (buffer.isEmpty() != null && !buffer.isEmpty().read()) {
      LOG.info("Setting next timer to {}", nextTimer.toString());
      timer.set(nextTimer);
    } else {
      LOG.info(
          "Timer not being set since the buffer is empty: ");
      keyString.clear();
    }
  }
}

对交易进行排序

此流水线可以更改为按事务 ID 和提交时间戳排序。为此，请为每个事务 ID / 提交时间戳对缓冲记录，而不是为每个 Spanner 键缓冲记录。这需要修改 KeyByIdFn 中的代码。

示例：组装事务

以下代码示例会读取数据更改记录，将属于同一事务的所有数据更改记录组装到单个元素中，然后输出该元素。请注意，此示例代码输出的事务并非按提交时间戳排序。

此代码示例使用缓冲区从数据更改记录组装事务。首次收到属于某个事务的数据更改记录后，它会读取数据更改记录中的 numberOfRecordsInTransaction 字段，该字段描述了属于该事务的预期数据更改记录数。它会缓冲属于该事务的数据更改记录，直到缓冲的记录数与 numberOfRecordsInTransaction 相匹配，然后输出捆绑的数据更改记录。

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(ParDo.of(new KeyByTransactionIdFn()))
  .apply(ParDo.of(new TransactionBoundaryFn()))
  // Subsequent processing goes here

KeyByTransactionIdFn

此函数接受 DataChangeRecord，并输出按事务 ID 键控的 DataChangeRecord。

private static class KeyByTransactionIdFn extends DoFn<DataChangeRecord, KV<String, DataChangeRecord>>  {
  @ProcessElement
  public void processElement(
      @Element DataChangeRecord record,
      OutputReceiver<KV<String, DataChangeRecord>> outputReceiver) {
    outputReceiver.output(KV.of(record.getServerTransactionId(), record));
  }
}

TransactionBoundaryFn

TransactionBoundaryFn 会缓冲从 KeyByTransactionIdFn 收到的 {TransactionId, DataChangeRecord} 键值对，并根据 TransactionId 将其缓冲到组中。当缓冲的记录数等于整个事务中包含的记录数时，此函数会按记录序列对组中的 DataChangeRecord 对象进行排序，并输出 {CommitTimestamp, TransactionId}、Iterable<DataChangeRecord> 的键值对。

在这里，我们假设 SortKey 是表示 {CommitTimestamp, TransactionId} 对的用户定义类。如需详细了解 SortKey，请参阅实现示例。

private static class TransactionBoundaryFn extends DoFn<KV<String, DataChangeRecord>, KV<SortKey, Iterable<DataChangeRecord>>>  {
  @StateId("buffer")
  private final StateSpec<BagState<DataChangeRecord>> buffer = StateSpecs.bag();

  @StateId("count")
  private final StateSpec<ValueState<Integer>> countState = StateSpecs.value();

  @ProcessElement
  public void process(
      ProcessContext context,
      @StateId("buffer") BagState<DataChangeRecord> buffer,
      @StateId("count") ValueState<Integer> countState) {
    final KV<String, DataChangeRecord> element = context.element();
    final DataChangeRecord record = element.getValue();

    buffer.add(record);
    int count = (countState.read() != null ? countState.read() : 0);
    count = count + 1;
    countState.write(count);

    if (count == record.getNumberOfRecordsInTransaction()) {
      final List<DataChangeRecord> sortedRecords =
          StreamSupport.stream(buffer.read().spliterator(), false)
              .sorted(Comparator.comparing(DataChangeRecord::getRecordSequence))
              .collect(Collectors.toList());

      final Instant commitInstant =
          new Instant(sortedRecords.get(0).getCommitTimestamp().toSqlTimestamp()
              .getTime());
      context.outputWithTimestamp(
          KV.of(
              new SortKey(sortedRecords.get(0).getCommitTimestamp(),
                          sortedRecords.get(0).getServerTransactionId()),
              sortedRecords),
          commitInstant);
      buffer.clear();
      countState.clear();
    }
  }
}

示例：按交易标记过滤

为修改用户数据的交易添加标记后，相应的标记及其类型会作为 DataChangeRecord 的一部分存储。以下示例演示了如何根据用户定义的事务标记和系统标记过滤更改流记录：

针对 my-tx-tag 的用户定义的标记过滤：

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(Filter.by(record ->
           !record.isSystemTransaction()
           && record.getTransactionTag().equalsIgnoreCase("my-tx-tag")))
  // Subsequent processing goes here

系统代码植入过滤/TTL 审核：

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(Filter.by(record ->
           record.isSystemTransaction()
           && record.getTransactionTag().equals("RowDeletionPolicy")))
  // Subsequent processing goes here

示例：提取完整行

此示例使用名为 Singer 的 Spanner 表，该表的定义如下：

CREATE TABLE Singers (
  SingerId INT64 NOT NULL,
  FirstName STRING(1024),
  LastName STRING(1024)
) PRIMARY KEY (SingerId);

在变更数据流的默认 OLD_AND_NEW_VALUES 值捕获模式下，当有 Spanner 行发生更新时，收到的数据更改记录将仅包含发生更改的列。跟踪但未更改的列不会包含在记录中。模块的主键可用于在数据更改记录的提交时间戳执行 Spanner 快照读取，以提取未更改的列，甚至检索完整行。

请注意，为了成功读取快照，可能需要将数据库保留政策更改为大于或等于变更数据流保留政策的值。

另请注意，使用 NEW_ROW 值捕获类型是实现此目的的推荐方法，因为它默认会返回行的所有跟踪列，并且不需要将额外的快照读取到 Spanner。

SpannerConfig spannerConfig = SpannerConfig
   .create()
   .withProjectId("my-project-id")
   .withInstanceId("my-instance-id")
   .withDatabaseId("my-database-id")
   .withDatabaseRole("my-database-role");   // Needed for fine-grained access control only

pipeline
   .apply(SpannerIO
       .readChangeStream()
       .withSpannerConfig(spannerConfig)
       // Assume we have a change stream "my-change-stream" that watches Singers table.
       .withChangeStreamName("my-change-stream")
       .withMetadataInstance("my-metadata-instance-id")
       .withMetadataDatabase("my-metadata-database-id")
       .withInclusiveStartAt(Timestamp.now()))
   .apply(ParDo.of(new ToFullRowJsonFn(spannerConfig)))
   // Subsequent processing goes here

ToFullRowJsonFn

此转换将在收到的每条记录的提交时间戳时执行过时读取，并将完整行映射到 JSON。

public class ToFullRowJsonFn extends DoFn<DataChangeRecord, String> {
 // Since each instance of this DoFn will create its own session pool and will
 // perform calls to Spanner sequentially, we keep the number of sessions in
 // the pool small. This way, we avoid wasting resources.
 private static final int MIN_SESSIONS = 1;
 private static final int MAX_SESSIONS = 5;
 private final String projectId;
 private final String instanceId;
 private final String databaseId;

 private transient DatabaseClient client;
 private transient Spanner spanner;

 public ToFullRowJsonFn(SpannerConfig spannerConfig) {
   this.projectId = spannerConfig.getProjectId().get();
   this.instanceId = spannerConfig.getInstanceId().get();
   this.databaseId = spannerConfig.getDatabaseId().get();
 }

 @Setup
 public void setup() {
   SessionPoolOptions sessionPoolOptions = SessionPoolOptions
      .newBuilder()
      .setMinSessions(MIN_SESSIONS)
      .setMaxSessions(MAX_SESSIONS)
      .build();
   SpannerOptions options = SpannerOptions
       .newBuilder()
       .setProjectId(projectId)
       .setSessionPoolOption(sessionPoolOptions)
       .build();
   DatabaseId id = DatabaseId.of(projectId, instanceId, databaseId);
   spanner = options.getService();
   client = spanner.getDatabaseClient(id);
 }

 @Teardown
 public void teardown() {
   spanner.close();
 }

 @ProcessElement
 public void process(
   @Element DataChangeRecord element,
   OutputReceiver<String> output) {
   com.google.cloud.Timestamp commitTimestamp = element.getCommitTimestamp();
   element.getMods().forEach(mod -> {
     JSONObject keysJson = new JSONObject(mod.getKeysJson());
     JSONObject newValuesJson = new JSONObject(mod.getNewValuesJson());
     ModType modType = element.getModType();
     JSONObject jsonRow = new JSONObject();
     long singerId = keysJson.getLong("SingerId");
     jsonRow.put("SingerId", singerId);
     if (modType == ModType.INSERT) {
       // For INSERT mod, get non-primary key columns from mod.
       jsonRow.put("FirstName", newValuesJson.get("FirstName"));
       jsonRow.put("LastName", newValuesJson.get("LastName"));
     } else if (modType == ModType.UPDATE) {
       // For UPDATE mod, get non-primary key columns by doing a snapshot read using the primary key column from mod.
       try (ResultSet resultSet = client
         .singleUse(TimestampBound.ofReadTimestamp(commitTimestamp))
         .read(
           "Singers",
           KeySet.singleKey(com.google.cloud.spanner.Key.of(singerId)),
             Arrays.asList("FirstName", "LastName"))) {
         if (resultSet.next()) {
           jsonRow.put("FirstName", resultSet.isNull("FirstName") ?
             JSONObject.NULL : resultSet.getString("FirstName"));
           jsonRow.put("LastName", resultSet.isNull("LastName") ?
             JSONObject.NULL : resultSet.getString("LastName"));
         }
       }
     } else {
       // For DELETE mod, there is nothing to do, as we already set SingerId.
     }

     output.output(jsonRow.toString());
   });
 }
}

此代码会创建一个 Spanner 数据库客户端来执行完整行提取，并将会话池配置为仅包含几个会话，以便在 ToFullReowJsonFn 的一个实例中顺序执行读取。Dataflow 会确保生成此函数的多个实例，每个实例都有自己的客户端池。

注意 ：我们建议在读取更改流的阶段后添加重新洗牌阶段。这会将数据重新分配到多个工作器线程，并提高并行性。

示例：Spanner 到 Pub/Sub

在这种情况下，调用方会尽快将记录流式传输到 Pub/Sub，而不会进行任何分组或汇总。这非常适合触发下游处理，以及将插入到 Spanner 表中的所有新行流式传输到 Pub/Sub 以进行进一步处理。

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(MapElements.into(TypeDescriptors.strings()).via(Object::toString))
  .apply(PubsubIO.writeStrings().to("my-topic"));

请注意，Pub/Sub 接收器可以配置为确保“正好一次”语义。

示例：Spanner 到 Cloud Storage

在这种情况下，调用方会对给定时间范围内的所有记录进行分组，并将分组保存在单独的 Cloud Storage 文件中。这非常适合分析和时间点归档，这与 Spanner 的保留期限无关。

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(SpannerConfig
      .create()
      .withProjectId("my-project-id")
      .withInstanceId("my-instance-id")
      .withDatabaseId("my-database-id")
      .withDatabaseRole("my-database-role"))    // Needed for fine-grained access control only
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(MapElements.into(TypeDescriptors.strings()).via(Object::toString))
  .apply(Window.into(FixedWindows.of(Duration.standardMinutes(1))))
  .apply(TextIO
    .write()
    .to("gs://my-bucket/change-stream-results-")
    .withSuffix(".txt")
    .withWindowedWrites()
    .withNumShards(1));

请注意，Cloud Storage 接收器默认提供“至少一次”语义。通过额外的处理，可以将其修改为具有“正好一次”语义。

我们还为此用例提供了 Dataflow 模板：请参阅将变更数据流连接到 Cloud Storage。

示例：Spanner 到 BigQuery（分类账表）

在这里，调用方会将更改记录流式传输到 BigQuery。每个数据更改记录都会在 BigQuery 中反映为一行。这非常适合分析。此代码使用了前面提取完整行部分中定义的函数，用于检索记录的完整行并将其写入 BigQuery。

SpannerConfig spannerConfig = SpannerConfig
  .create()
  .withProjectId("my-project-id")
  .withInstanceId("my-instance-id")
  .withDatabaseId("my-database-id")
  .withDatabaseRole("my-database-role");   // Needed for fine-grained access control only

pipeline
  .apply(SpannerIO
    .readChangeStream()
    .withSpannerConfig(spannerConfig)
    .withChangeStreamName("my-change-stream")
    .withMetadataInstance("my-metadata-instance-id")
    .withMetadataDatabase("my-metadata-database-id")
    .withInclusiveStartAt(Timestamp.now()))
  .apply(ParDo.of(new ToFullRowJsonFn(spannerConfig)))
  .apply(BigQueryIO
    .<String>write()
    .to("my-bigquery-table")
    .withCreateDisposition(CreateDisposition.CREATE_IF_NEEDED)
    .withWriteDisposition(Write.WriteDisposition.WRITE_APPEND)
    .withSchema(new TableSchema().setFields(Arrays.asList(
      new TableFieldSchema()
        .setName("SingerId")
        .setType("INT64")
        .setMode("REQUIRED"),
      new TableFieldSchema()
        .setName("FirstName")
        .setType("STRING")
        .setMode("REQUIRED"),
      new TableFieldSchema()
        .setName("LastName")
        .setType("STRING")
        .setMode("REQUIRED")
    )))
    .withAutoSharding()
    .optimizedWrites()
    .withFormatFunction((String element) -> {
      ObjectMapper objectMapper = new ObjectMapper();
      JsonNode jsonNode = null;
      try {
        jsonNode = objectMapper.readTree(element);
      } catch (IOException e) {
        e.printStackTrace();
      }
      return new TableRow()
        .set("SingerId", jsonNode.get("SingerId").asInt())
        .set("FirstName", jsonNode.get("FirstName").asText())
        .set("LastName", jsonNode.get("LastName").asText());
    }
  )
);

请注意，BigQuery Sink 默认提供“至少一次”语义。通过额外的处理，可以将其修改为具有“正好一次”语义。

我们还为此用例提供了 Dataflow 模板；请参阅变更数据流接到 BigQuery。

监控流水线

有两类指标可用于监控变更数据流 Dataflow 流水线。

标准 Dataflow 指标

Dataflow 提供了多种指标来确保作业的运行状况良好，例如数据新鲜度、系统延迟时间、作业吞吐量、工作器 CPU 利用率等。如需了解详情，请参阅对 Dataflow 流水线使用 Monitoring。

对于更改流水线，应考虑两个主要指标：系统延迟时间和数据新鲜度。

系统延迟时间会告知您当前某数据项已处理或等待处理的最长时长（以秒为单位）。

数据新鲜度会显示当前时间（实时）与输出水印之间的时间长度。输出数据水印为时间 T 表示所有事件发生时间（严格）早于 T 的元素都已经过计算处理。换句话说，数据新鲜度衡量的是流水线在处理所收到事件方面的最新程度。

如果流水线资源不足，您会在这两个指标中看到这种影响。系统延迟时间会增加，因为内容需要等待更长时间才能处理。由于流水线无法跟上收到的数据量，因此数据新鲜度也会提高。

自定义更改流指标

这些指标会在 Cloud Monitoring 中公开，包括：

• 从记录在 Spanner 中提交到由连接器发射到 PCollection 之间的分桶（直方图）延迟时间。您可以使用此指标查看流水线的任何性能（延迟时间）问题。
• 读取的数据记录总数。这是一个总体指标，表示连接器发出的记录数量。此数值应不断增加，反映底层 Spanner 数据库中的写入趋势。
• 正在读取的分区数量。始终应有分区正在读取。如果此数值为零，则表示流水线中发生了错误。
• 连接器执行期间发出的查询总数。这是一个总体指标，表示在流水线执行期间对 Spanner 实例执行的更改流查询的次数。您可以使用此指标来估算从连接器到 Spanner 数据库的负载。

更新现有流水线

如果作业兼容性检查通过，则可以更新使用 SpannerIO 连接器处理变更数据流的正在运行的流水线。为此，您必须在更新新作业时明确设置其元数据表名称参数。使用您要更新的作业的 metadataTable 流水线选项的值。

如果您使用的是 Google 提供的 Dataflow 模板，请使用参数 spannerMetadataTableName 设置表名称。您还可以修改现有作业，以便在连接器配置中使用方法 withMetadataTable(your-metadata-table-name) 明确使用元数据表。完成后，您可以按照 Dataflow 文档中的启动替换作业中的说明更新正在运行的作业。

变更数据流和 Dataflow 的最佳实践

以下是使用 Dataflow 构建变更数据流连接的一些最佳实践。

使用单独的元数据数据库

我们建议为 SpannerIO 连接器创建一个单独的数据库来用作元数据存储，而不是将其配置为使用您的应用数据库。

如需了解详情，请参阅考虑使用单独的元数据数据库。

调整集群大小

在确定 Spanner 变更数据流作业的初始工作器数量时，一个经验法则是：每秒 1,000 次写入对应一个工作器。请注意，此估算值可能会因多种因素而异，例如每笔交易的大小、单笔交易产生的更改流记录数量，以及流水线中使用的其他转换、汇总或接收器。

初始重新分配资源后，请务必跟踪监控流水线中提及的指标，以确保流水线运行状况良好。我们建议您尝试调整初始工作器池大小，并监控流水线如何处理负载，根据需要增加节点数量。CPU 利用率是检查负载是否适当以及是否需要更多节点的关键指标。

已知限制

将 Spanner 变更数据流与 Dataflow 搭配使用时存在一些已知限制：

自动扩缩

若要为包含 SpannerIO.readChangeStream 的任何流水线提供自动扩缩支持，则需要使用 Apache Beam 2.39.0 或更高版本。

如果您使用的是 2.39.0 之前的 Apache Beam 版本，则包含 SpannerIO.readChangeStream 的流水线需要明确将自动扩缩算法指定为 NONE，如横向自动扩缩中所述。

如需手动伸缩 Dataflow 流水线（而不是使用自动伸缩），请参阅手动伸缩流处理流水线。

Runner v2

Spanner 变更数据流连接器需要 Dataflow Runner v2。必须在执行期间手动指定此值，否则系统会抛出错误。您可以使用 --experiments=use_unified_worker,use_runner_v2 配置作业，以指定 Runner V2。

快照

Spanner 变更数据流连接器不支持 Dataflow 快照。

正在排空

Spanner 变更数据流连接器不支持排空作业。只能取消现有作业。

您还可以更新现有流水线，而无需停止该流水线。

OpenCensus

如需使用 OpenCensus 监控流水线，请指定 0.28.3 或更高版本。

流水线启动时的 NullPointerException

Apache Beam 版本 2.38.0 中的bug 可能会导致在特定条件下启动流水线时出现 NullPointerException。这会导致您的作业无法启动，并改为显示以下错误消息：

java.lang.NullPointerException: null value in entry: Cloud Storage_PROJECT_ID=null

如需解决此问题，请使用 Apache Beam 2.39.0 或更高版本，或手动将 beam-sdks-java-core 的版本指定为 2.37.0：

<dependency>
  <groupId>org.apache.beam</groupId>
  <artifactId>beam-sdks-java-core</artifactId>
  <version>2.37.0</version>
</dependency>

更多信息

• 更改流最佳实践