操作汇总

分类

API描述

数据表操作

• CreateTable：创建一张数据表。创建数据表时支持同时创建二级索引等。

• ListTable：获取当前实例下已创建的所有表的表名。

• DeleteTable：删除当前实例下指定的表。

• UpdateTable：更新表的配置信息，例如数据生命周期、最大版本数、是否允许更新等。

• DescribeTable：查询指定表的结构信息以及预留读吞吐量和预留写吞吐量设置信息。

• ComputeSplitPointsBySize：将全表的数据在逻辑上划分成接近指定大小的若干分片，返回这些分片之间的分割点以及分片所在机器的提示。

基础数据操作

• 写入数据

  • PutRow：插入数据到指定的行。

  • UpdateRow：更新指定行的数据。

  • BatchWriteRow：批量插入、修改或删除一个或多个表中的若干行数据。

• 读取数据

  • GetRow：根据指定的主键读取单行数据。

  • BatchGetRow：批量读取一个表或多个表中的若干行数据。

  • GetRange：读取指定主键范围内的数据。

• 删除数据

  • DeleteRow：删除一行数据。

  • BatchWriteRow：批量插入、修改或删除一个或多个表中的若干行数据。

预定义列操作

• AddDefinedColumn：为数据表添加预定义列。预定义列可用作索引表的主键列或者属性列。

• DeleteDefinedColumn：删除预定义列。

二级索引操作

• CreateIndex：在指定的数据表上创建索引表。

• DropIndex：在指定的数据表上删除索引表。

多元索引操作

• CreateSearchIndex：创建一个多元索引。

• ListSearchIndex：列出多元索引列表。

• DescribeSearchIndex：查询多元索引描述信息，包括多元索引的字段信息和索引配置等。

• DeleteSearchIndex：删除一个多元索引。

• Search：通过多元索引查询数据。

• ComputeSplits：获取当前ParallelScan单个请求的最大并发数，用于使用多元索引并发导出数据时的并发度规划。

• ParallelScan：并发扫描数据。

实时数据消费

• CreateTunnel：为表创建一个数据通道。数据通道可用于实时消费表中数据。

• ListTunnel：列出表内通道信息。

• DescribeTunnel：获取通道的详细信息。

• DeleteTunnel：删除一个通道。

数据流Stream操作

• ListStream：获取当前实例下所有表的Stream信息。

• DescribeStream：获取当前Stream的Shard信息。

• GetShardIterator：获取读取当前Shard记录的起始iterator。

• GetStreamRecord：读取当前Shard的增量内容。

离线数据操作

• BulkImport：批量写入数据。写入数据时支持插入一行数据、修改行数据以及删除行数据。

• BulkExport：批量导出数据。

局部事务操作

• StartLocalTransaction：创建一个局部事务。为数据表开启局部事务后，使用局部事务功能，您可以创建数据范围在一个分区键值内的局部事务并对局部事务中的数据进行读写操作。通过使用局部事务您可以实现单行或多行读写的原子操作。

• CommitTransaction：提交局部事务。创建一个分区键值内的局部事务并对局部事务中的数据进行写操作后，如果要保存数据更新，则需要提交局部事务。

• AbortTransaction：丢弃局部事务。创建一个分区键值内的局部事务并对局部事务中的数据进行写操作后，如果无需保存数据更新，则需要丢弃局部事务或者等待局部事务超时。

SQL查询操作

• SQLQuery：使用SQL查询数据。

分类

API描述

时序表操作

• CreateTimeseriesTable：创建一张时序表。创建时序表时支持配置时序分析存储。

• ListTimeseriesTable：获取当前实例下的时序表列表。

• DescribeTimeseriesTable：获取一个时序表的信息。

• UpdateTimeseriesTable：更新时序表的配置信息。

• DeleteTimeseriesTable：删除一个时序表。删除时序表时，系统会同时删除时序表下的分析存储。

时序数据操作

• PutTimeseriesData：写入时序数据。

• GetTimeseriesData：查询某个时间线的数据。

• QueryTimeseriesMeta：检索时间线元数据。

• UpdateTimeseriesMeta：更新时间线元数据。

• DeleteTimeseriesMeta：删除时间线元数据。

• SplitTimeseriesScanTask：切分全量导出任务。

• ScanTimeseriesData：扫描时序数据。

分析存储操作

• CreateTimeseriesAnalyticalStore：为已存在的时序表创建一个时序分析存储用于低成本存储时序数据以及查询与分析时序数据。

• UpdateTimeseriesAnalyticalStore：更新时序分析存储配置信息，目前仅支持修改数据生命周期TTL。

• DescribeTimeseriesAnalyticalStore：查询时序分析存储描述信息，例如分析存储配置信息、分析存储同步状态、分析存储大小等。

• DeleteTimeseriesAnalyticalStore：删除一个时序分析存储。

Lastpoint索引操作

• CreateTimeseriesLastpointIndex：创建Lastpoint索引。

• DeleteTimeseriesLastpointIndex：删除Lastpoint索引。