如何使用Stream API/SDK

API



打开/关闭 Stream


用户可以在创建表的时候设置 Stream 是否开启，也可以通过 UpdateTable 来开启或者关闭 Stream。CreateTable 和 UpdateTable 中新增了 StreamSpecification 参数，表示 Stream 的相关参数：

• enable_stream：Stream 是否打开。
• expiration_time：Stream 数据的过期时间，较早的修改记录将会被删除。

1. 
   调用 ListStreams 获取当前表的 Stream 信息，例如 StreamID。详细信息请参见 ListStream。
2. 
   调用 DescribeStream 获取当前 Stream 的数据分片信息，例如 shard 的列表，每个 shard 记录又包含父 shard 信息、shardID 信息等。详细信息请参见 DescribeStream。
3. 
   获取 StreamID 和 shardID 后，通过 GetShardIterator 获取当前 shard 的读 iterator 值，这个值标记着读取该 shard 记录的起始位置。详细信息请参见 GetShardIterator。
4. 
   调用 GetStreamRecord 来读取具体的修改记录，每次调用会返回新的 iterator，用于下次读取。详细信息请参见 GetStreamRecord API。

[backcolor=transparent]注意：

• 同一个主键下的操作必须有序。在同一个 shard 下，Stream 做了这个保证。但是 shard 会出现分裂、合并等操作，所以您在读取某个 shard 的数据时，需要确保他的父 shard 以及 parent_sibling 的数据已经被读取。
• 当读到空的 NextShardIterator 的时候，说明当前 shard 的增量数据已经全部读完，通常情况是该 shard 已经进入 inactive 的状态（发生分裂或者合并）。当一个 shard 已经被全部读完以后，您可以重新调用 DescribeStream获取新的 shard 信息。