All Products
Search
Document Center

Tablestore:Operation summary

Last Updated:Jun 14, 2024

This topic describes how to call Tablestore API operations and lists the API operations available for the Wide Column and TimeSeries models.

Call method

To call Tablestore API operations, you must use SDKs that are provided by Tablestore for various programming languages. You cannot directly call the API operations by making HTTP requests.

View references based on the programming language that you use.

Language

References

Java

SDK for Java

Go

SDK for Go

Python

SDK for Python

Node.js

SDK for Node.js

.NET

SDK for .NET

PHP

SDK for PHP

List of operations by function

Wide Column model

The following table describes the API operations related to the Wide Column model.

Category

Operation

Data table operations

  • CreateTable: creates a data table. When you create a data table, you can create secondary indexes at the same time.

  • ListTable: queries the names of all data tables that are created in the current instance.

  • DeleteTable: deletes a data table from the current instance.

  • UpdateTable: updates the configurations of a data table, such as the time to live (TTL), the maximum number of versions, and whether to allow update operations.

  • DescribeTable: queries the schema, reserved read throughput, and reserved write throughput of a data table.

  • ComputeSplitPointsBySize: logically splits the data in a data table into several splits whose sizes are close to the specified size and returns the split points between the splits and information about the hosts on which the splits reside.

Basic data operations

  • Write data

    • PutRow: inserts data into a row.

    • UpdateRow: updates a row of data.

    • BatchWriteRow: inserts, modifies, or deletes multiple rows of data for one or more data tables at the same time.

  • Read data

    • GetRow: reads a single row of data based on the specified primary key.

    • BatchGetRow: reads multiple rows of data from one or more data tables at the same time.

    • GetRange: reads data whose primary key is within the specified range.

  • Delete data

    • DeleteRow: deletes a row of data.

    • BatchWriteRow: inserts, modifies, or deletes multiple rows of data for one or more data tables at the same time.

Operations on predefined columns

  • AddDefinedColumn: adds predefined columns for a data table. Predefined columns can be used as the primary key columns or attribute columns of an index table that is created for the data table.

  • DeleteDefinedColumn: removes predefined columns.

Operations on secondary indexes

  • CreateIndex: creates an index table for a data table.

  • DropIndex: deletes an index table for a data table.

Operations on search indexes

  • CreateSearchIndex: creates a search index.

  • ListSearchIndex: lists search indexes that are created for a data table.

  • DescribeSearchIndex: queries information about a search index, such as the field information and index configuration.

  • DeleteSearchIndex: deletes a search index.

  • Search: queries data by using search indexes.

  • ComputeSplits: queries the maximum number of parallel scan tasks in a single request. You can call this operation to plan the number of parallel scan tasks when you use a search index to export data in parallel.

  • ParallelScan: scans data in parallel.

Operations related to real-time data consumption

  • CreateTunnel: creates a tunnel for a table. Tunnels can be used to consume data in tables in real time.

  • ListTunnel: queries the tunnel information about a table.

  • DescribeTunnel: queries the details of a tunnel.

  • DeleteTunnel: deletes a tunnel.

Stream operations

  • ListStream: queries the stream information about all tables in an instance.

  • DescribeStream: queries the shard information about a stream.

  • GetShardIterator: queries the start iterator that is used to read data from a shard.

  • GetStreamRecord: queries the incremental data of a shard.

Operations on multiple rows of data at the same time

  • BulkImport: writes multiple rows of data at the same time. You can call this operation to insert, modify, or delete a row of data.

  • BulkExport: exports multiple rows of data at the same time.

Operations on local transactions

  • StartLocalTransaction: creates a local transaction. After you enable the local transaction feature for a data table, you can create a local transaction based on a specific partition key value and perform read and write operations on data within the local transaction. You can use the local transaction feature to perform atomic operations to read and write one or more rows.

  • CommitTransaction: commits a local transaction. To save data modifications after you create a local transaction based on a specific partition key value and perform read and write operations within the local transaction, you must commit the local transaction.

  • AbortTransaction: aborts a local transaction. If you do not want to save data modifications after you create a local transaction based on a specific partition key value and perform read and write operations within the local transaction, you can abort the local transaction or wait until the local transaction times out.

SQL query operations

  • SQLQuery: queries data by executing SQL statements.

TimeSeries model

Category

Operation

Operations on time series tables

Operations on time series data