SyncClient (AliCloud TableStore SDK for Java 5.17.6 API)

java.lang.Object
- com.alicloud.openservices.tablestore.SyncClient

所有已实现的接口:: SyncClientInterface

public class SyncClient
extends Object
implements SyncClientInterface

嵌套类概要

嵌套类
限定符和类型类和说明

class SyncClient.DefaultPrepareCallback

嵌套类
限定符和类型	类和说明
`class`	`SyncClient.DefaultPrepareCallback`

构造器概要

构造器
构造器和说明
`SyncClient(String endpoint, CredentialsProvider credsProvider, String instanceName, ClientConfiguration config, ResourceManager resourceManager)`
`SyncClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName)` Constructs a new `SyncClient` instance using the specified TableStore Endpoint and default configuration.
`SyncClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config)` Constructs a new `SyncClient` instance using the specified TableStore Endpoint and configuration.
`SyncClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken)` Constructs a new `SyncClient` instance using the specified TableStore Endpoint and default configuration.
`SyncClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken, ExecutorService callbackExecutor)` Constructs a new `SyncClient` instance using the specified TableStore Endpoint and default configuration.
`SyncClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, String stsToken)` Constructs a new `SyncClient` instance using the specified TableStore Endpoint and default configuration.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AbortTransactionResponse`	`abortTransaction(AbortTransactionRequest request)` Cancel a transaction
`AddDefinedColumnResponse`	`addDefinedColumn(AddDefinedColumnRequest addDefinedColumnRequest)` Add a predefined column to a table.
`AsyncClientInterface`	`asAsyncClient()` Convert to the asynchronous interface Client.
`AsyncTimeseriesClient`	`asAsyncTimeseriesClient()`
`TimeseriesClient`	`asTimeseriesClient()`
`BatchGetRowResponse`	`batchGetRow(BatchGetRowRequest batchGetRowRequest)` Read multiple rows of data from multiple tables.
`BatchWriteRowResponse`	`batchWriteRow(BatchWriteRowRequest batchWriteRowRequest)` Perform update or delete operations on multiple rows across multiple tables.
`BulkExportResponse`	`bulkExport(BulkExportRequest bulkExportRequest)` Query multiple rows of data within a range from the table, offline service interface.
`BulkImportResponse`	`bulkImport(BulkImportRequest bulkImportRequest)` Perform update or delete operations on multiple rows in a single table, offline service interface.
`CommitTransactionResponse`	`commitTransaction(CommitTransactionRequest request)` Commit a transaction
`ComputeSplitsResponse`	`computeSplits(ComputeSplitsRequest request)` Get the partition information of the data.
`ComputeSplitsBySizeResponse`	`computeSplitsBySize(ComputeSplitsBySizeRequest computeSplitsBySizeRequest)` Splits the data of a table into chunks based on a certain data size, and returns the split information for use by the data retrieval interface.
`Iterator<Row>`	`createBulkExportIterator(RangeIteratorParameter rangeIteratorParameter)`
`CreateDeliveryTaskResponse`	`createDeliveryTask(CreateDeliveryTaskRequest request)` Create a data delivery task
`CreateIndexResponse`	`createIndex(CreateIndexRequest createIndexRequest)` Create an index table under a specified table as indicated by the user.
`RowIterator`	`createParallelScanIterator(ParallelScanRequest request)` Get the Iterator for ParallelScan.
`Iterator<Row>`	`createRangeIterator(RangeIteratorParameter rangeIteratorParameter)` Encapsulates the `SyncClientInterface.getRange(GetRangeRequest)` interface in iterator form.
`CreateSearchIndexResponse`	`createSearchIndex(CreateSearchIndexRequest request)` Create SearchIndex
`RowIterator`	`createSearchIterator(SearchRequest request)` Get the Iterator for Search.
`CreateTableResponse`	`createTable(CreateTableRequest createTableRequest)` Create a new table under the user's instance.
`WideColumnIterator`	`createWideColumnIterator(GetRowRequest getRowRequest)`
`DeleteDefinedColumnResponse`	`deleteDefinedColumn(DeleteDefinedColumnRequest deleteDefinedColumnRequest)` Delete a predefined column for a table
`DeleteDeliveryTaskResponse`	`deleteDeliveryTask(DeleteDeliveryTaskRequest request)` Delete the delivery task
`DeleteIndexResponse`	`deleteIndex(DeleteIndexRequest deleteIndexRequest)` Delete a specific index table under a specified table.
`DeleteRowResponse`	`deleteRow(DeleteRowRequest deleteRowRequest)` Delete a row of data from the table.
`DeleteSearchIndexResponse`	`deleteSearchIndex(DeleteSearchIndexRequest request)` Delete SearchIndex Specify the tableName and indexName to delete an index Note: It is not allowed to delete a table before all indexes under the table are deleted
`DeleteTableResponse`	`deleteTable(DeleteTableRequest deleteTableRequest)` Delete a table under a specified instance for the user.
`DescribeDeliveryTaskResponse`	`describeDeliveryTask(DescribeDeliveryTaskRequest request)` Delivery task description function
`DescribeSearchIndexResponse`	`describeSearchIndex(DescribeSearchIndexRequest request)` Get the information of a SearchIndex.
`DescribeStreamResponse`	`describeStream(DescribeStreamRequest describeStreamRequest)` Get the detailed information of the specified Stream.
`DescribeTableResponse`	`describeTable(DescribeTableRequest request)` Get the detailed information of a table, which includes: The structure of the table (`TableMeta`) The reserved throughput of the table (`ReservedThroughputDetails`) The configuration parameters of the table (`TableOptions`)
`String`	`getEndpoint()` Returns the TableStore Endpoint being accessed.
`String`	`getInstanceName()` Returns the name of the accessed instance
`GetRangeResponse`	`getRange(GetRangeRequest getRangeRequest)` Query multiple rows of data within a range from the table.
`GetRowResponse`	`getRow(GetRowRequest getRowRequest)` Read a single row of data from the table.
`GetShardIteratorResponse`	`getShardIterator(GetShardIteratorRequest getShardIteratorRequest)` Get the ShardIterator, which can be used to read data from a Shard.
`GetStreamRecordResponse`	`getStreamRecord(GetStreamRecordRequest getStreamRecordRequest)` Read data from a Shard using a ShardIterator.
`ListDeliveryTaskResponse`	`listDeliveryTask(ListDeliveryTaskRequest request)` List all delivery tasks under the user table
`ListSearchIndexResponse`	`listSearchIndex(ListSearchIndexRequest request)` Get the SearchIndex list under a table.
`ListStreamResponse`	`listStream(ListStreamRequest listStreamRequest)` Get the entire Stream list under the user's current instance or the Stream of a specific table.
`ListTableResponse`	`listTable()` Returns the list of all tables under the user's current instance.
`ParallelScanResponse`	`parallelScan(ParallelScanRequest request)` Scan data form SearchIndex.
`PutRowResponse`	`putRow(PutRowRequest putRowRequest)` Insert or overwrite a row of data in the table.
`SearchResponse`	`search(SearchRequest request)` Search functionality Build your own SearchRequest, then obtain the SearchResponse Example: `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`	`setCredentials(ServiceCredentials credentials)`
`void`	`setExtraHeaders(Map<String,String> extraHeaders)`
`void`	`setPrepareCallback(PrepareCallback cb)`
`void`	`shutdown()` Release resources.
`SQLQueryResponse`	`sqlQuery(SQLQueryRequest request)` SQL query request
`StartLocalTransactionResponse`	`startLocalTransaction(StartLocalTransactionRequest request)` Start a local transaction
`void`	`switchCredentialsProvider(CredentialsProvider newCrdsProvider)` Switch CredentialsProvider.
`UpdateRowResponse`	`updateRow(UpdateRowRequest updateRowRequest)` Updates a row of data in the table.
`UpdateSearchIndexResponse`	`updateSearchIndex(UpdateSearchIndexRequest request)` Update SearchIndex (for user index exchange, or setting index query weight)
`UpdateTableResponse`	`updateTable(UpdateTableRequest request)` Dynamically change the configuration or reserved throughput of a table after it has been created.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SyncClient
```
public SyncClient(String endpoint,
                  String accessKeyId,
                  String accessKeySecret,
                  String instanceName)
```
    Constructs a new SyncClient instance using the specified TableStore Endpoint and default configuration.
    
    参数:
    
    endpoint - The endpoint of the TableStore service.
    
    accessKeyId - The Access ID for accessing the TableStore service.
    
    accessKeySecret - The Access Key for accessing the TableStore service.
    
    instanceName - The instance name for accessing the TableStore service.
  - SyncClient
```
public SyncClient(String endpoint,
                  String accessKeyId,
                  String accessKeySecret,
                  String instanceName,
                  String stsToken)
```
    Constructs a new SyncClient instance using the specified TableStore Endpoint and default configuration.
    
    参数:
    
    endpoint - The endpoint of the TableStore service.
    
    accessKeyId - The Access ID for accessing the TableStore service.
    
    accessKeySecret - The Access Key for accessing the TableStore service.
    
    instanceName - The instance name for accessing the TableStore service.
    
    stsToken - Sts Token.
  - SyncClient
```
public SyncClient(String endpoint,
                  String accessKeyId,
                  String accessKeySecret,
                  String instanceName,
                  ClientConfiguration config)
```
    Constructs a new SyncClient instance using the specified TableStore Endpoint and configuration.
    
    参数:
    
    endpoint - The endpoint of the TableStore service.
    
    accessKeyId - The Access ID for accessing the TableStore service.
    
    accessKeySecret - The Access Key for accessing the TableStore service.
    
    instanceName - The instance name for accessing the TableStore service.
    
    config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.
  - SyncClient
```
public SyncClient(String endpoint,
                  String accessKeyId,
                  String accessKeySecret,
                  String instanceName,
                  ClientConfiguration config,
                  String stsToken)
```
    Constructs a new SyncClient instance using the specified TableStore Endpoint and default configuration.
    
    参数:
    
    endpoint - The endpoint of the TableStore service.
    
    accessKeyId - The Access ID for accessing the TableStore service.
    
    accessKeySecret - The Access Key for accessing the TableStore service.
    
    instanceName - The instance name for accessing the TableStore service.
    
    config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.
    
    stsToken - Sts Token.
  - SyncClient
```
public SyncClient(String endpoint,
                  String accessKeyId,
                  String accessKeySecret,
                  String instanceName,
                  ClientConfiguration config,
                  String stsToken,
                  ExecutorService callbackExecutor)
```
    Constructs a new SyncClient instance using the specified TableStore Endpoint and default configuration.
    
    参数:
    
    endpoint - The endpoint of the TableStore service.
    
    accessKeyId - The Access ID for accessing the TableStore service.
    
    accessKeySecret - The Access Key for accessing the TableStore service.
    
    instanceName - The instance name for accessing the TableStore service.
    
    config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.
    
    stsToken - Sts Token.
    
    callbackExecutor - The thread pool for executing callbacks. Note that this thread pool will also be shut down when the client is shut down.
  - SyncClient
```
public SyncClient(String endpoint,
                  CredentialsProvider credsProvider,
                  String instanceName,
                  ClientConfiguration config,
                  ResourceManager resourceManager)
```
- 方法详细资料
  - setExtraHeaders
```
public void setExtraHeaders(Map<String,String> extraHeaders)
```
  - getEndpoint
```
public String getEndpoint()
```
    Returns the TableStore Endpoint being accessed.
    
    返回:
    
    TableStore Endpoint.
  - getInstanceName
```
public String getInstanceName()
```
    Returns the name of the accessed instance
    
    返回:
    
    instance name
  - createTable
```
public CreateTableResponse createTable(CreateTableRequest createTableRequest)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Create a new table under the user's instance.
    The table cannot be read from or written to immediately after creation; you need to wait a few seconds.
    
    指定者:
    
    createTable 在接口中 SyncClientInterface
    
    参数:
    
    createTableRequest - Parameters required for executing CreateTable
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request return result, or network exception encountered
  - listTable
```
public ListTableResponse listTable()
                            throws TableStoreException,
                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Returns the list of all tables under the user's current instance.
    
    指定者:
    
    listTable 在接口中 SyncClientInterface
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - describeTable
```
public DescribeTableResponse describeTable(DescribeTableRequest request)
                                    throws TableStoreException,
                                           ClientException
```
    从接口复制的说明: SyncClientInterface
    Get the detailed information of a table, which includes:
    - The structure of the table (TableMeta)
    - The reserved throughput of the table (ReservedThroughputDetails)
    - The configuration parameters of the table (TableOptions)
    指定者:
    
    describeTable 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to execute DescribeTable
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid response from the request or network exception encountered
  - deleteTable
```
public DeleteTableResponse deleteTable(DeleteTableRequest deleteTableRequest)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete a table under a specified instance for the user.
    Caution: After the table is successfully deleted, all data under the table will be cleared and cannot be recovered. Please operate with caution!
    
    指定者:
    
    deleteTable 在接口中 SyncClientInterface
    
    参数:
    
    deleteTableRequest - Parameters required to execute DeleteTable
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid return result of the request or network exception encountered
  - updateTable
```
public UpdateTableResponse updateTable(UpdateTableRequest request)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    Dynamically change the configuration or reserved throughput of a table after it has been created.
    For example, if a user wants to adjust the table's TTL, MaxVersions, etc., or if the user finds that the current reserved throughput is too low and needs to be increased.
    
    The UpdateTable operation cannot be used to change the table's TableMeta. The adjustable configurations are:
    - Reserved throughput (ReservedThroughput): A table's reserved throughput can be dynamically changed; read or write throughput can be adjusted separately. The minimum time interval for adjusting each table's read/write throughput is 1 minute. If this UpdateTable operation occurs less than 1 minute after the last UpdateTable or CreateTable operation, the request will be rejected.
    - Table options (TableOptions): Only some configuration items of the table can be dynamically changed, such as TTL, MaxVersions, etc.
    After the UpdateTable operation is completed, it will return the table's current reserved throughput and configuration after the changes.
    指定者:
    
    updateTable 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to execute UpdateTable
    
    返回:
    
    Result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid response from the request, or network exception encountered
  - createIndex
```
public CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Create an index table under a specified table as indicated by the user.
    
    指定者:
    
    createIndex 在接口中 SyncClientInterface
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - The returned result is invalid, or a network exception was encountered
  - deleteIndex
```
public DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete a specific index table under a specified table.
    Caution: After the index table is successfully deleted, all data under that index table will be cleared and cannot be recovered. Please operate with caution!
    
    指定者:
    
    deleteIndex 在接口中 SyncClientInterface
    
    参数:
    
    deleteIndexRequest - Parameters required to execute DeleteIndex
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid return result of the request or network exception encountered
  - addDefinedColumn
```
public AddDefinedColumnResponse addDefinedColumn(AddDefinedColumnRequest addDefinedColumnRequest)
                                          throws TableStoreException,
                                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Add a predefined column to a table.
    
    指定者:
    
    addDefinedColumn 在接口中 SyncClientInterface
    
    参数:
    
    addDefinedColumnRequest - Parameters required for executing AddDefinedColumn.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - An exception returned by the TableStore service.
    
    ClientException - The returned result of the request is invalid, or a network exception occurred.
  - deleteDefinedColumn
```
public DeleteDefinedColumnResponse deleteDefinedColumn(DeleteDefinedColumnRequest deleteDefinedColumnRequest)
                                                throws TableStoreException,
                                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete a predefined column for a table
    
    指定者:
    
    deleteDefinedColumn 在接口中 SyncClientInterface
    
    参数:
    
    deleteDefinedColumnRequest - Parameters required to execute DeleteDefinedColumn
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request return or network exception encountered
  - getRow
```
public GetRowResponse getRow(GetRowRequest getRowRequest)
                      throws TableStoreException,
                             ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Read a single row of data from the table.
    
    指定者:
    
    getRow 在接口中 SyncClientInterface
    
    参数:
    
    getRowRequest - Parameters required to perform the GetRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request response or network exception encountered.
  - putRow
```
public PutRowResponse putRow(PutRowRequest putRowRequest)
                      throws TableStoreException,
                             ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Insert or overwrite a row of data in the table.
    If the row to be written already exists, the old row will be deleted and a new one will be written.
    
    If the row to be written does not exist, a new row will be directly written.
    
    指定者:
    
    putRow 在接口中 SyncClientInterface
    
    参数:
    
    putRowRequest - Parameters required for performing the PutRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid response from the request or network exception encountered.
  - updateRow
```
public UpdateRowResponse updateRow(UpdateRowRequest updateRowRequest)
                            throws TableStoreException,
                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Updates a row of data in the table.
    If the row to be updated does not exist, a new row of data is written.
    
    The update operation can include writing a new attribute column or deleting one or more versions of an attribute column.
    
    指定者:
    
    updateRow 在接口中 SyncClientInterface
    
    参数:
    
    updateRowRequest - Parameters required for the UpdateRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - The returned result of the request is invalid, or a network exception was encountered.
  - deleteRow
```
public DeleteRowResponse deleteRow(DeleteRowRequest deleteRowRequest)
                            throws TableStoreException,
                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete a row of data from the table.
    If the row exists, it will be deleted.
    
    If the row does not exist, this operation will have no effect.
    
    指定者:
    
    deleteRow 在接口中 SyncClientInterface
    
    参数:
    
    deleteRowRequest - Parameters required for performing the DeleteRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid response or network exception encountered during the request.
  - batchGetRow
```
public BatchGetRowResponse batchGetRow(BatchGetRowRequest batchGetRowRequest)
                                throws TableStoreException,
                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Read multiple rows of data from multiple tables.
    The BatchGetRow operation can be regarded as a collection of multiple GetRow operations. Each operation is executed independently, returns results independently, and calculates service capability units independently.
    
    Compared to executing a large number of GetRow operations, using the BatchGetRow operation can effectively reduce the response time of requests and increase the data read rate.
    
    However, note that BatchGetRow only supports setting query conditions at the table level. After the operation is completed, the status of each sub-request needs to be checked individually, and retries can be attempted for failed rows.
    
    指定者:
    
    batchGetRow 在接口中 SyncClientInterface
    
    参数:
    
    batchGetRowRequest - Parameters required to execute the BatchGetRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request return result or network exception encountered.
  - batchWriteRow
```
public BatchWriteRowResponse batchWriteRow(BatchWriteRowRequest batchWriteRowRequest)
                                    throws TableStoreException,
                                           ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Perform update or delete operations on multiple rows across multiple tables.
    The BatchWriteRow operation can be considered as a collection of multiple PutRow, UpdateRow, and DeleteRow operations. Each operation is executed independently, returns results independently, and calculates service capability units independently.
    
    After executing the BatchWriteRow operation, it is necessary to check the status of each sub-request individually to determine the write result and choose to retry for failed rows.
    
    指定者:
    
    batchWriteRow 在接口中 SyncClientInterface
    
    参数:
    
    batchWriteRowRequest - Parameters required to execute the BatchWriteRow operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid response or network exception encountered during the request.
  - bulkImport
```
public BulkImportResponse bulkImport(BulkImportRequest bulkImportRequest)
                              throws TableStoreException,
                                     ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Perform update or delete operations on multiple rows in a single table, offline service interface.
    The BulkImport operation can be regarded as a collection of multiple PutRow, UpdateRow, DeleteRow operations. Each operation is executed independently, returns results independently, and consumes units independently.
    
    After executing the BulkImport operation, it is necessary to check the status of each sub-request individually to determine the write result and choose to retry the failed rows.
    
    指定者:
    
    bulkImport 在接口中 SyncClientInterface
    
    参数:
    
    bulkImportRequest - Parameters required to execute the BatchWriteRow operation.
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request return result, or network exception encountered
  - getRange
```
public GetRangeResponse getRange(GetRangeRequest getRangeRequest)
                          throws TableStoreException,
                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Query multiple rows of data within a range from the table.
    
    指定者:
    
    getRange 在接口中 SyncClientInterface
    
    参数:
    
    getRangeRequest - Parameters required for performing the GetRange operation.
    
    返回:
    
    The result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request return or network exception encountered
  - bulkExport
```
public BulkExportResponse bulkExport(BulkExportRequest bulkExportRequest)
                              throws TableStoreException,
                                     ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Query multiple rows of data within a range from the table, offline service interface.
    
    指定者:
    
    bulkExport 在接口中 SyncClientInterface
    
    参数:
    
    bulkExportRequest - Parameters required to execute the GetRange operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request return or network exception encountered.
  - computeSplitsBySize
```
public ComputeSplitsBySizeResponse computeSplitsBySize(ComputeSplitsBySizeRequest computeSplitsBySizeRequest)
                                                throws TableStoreException,
                                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Splits the data of a table into chunks based on a certain data size, and returns the split information for use by the data retrieval interface. The returned data chunks are arranged in ascending order of the primary key column. Each chunk of data contains the hash value of the partition ID where the chunk is located, as well as the primary key values of the starting and ending rows, following the left-closed-right-open interval.
    
    指定者:
    
    computeSplitsBySize 在接口中 SyncClientInterface
    
    参数:
    
    computeSplitsBySizeRequest - Parameters required to execute the ComputeSplitsBySize operation.
    
    返回:
    
    Result returned by the TableStore service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - createRangeIterator
```
public Iterator<Row> createRangeIterator(RangeIteratorParameter rangeIteratorParameter)
                                  throws TableStoreException,
                                         ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Encapsulates the SyncClientInterface.getRange(GetRangeRequest) interface in iterator form.
    
    指定者:
    
    createRangeIterator 在接口中 SyncClientInterface
    
    参数:
    
    rangeIteratorParameter - The parameters required to execute the createRangeIterator operation.
    
    返回:
    
    Iterator for rows
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - createBulkExportIterator
```
public Iterator<Row> createBulkExportIterator(RangeIteratorParameter rangeIteratorParameter)
                                       throws TableStoreException,
                                              ClientException
```
    指定者:
    
    createBulkExportIterator 在接口中 SyncClientInterface
    
    抛出:
    
    TableStoreException
    
    ClientException
  - createWideColumnIterator
```
public WideColumnIterator createWideColumnIterator(GetRowRequest getRowRequest)
                                            throws TableStoreException,
                                                   ClientException
```
    指定者:
    
    createWideColumnIterator 在接口中 SyncClientInterface
    
    抛出:
    
    TableStoreException
    
    ClientException
  - listStream
```
public ListStreamResponse listStream(ListStreamRequest listStreamRequest)
                              throws TableStoreException,
                                     ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the entire Stream list under the user's current instance or the Stream of a specific table.
    
    指定者:
    
    listStream 在接口中 SyncClientInterface
    
    参数:
    
    listStreamRequest - Parameters required for performing the ListStream operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request response or network exception encountered.
  - describeStream
```
public DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest)
                                      throws TableStoreException,
                                             ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the detailed information of the specified Stream. Use this method to obtain the Shard list.
    
    指定者:
    
    describeStream 在接口中 SyncClientInterface
    
    参数:
    
    describeStreamRequest - Parameters required for the DescribeStream operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request return or network exception encountered.
  - getShardIterator
```
public GetShardIteratorResponse getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
                                          throws TableStoreException,
                                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the ShardIterator, which can be used to read data from a Shard.
    
    指定者:
    
    getShardIterator 在接口中 SyncClientInterface
    
    参数:
    
    getShardIteratorRequest - Parameters required to execute the GetShardIterator operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request response or network exception encountered.
  - getStreamRecord
```
public GetStreamRecordResponse getStreamRecord(GetStreamRecordRequest getStreamRecordRequest)
                                        throws TableStoreException,
                                               ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Read data from a Shard using a ShardIterator.
    
    指定者:
    
    getStreamRecord 在接口中 SyncClientInterface
    
    参数:
    
    getStreamRecordRequest - Parameters required to perform the GetStreamRecord operation.
    
    返回:
    
    The result returned by the TableStore service.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid request response or network exception encountered.
  - createSearchIndex
```
public CreateSearchIndexResponse createSearchIndex(CreateSearchIndexRequest request)
                                            throws TableStoreException,
                                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Create SearchIndex
    
    指定者:
    
    createSearchIndex 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for creating a SearchIndex, see CreateSearchIndexRequest
    
    返回:
    
    The creation result returned by the SearchIndex service
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid response from the request or network exception encountered
  - updateSearchIndex
```
public UpdateSearchIndexResponse updateSearchIndex(UpdateSearchIndexRequest request)
                                            throws TableStoreException,
                                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Update SearchIndex (for user index exchange, or setting index query weight)
    
    指定者:
    
    updateSearchIndex 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for updating the SearchIndex, see UpdateSearchIndexRequest
    
    返回:
    
    The result returned by the SearchIndex service after creation
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - listSearchIndex
```
public ListSearchIndexResponse listSearchIndex(ListSearchIndexRequest request)
                                        throws TableStoreException,
                                               ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the SearchIndex list under a table.
    There can be multiple SearchIndex tables under a single table. Through this function, you can retrieve all SearchIndex information under a table.
    
    指定者:
    
    listSearchIndex 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to get the SearchIndex list.
    
    返回:
    
    The SearchIndex list under the specified TableStore table.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid response result or network exception encountered during the request.
  - deleteSearchIndex
```
public DeleteSearchIndexResponse deleteSearchIndex(DeleteSearchIndexRequest request)
                                            throws TableStoreException,
                                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete SearchIndex
    Specify the tableName and indexName to delete an index
    
    Note: It is not allowed to delete a table before all indexes under the table are deleted
    
    指定者:
    
    deleteSearchIndex 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for deleting SearchIndex
    
    返回:
    
    The deletion result returned after the deletion of the SearchIndex service is executed
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request return or network exception encountered
  - describeSearchIndex
```
public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)
                                                throws TableStoreException,
                                                       ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the information of a SearchIndex.
    
    指定者:
    
    describeSearchIndex 在接口中 SyncClientInterface
    
    参数:
    
    request - The parameters required to get the SearchIndex (tableName and indexName).
    
    返回:
    
    Returns the schema of the specified index and its current synchronization status information.
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service.
    
    ClientException - Invalid response from the request or a network exception encountered.
  - computeSplits
```
public ComputeSplitsResponse computeSplits(ComputeSplitsRequest request)
                                    throws TableStoreException,
                                           ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the partition information of the data.
    
    指定者:
    
    computeSplits 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to perform the computeSplits operation.
    
    返回:
    
    Results returned by the Tablestore service
    
    抛出:
    
    TableStoreException - Exception returned by Tablestore service.
    
    ClientException - The return result of the request is invalid or a network exception was encountered.
  - parallelScan
```
public ParallelScanResponse parallelScan(ParallelScanRequest request)
                                  throws TableStoreException,
                                         ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Scan data form SearchIndex.
    
    指定者:
    
    parallelScan 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to perform the parallelScan operation.
    
    返回:
    
    Results returned by the Tablestore service
    
    抛出:
    
    TableStoreException - Exception returned by Tablestore service.
    
    ClientException - The return result of the request is invalid or a network exception was encountered.
  - createParallelScanIterator
```
public RowIterator createParallelScanIterator(ParallelScanRequest request)
                                       throws TableStoreException,
                                              ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the Iterator for ParallelScan.
    
    指定者:
    
    createParallelScanIterator 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to perform ParallelScan operation.
    
    返回:
    
    Iterator for ParallelScan.
    
    抛出:
    
    TableStoreException - Exception returned by Tablestore service.
    
    ClientException - The return result of the request is invalid or a network exception was encountered.
  - createSearchIterator
```
public RowIterator createSearchIterator(SearchRequest request)
                                 throws TableStoreException,
                                        ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Get the Iterator for Search.
    Note: If your searchIndex has a nested field and you want to search data, please specify the Sort.
    
    指定者:
    
    createSearchIterator 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to perform searchRequest operation.
    
    返回:
    
    Iterator for SearchQuery.
    
    抛出:
    
    TableStoreException - Exception returned by Tablestore service.
    
    ClientException - The return result of the request is invalid or a network exception was encountered.
  - search
```
public SearchResponse search(SearchRequest request)
                      throws TableStoreException,
                             ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Search functionality
    Build your own SearchRequest, then obtain the SearchResponse
    
    Example:
    
    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);
    
    指定者:
    
    search 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for performing a search, see SearchRequest for details
    
    返回:
    
    Search results, see SearchResponse for details
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid response from the request or network exception encountered
  - startLocalTransaction
```
public StartLocalTransactionResponse startLocalTransaction(StartLocalTransactionRequest request)
                                                    throws TableStoreException,
                                                           ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Start a local transaction
    
    指定者:
    
    startLocalTransaction 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for initiating a local transaction operation
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - The response is invalid or a network exception occurs
  - commitTransaction
```
public CommitTransactionResponse commitTransaction(CommitTransactionRequest request)
                                            throws TableStoreException,
                                                   ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Commit a transaction
    
    指定者:
    
    commitTransaction 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for the commit transaction operation
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - abortTransaction
```
public AbortTransactionResponse abortTransaction(AbortTransactionRequest request)
                                          throws TableStoreException,
                                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Cancel a transaction
    
    指定者:
    
    abortTransaction 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for the cancel transaction operation
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid request response or network exception encountered
  - createDeliveryTask
```
public CreateDeliveryTaskResponse createDeliveryTask(CreateDeliveryTaskRequest request)
                                              throws TableStoreException,
                                                     ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Create a data delivery task
    
    指定者:
    
    createDeliveryTask 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to create the delivery task
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the TableStore service
    
    ClientException - Invalid response from the request or network exception encountered
  - deleteDeliveryTask
```
public DeleteDeliveryTaskResponse deleteDeliveryTask(DeleteDeliveryTaskRequest request)
                                              throws TableStoreException,
                                                     ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delete the delivery task
    
    指定者:
    
    deleteDeliveryTask 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required for deleting the delivery task
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the Tablestore service
    
    ClientException - The request results are invalid, or a network exception is encountered
  - describeDeliveryTask
```
public DescribeDeliveryTaskResponse describeDeliveryTask(DescribeDeliveryTaskRequest request)
                                                  throws TableStoreException,
                                                         ClientException
```
    从接口复制的说明: SyncClientInterface
    
    Delivery task description function
    
    指定者:
    
    describeDeliveryTask 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to describe the delivery task
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the Tablestore service
    
    ClientException - The request result is invalid or a network exception is encountered
  - listDeliveryTask
```
public ListDeliveryTaskResponse listDeliveryTask(ListDeliveryTaskRequest request)
                                          throws TableStoreException,
                                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    List all delivery tasks under the user table
    
    指定者:
    
    listDeliveryTask 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters required to get the list of delivery tasks
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the Tablestore service
    
    ClientException - The result of the request is invalid, or a network exception was encountered
  - sqlQuery
```
public SQLQueryResponse sqlQuery(SQLQueryRequest request)
                          throws TableStoreException,
                                 ClientException
```
    从接口复制的说明: SyncClientInterface
    
    SQL query request
    
    指定者:
    
    sqlQuery 在接口中 SyncClientInterface
    
    参数:
    
    request - Parameters for SQL query
    
    返回:
    
    抛出:
    
    TableStoreException - Exception returned by the Tablestore service
    
    ClientException - Request result is invalid or a network exception is encountered
  - asAsyncClient
```
public AsyncClientInterface asAsyncClient()
```
    从接口复制的说明: SyncClientInterface
    
    Convert to the asynchronous interface Client.
    
    指定者:
    
    asAsyncClient 在接口中 SyncClientInterface
    
    返回:
    
    Asynchronous interface Client.
  - asTimeseriesClient
```
public TimeseriesClient asTimeseriesClient()
```
  - asAsyncTimeseriesClient
```
public AsyncTimeseriesClient asAsyncTimeseriesClient()
```
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: SyncClientInterface
    
    Release resources.
    Make sure to release resources after all requests have been executed. After releasing resources, no further requests can be sent, and ongoing requests may not return results.
    
    指定者:
    
    shutdown 在接口中 SyncClientInterface
  - setPrepareCallback
```
public void setPrepareCallback(PrepareCallback cb)
```
  - setCredentials
```
public void setCredentials(ServiceCredentials credentials)
```
  - switchCredentialsProvider
```
public void switchCredentialsProvider(CredentialsProvider newCrdsProvider)
```
    从接口复制的说明: SyncClientInterface
    
    Switch CredentialsProvider.
    
    指定者:
    
    switchCredentialsProvider 在接口中 SyncClientInterface
    
    参数:
    
    newCrdsProvider - new CredentialsProvider, see CredentialsProviderFactory.

类 SyncClient

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SyncClient

SyncClient

SyncClient

SyncClient

SyncClient

SyncClient

方法详细资料

setExtraHeaders

getEndpoint

getInstanceName

createTable

listTable

describeTable

deleteTable

updateTable

createIndex

deleteIndex

addDefinedColumn

deleteDefinedColumn

getRow

putRow

updateRow

deleteRow

batchGetRow

batchWriteRow

bulkImport

getRange

bulkExport

computeSplitsBySize

createRangeIterator

createBulkExportIterator

createWideColumnIterator

listStream

describeStream

getShardIterator

getStreamRecord

createSearchIndex

updateSearchIndex

listSearchIndex

deleteSearchIndex

describeSearchIndex

computeSplits

parallelScan

createParallelScanIterator

createSearchIterator

search

startLocalTransaction

commitTransaction

abortTransaction

createDeliveryTask

deleteDeliveryTask

describeDeliveryTask

listDeliveryTask

sqlQuery

asAsyncClient

asTimeseriesClient

asAsyncTimeseriesClient

shutdown

setPrepareCallback

setCredentials

switchCredentialsProvider