com.aliyun.openservices.ots
接口 OTS

所有已知实现类：

OTSClient

public interface OTS

阿里云开放结构化数据服务（Open Table Service, OTS）的访问接口。

开放结构化数据服务（Open Table Service，OTS）是构建在阿里云大规模分布式计算系统之上 的海量数据存储与实时查询的服务。

方法摘要

void	abortTransaction(String transactionId) 撤销一个事务（Transaction），撤销后所有在此事务中的操作都被取消，撤销后此事务ID失效。
void	batchModifyData(String tableName, Collection<RowChange> rowChanges, String transactionId) 把PutData和/或DeleteData的多次调用组合成一个调用。
void	commitTransaction(String transactionId) 确认并提交事务（Transaction），提交后此事务ID失效。
void	createTable(TableMeta tableMeta) 创建表（Table）及其相关视图（View）。
void	createTableGroup(String tableGroupName, PartitionKeyType pkType) 创建表组（Table Group）。
void	deleteData(String tableName, RowDeleteChange rowChange, String transactionId) 删除指定行或行中的数据。
void	deleteTable(String tableName) 删除表（Table）及与此表一起创建的视图（View）。
void	deleteTableGroup(String tableGroupName) 删除表组（Table Group）及属于该表组的相关表（Table）和视图（View）。
Row	getRow(SingleRowQueryCriteria criteria, String transactionId) 返回表（Table）或视图（View）中的一行数据。
List<Row>	getRowsByOffset(OffsetRowQueryCriteria criteria, String transactionId) 返回表（Table）或视图（View）的指定偏移量开始的多行数据。
List<Row>	getRowsByRange(RangeRowQueryCriteria criteria, String transactionId) 返回表（Table）或视图（View）中主键（Primary Key）的特定范围内的多行数据。
RowListing	getRowsByRange(RangeRowQueryCriteria criteria, String transactionId, String nextToken) 返回表（Table）或视图（View）中主键（Primary Key）的特定范围内的多行数据。
TableMeta	getTableMeta(String tableName) 返回表（Table）的结构信息。
List<String>	listTableGroups() 返回表组（Table Group）名的列表。
List<String>	listTables() 返回表（Table）名的列表。
void	putData(String tableName, RowPutChange rowChange, String transactionId) 插入一行或修改指定行中的数据。
String	startTransaction(String entityName, PartitionKeyValue pkValue) 在表（Table）或表组（Table Group）上开始一个事务（Transaction），并得到该事务ID。

方法详细信息

createTableGroup

void createTableGroup(String tableGroupName,
                      PartitionKeyType pkType)
                      throws OTSException,
                             ClientException

创建表组（Table Group）。

参数：

tableGroupName - 表组名称。

pkType - 表组的数据分片键的数据类型。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

listTableGroups

List<String> listTableGroups()
                             throws OTSException,
                                    ClientException

返回表组（Table Group）名的列表。

返回：

表组（Table Group）名称的列表。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

deleteTableGroup

void deleteTableGroup(String tableGroupName)
                      throws OTSException,
                             ClientException

删除表组（Table Group）及属于该表组的相关表（Table）和视图（View）。

参数：

tableGroupName - 表组名。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

createTable

void createTable(TableMeta tableMeta)
                 throws OTSException,
                        ClientException

创建表（Table）及其相关视图（View）。

参数：

tableMeta - 表及相关视图的结构信息。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

getTableMeta

TableMeta getTableMeta(String tableName)
                       throws OTSException,
                              ClientException

返回表（Table）的结构信息。

参数：

tableName - 表名。

返回：

表的结构信息。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

listTables

List<String> listTables()
                        throws OTSException,
                               ClientException

返回表（Table）名的列表。

返回：

表名的列表。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

deleteTable

void deleteTable(String tableName)
                 throws OTSException,
                        ClientException

删除表（Table）及与此表一起创建的视图（View）。

参数：

tableName - 表名。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

startTransaction

String startTransaction(String entityName,
                        PartitionKeyValue pkValue)
                        throws OTSException,
                               ClientException

在表（Table）或表组（Table Group）上开始一个事务（Transaction），并得到该事务ID。

参数：

entityName - 表名或表组名。

pkValue - 表示事务（Transaction）建立在哪个数据分片键（Partition Key）上。

返回：

事务（Transaction）ID。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

commitTransaction

void commitTransaction(String transactionId)
                       throws OTSException,
                              ClientException

确认并提交事务（Transaction），提交后此事务ID失效。

参数：

transactionId - 事务ID。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

abortTransaction

void abortTransaction(String transactionId)
                      throws OTSException,
                             ClientException

撤销一个事务（Transaction），撤销后所有在此事务中的操作都被取消，撤销后此事务ID失效。

参数：

transactionId - 事务ID。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

getRow

Row getRow(SingleRowQueryCriteria criteria,
           String transactionId)
           throws OTSException,
                  ClientException

返回表（Table）或视图（View）中的一行数据。

参数：

criteria - 查询条件。

transactionId - 事务ID，不为空时操作在事务中进行。

返回：

满足查询条件的一行数据。如果如果未找到，返回null。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

getRowsByOffset

List<Row> getRowsByOffset(OffsetRowQueryCriteria criteria,
                          String transactionId)
                          throws OTSException,
                                 ClientException

返回表（Table）或视图（View）的指定偏移量开始的多行数据。

参数：

criteria - 查询条件。

transactionId - 事务ID，不为空时操作在事务中进行。

返回：

满足查询条件的多行数据。如果如果未找到，返回空列表。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

getRowsByRange

List<Row> getRowsByRange(RangeRowQueryCriteria criteria,
                         String transactionId)
                         throws OTSException,
                                ClientException

返回表（Table）或视图（View）中主键（Primary Key）的特定范围内的多行数据。

参数：

criteria - 查询条件。

transactionId - 事务ID，不为空时操作在事务中进行。

返回：

满足查询条件的多行数据。如果如果未找到，返回空列表。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

getRowsByRange

RowListing getRowsByRange(RangeRowQueryCriteria criteria,
                          String transactionId,
                          String nextToken)
                          throws OTSException,
                                 ClientException

返回表（Table）或视图（View）中主键（Primary Key）的特定范围内的多行数据。

参数：

criteria - 查询条件。

transactionId - 事务ID，不为空时操作在事务中进行。

nextToken - 查找的断点，当nextToken为null时，则为请求开始

返回：

满足查询条件的多行数据。如果如果未找到，返回空列表。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

putData

void putData(String tableName,
             RowPutChange rowChange,
             String transactionId)
             throws OTSException,
                    ClientException

插入一行或修改指定行中的数据。

参数：

tableName - 数据所在表（Table）的名称。

rowChange - 表示数据的修改信息。

transactionId - 事务ID，不为空时操作在事务中进行。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

deleteData

void deleteData(String tableName,
                RowDeleteChange rowChange,
                String transactionId)
                throws OTSException,
                       ClientException

删除指定行或行中的数据。

参数：

tableName - 数据所在表（Table）的名称。

rowChange - 表示数据的删除信息。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。

batchModifyData

void batchModifyData(String tableName,
                     Collection<RowChange> rowChanges,
                     String transactionId)
                     throws OTSException,
                            ClientException

把PutData和/或DeleteData的多次调用组合成一个调用。

参数：

tableName - 数据所在表（Table）的名称。

rowChanges - 表示数据的修改信息。 集合中可以包含RowPutChange和RowDeleteChange的实例。

抛出：

OTSException - OTS访问返回错误消息

ClientException - 请求的返回结果无效， 或由于网络原因请求失败， 或访问超时。