public interface SyncClientInterface
阿里云表格存储(TableStore)是构建在阿里云大规模分布式计算系统之上的海量数据存储与实时查询的服务。
限定符和类型 | 方法和说明 |
---|---|
AbortTransactionResponse |
abortTransaction(AbortTransactionRequest request)
取消一个事务
|
AsyncClientInterface |
asAsyncClient()
转换成异步接口的Client。
|
BatchGetRowResponse |
batchGetRow(BatchGetRowRequest batchGetRowRequest)
从多张表中读取多行数据。
|
BatchWriteRowResponse |
batchWriteRow(BatchWriteRowRequest batchWriteRowRequest)
对多张表中对多行执行更新或者删除操作。
|
CommitTransactionResponse |
commitTransaction(CommitTransactionRequest request)
提交一个事务
|
ComputeSplitsBySizeResponse |
computeSplitsBySize(ComputeSplitsBySizeRequest computeSplitsBySizeRequest)
对表的数据根据一定的数据大小进行分块,并返回分块的信息以供数据获取接口使用。
|
CreateIndexResponse |
createIndex(CreateIndexRequest createIndexRequest)
在用户指定的某张表下创建一张索引表
|
Iterator<Row> |
createRangeIterator(RangeIteratorParameter rangeIteratorParameter)
以迭代器的形式封装
getRange(GetRangeRequest) 接口。 |
CreateSearchIndexResponse |
createSearchIndex(CreateSearchIndexRequest request)
创建SearchIndex
|
CreateTableResponse |
createTable(CreateTableRequest createTableRequest)
在用户的实例下创建一张新的表。
|
WideColumnIterator |
createWideColumnIterator(GetRowRequest getRowRequest) |
DeleteIndexResponse |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
删除用户指定的某张表下的某张索引表
注意:索引表被成功删除后该索引表下所有的数据都将被清空,无法恢复,请谨慎操作!
|
DeleteRowResponse |
deleteRow(DeleteRowRequest deleteRowRequest)
删除表中的一行数据。
|
DeleteSearchIndexResponse |
deleteSearchIndex(DeleteSearchIndexRequest request)
删除SearchIndex
通过指定 tableName 和 indexName 即可删除一个index
提示:在没有删除一个table下面所有的index之前,是不允许删除table的
|
DeleteTableResponse |
deleteTable(DeleteTableRequest deleteTableRequest)
删除用户指定的某个实例下的一张表。。
|
DescribeSearchIndexResponse |
describeSearchIndex(DescribeSearchIndexRequest request)
获取一个SearchIndex的信息
|
DescribeStreamResponse |
describeStream(DescribeStreamRequest describeStreamRequest)
获取指定Stream的详细信息。
|
DescribeTableResponse |
describeTable(DescribeTableRequest describeTableRequest)
|
GetRangeResponse |
getRange(GetRangeRequest getRangeRequest)
从表中查询一个范围内的多行数据。
|
GetRowResponse |
getRow(GetRowRequest getRowRequest)
读取表中的一行数据。
|
GetShardIteratorResponse |
getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
获取ShardIterator,可通过ShardIterator读取Shard中的数据。
|
GetStreamRecordResponse |
getStreamRecord(GetStreamRecordRequest getStreamRecordRequest)
通过ShardIterator读取Shard中的数据。
|
ListSearchIndexResponse |
listSearchIndex(ListSearchIndexRequest request)
获取表下的SearchIndex列表
一个table下面,可以存在多个SearchIndex表,通过该函数,将能够获取一个table下面的所有SearchIndex信息
|
ListStreamResponse |
listStream(ListStreamRequest listStreamRequest)
获取用户当前实例下的全部Stream列表或者特定表下的Stream。
|
ListTableResponse |
listTable()
返回用户当前实例下的所有表的列表。
|
PutRowResponse |
putRow(PutRowRequest putRowRequest)
向表中插入或覆盖一行数据。
|
SearchResponse |
search(SearchRequest request)
搜索功能
构建自己的SearchRequest,然后获取SearchResponse
示例:
SearchQuery searchQuery = new SearchQuery();
TermQuery termQuery = new TermQuery();
termQuery.setFieldName("user_name");
termQuery.setTerm("jay");
searchQuery.setQuery(termQuery);
SearchRequest searchRequest = new SearchRequest(tableName, indexName, searchQuery);
SearchResponse resp = ots.search(searchRequest);
|
void |
shutdown()
释放资源。
|
StartLocalTransactionResponse |
startLocalTransaction(StartLocalTransactionRequest request)
开启一个本地事务
|
void |
switchCredentialsProvider(CredentialsProvider newCrdsProvider)
Switch CredentialsProvider。
|
UpdateRowResponse |
updateRow(UpdateRowRequest updateRowRequest)
更新表中的一行数据。
|
UpdateTableResponse |
updateTable(UpdateTableRequest updateTableRequest)
在表被创建之后,动态的更改表的配置或预留吞吐量。
|
CreateTableResponse createTable(CreateTableRequest createTableRequest) throws TableStoreException, ClientException
表被创建后不能立即进行读写操作, 需要等待几秒钟.
createTableRequest
- 执行CreateTable所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常UpdateTableResponse updateTable(UpdateTableRequest updateTableRequest) throws TableStoreException, ClientException
例如用户想要调整表的TTL、MaxVersions等配置或者用户发现当前预留吞吐量过小需要上调预留吞吐量。
UpdateTable操作不能用于更改表的TableMeta,可以调整的配置为:
ReservedThroughput
):
表的预留吞吐量可被动态更改,读或写吞吐量都可以分别单独更改。调整每个表读写吞吐量的最小时间间隔为 1 分钟,
如果本次 UpdateTable 操作距上次 UpdateTable 或者 CreateTable 操作不到 1 分钟的话该请求将被拒绝。
TableOptions
):
只有表的部分配置项可以允许被动态更改,例如TTL、MaxVersions等。
updateTableRequest
- 执行UpdateTable所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DescribeTableResponse describeTable(DescribeTableRequest describeTableRequest) throws TableStoreException, ClientException
获取表的详细信息,表的详细信息包括:
TableMeta
)ReservedThroughputDetails
)TableOptions
)describeTableRequest
- 执行DescribeTable所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常ListTableResponse listTable() throws TableStoreException, ClientException
TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DeleteTableResponse deleteTable(DeleteTableRequest deleteTableRequest) throws TableStoreException, ClientException
注意:表被成功删除后该表下所有的数据都将会被清空,无法恢复,请谨慎操作!
deleteTableRequest
- 执行DeleteTable所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws TableStoreException, ClientException
createIndexRequest
- TableStoreException
- TableStore服务返回的异常ClientException
- 请求返回的结果无效,或遇到网络异常DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws TableStoreException, ClientException
注意:索引表被成功删除后该索引表下所有的数据都将被清空,无法恢复,请谨慎操作!
deleteIndexRequest
- 招待DeleteIndex所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常GetRowResponse getRow(GetRowRequest getRowRequest) throws TableStoreException, ClientException
getRowRequest
- 执行GetRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常PutRowResponse putRow(PutRowRequest putRowRequest) throws TableStoreException, ClientException
若要写入的行已经存在,则旧行会被删除后写入新的一行。
若要写入的行不存在,则直接写入新的一行。
putRowRequest
- 执行PutRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常UpdateRowResponse updateRow(UpdateRowRequest updateRowRequest) throws TableStoreException, ClientException
若要更新的行不存在,则新写入一行数据。
更新操作可以包括新写入一个属性列或者删除一个属性列的一个或多个版本。
updateRowRequest
- 执行UpdateRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DeleteRowResponse deleteRow(DeleteRowRequest deleteRowRequest) throws TableStoreException, ClientException
若该行存在,则删除该行。
若该行不存在,则该操作不产生任何影响。
deleteRowRequest
- 执行DeleteRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常BatchGetRowResponse batchGetRow(BatchGetRowRequest batchGetRowRequest) throws TableStoreException, ClientException
BatchGetRow 操作可视为多个 GetRow 操作的集合,各个操作独立执行,独立返回结果,独立计算服务能力单元。
与执行大量的 GetRow 操作相比,使用 BatchGetRow 操作可以有效减少请求的响应时间,提高数据的读取速率。
但需要注意的是 BatchGetRow 只支持在表级别设置查询条件。操作完成后,需要逐个检查子请求的状态,并选择对失败的行进行重试。
batchGetRowRequest
- 执行BatchGetRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常BatchWriteRowResponse batchWriteRow(BatchWriteRowRequest batchWriteRowRequest) throws TableStoreException, ClientException
BatchWriteRow 操作可视为多个PutRow、UpdateRow、DeleteRow 操作的集合,各个操作独立执行,独立返回结果,独立计算服务能力单元。
执行 BatchWriteRow 操作后,需要逐个检查子请求的状态,来判断写入结果,并选择对失败的行进行重试。
batchWriteRowRequest
- 执行BatchWriteRow操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常GetRangeResponse getRange(GetRangeRequest getRangeRequest) throws TableStoreException, ClientException
getRangeRequest
- 执行GetRange操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常ComputeSplitsBySizeResponse computeSplitsBySize(ComputeSplitsBySizeRequest computeSplitsBySizeRequest) throws TableStoreException, ClientException
computeSplitsBySizeRequest
- 执行ComputeSplitsBySize操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常Iterator<Row> createRangeIterator(RangeIteratorParameter rangeIteratorParameter) throws TableStoreException, ClientException
getRange(GetRangeRequest)
接口。rangeIteratorParameter
- 执行createRangeIterator操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常WideColumnIterator createWideColumnIterator(GetRowRequest getRowRequest) throws TableStoreException, ClientException
ListStreamResponse listStream(ListStreamRequest listStreamRequest) throws TableStoreException, ClientException
listStreamRequest
- 执行ListStream操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws TableStoreException, ClientException
describeStreamRequest
- 执行DescribeStream操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常GetShardIteratorResponse getShardIterator(GetShardIteratorRequest getShardIteratorRequest) throws TableStoreException, ClientException
getShardIteratorRequest
- 执行GetShardIterator操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常GetStreamRecordResponse getStreamRecord(GetStreamRecordRequest getStreamRecordRequest) throws TableStoreException, ClientException
getStreamRecordRequest
- 执行GetStreamRecord操作所需的参数。TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常CreateSearchIndexResponse createSearchIndex(CreateSearchIndexRequest request) throws TableStoreException, ClientException
request
- 创建SearchIndex所需的参数,详见CreateSearchIndexRequest
TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常ListSearchIndexResponse listSearchIndex(ListSearchIndexRequest request) throws TableStoreException, ClientException
一个table下面,可以存在多个SearchIndex表,通过该函数,将能够获取一个table下面的所有SearchIndex信息
request
- 获取SearchIndex列表所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DeleteSearchIndexResponse deleteSearchIndex(DeleteSearchIndexRequest request) throws TableStoreException, ClientException
通过指定 tableName 和 indexName 即可删除一个index
提示:在没有删除一个table下面所有的index之前,是不允许删除table的
request
- 删除SearchIndex所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request) throws TableStoreException, ClientException
request
- 获取SearchIndex所需的参数(tableName 和 indexName)TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常SearchResponse search(SearchRequest request) throws TableStoreException, ClientException
构建自己的SearchRequest,然后获取SearchResponse
示例:
SearchQuery searchQuery = new SearchQuery();
TermQuery termQuery = new TermQuery();
termQuery.setFieldName("user_name");
termQuery.setTerm("jay");
searchQuery.setQuery(termQuery);
SearchRequest searchRequest = new SearchRequest(tableName, indexName, searchQuery);
SearchResponse resp = ots.search(searchRequest);
request
- 进行搜索所需的参数,详见SearchRequest
SearchResponse
TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常StartLocalTransactionResponse startLocalTransaction(StartLocalTransactionRequest request) throws TableStoreException, ClientException
request
- 启动本地事务操作所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常CommitTransactionResponse commitTransaction(CommitTransactionRequest request) throws TableStoreException, ClientException
request
- 提交事务操作所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常AbortTransactionResponse abortTransaction(AbortTransactionRequest request) throws TableStoreException, ClientException
request
- 取消事务操作所需的参数TableStoreException
- TableStore服务返回的异常ClientException
- 请求的返回结果无效、或遇到网络异常AsyncClientInterface asAsyncClient()
void shutdown()
请确保在所有请求执行完毕之后释放资源。释放资源之后将不能再发送请求,正在执行的请求可能无法返回结果。
void switchCredentialsProvider(CredentialsProvider newCrdsProvider)
newCrdsProvider
- new CredentialsProvider, see CredentialsProviderFactory
.Copyright © 2019. All Rights Reserved.