All Products
Search
Document Center

Tablestore:Node.js SDK

Last Updated:Jun 24, 2025

This topic describes the operations supported by Tablestore SDK for Node.js when the Wide Column model is used.

Features

Before you use the features supported by Tablestore SDK for Node.js, you must initialize a client. The following table describes the features supported by Tablestore SDK for Node.js.

Feature

Operation

Description

Table

Create a data table

You can create a data table to store data. You can configure an auto-increment primary key column when you create a data table.

Update the configurations of a table

You can update the configurations of a data table.

Query the names of tables

You can view the names of all data tables in an instance.

Query the description of a table

You can query the configurations of a data table.

Delete a data table

You can delete a data table.

Data operations

Write data

You can write data to a data table.

Read data

You can read data from a data table.

Delete data

You can delete data from a data table.

Filter

You can use a filter to filter query results on the server and then return the filtered results. Only the rows that meet the filter conditions are returned.

Conditional update

You can update data in a table only when the specified conditions are met. Otherwise, the update fails and an error is returned.

Atomic counter

The atomic counter feature allows you to specify a column as an atomic counter and perform atomic counter operations on the column.

Local transaction

After you enable local transaction for a data table, you can create a local transaction based on a partition key value.

Search index

Create a search index

You can create a search index for a data table.

List search indexes

You can query search indexes that are created for a table.

Update the configurations of a search index

You can update the time to live (TTL) of a search index.

Query the description of a search index

You can query the description of a search index, including the information about the fields in the search index and configurations of the search index.

Delete a search index

You can delete a search index.

Basic query

Basic query types include match all query, term query, terms query, prefix query, range query, wildcard query, exists query, collapse (distinct), geo query, and nested query.

Boolean query

A Boolean query retrieves data from a data table based on a combination of subqueries. Tablestore returns the rows that match the subqueries.

Sorting and pagination

When you query data by using search indexes, you can specify a sorting method to sort the returned data. When a large number of rows are returned, you can use offset-based pagination or token-based pagination to quickly locate the data you want.

Aggregation

You can perform aggregation operations to obtain the minimum, maximum, sum, and average values, and the count and distinct count of rows. You can also perform aggregation operations to group results by field value, range, geographical location, or filter. You can perform multiple aggregation operations for complex queries.

Full-text search

Tablestore provides match query and match phrase query to implement full-text search. When you perform a match query or match phrase query, data is matched based on tokens. You can use the highlight features to highlight the query string.

KNN vector query

You can use the k-nearest neighbor (KNN) vector query feature to perform an approximate nearest neighbor search based on vectors. This way, you can find data items that have the highest similarity to the vector that you want to query in a large-scale dataset.

Parallel scan

If you do not have requirements on the order of query results, you can use the parallel scan feature to obtain query results in an efficient manner.

Secondary Index

Create a secondary index

You can create a secondary index for a data table.

Read data by using a secondary index

You can query data in a secondary index by reading a single row of data or reading data whose primary key values are within a specific range. If the required attribute columns are included in the secondary index, data can be directly read from the secondary index. Otherwise, data must be read from the data table.

Delete a secondary index

You can delete a secondary index that is created for a data table.

SQL query

Create a mapping table

You can create a mapping table for an existing table or index.

Update attribute columns in a mapping table

You can add or remove attribute columns in an existing mapping table.

Delete a mapping table

You can delete one or more mapping tables.

List the names of tables

You can query the names of mapping tables in the current database.

Query table description

You can query the description of a table, such as field names and field types.

Query index description

You can query the index description of a table.

Query data

You can query data in a table.

References

For more information about how to handle Tablestore errors, see Error handling.