All Products
Search
Document Center

Tablestore:Operation summary

Last Updated:Jan 19, 2024

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

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 data updates.

  • 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 partitions whose sizes are close to the specified size, and returns the split points between the partitions and information about the hosts on which the partitions 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 a 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 a 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 a time.

Stream operations

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

  • DescribeStream: queries the shard information about the current stream.

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

  • GetStreamRecord: queries the incremental data of the current shard.

Index operations

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

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

TimeSeries model

Category

Operation

Operations on time series tables

Basic data operations