Use Tablestore SDK for Node.js to perform a match all query - Tablestore

Prerequisites

An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
A data table is created and data is written to the data table. For more information, see Create data tables and Write data.
A search index is created for the data table. For more information, see Create a search index.

Parameters

Parameter	Description
tableName	The name of the data table.
indexName	The name of the search index.
offset	The starting position of the query.
limit	The maximum number of rows to return. To return only the row count without data, set this to 0.
query	The query type. Set to `TableStore.QueryType.MATCH_ALL_QUERY` for match all query.
getTotalCount	Whether to return the total number of rows that match the query conditions. Default value: `false`. Setting this to `true` reduces query performance.
columnToGet	The columns to return for each matched row. Configure using `returnType` and `returnNames`. If you set returnType to TableStore.ColumnReturnType.RETURN_SPECIFIED, you need to configure returnNames to specify the columns that you want to return. If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_ALL, all columns are returned. If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX, all columns in the search index are returned. . If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_NONE, only the primary key columns are returned.

Examples

The following example uses match all query to count the total number of rows in a data table:

/**
 * Perform a match all query to get the total row count of a data table.
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // Set to 0 to return only the row count without data.
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true // Set to true to return the total number of matched rows. Default: false.
    },
    columnToGet: { // RETURN_SPECIFIED: specified columns only; RETURN_ALL: all columns; RETURN_ALL_FROM_INDEX: all columns in the search index; RETURN_NONE: primary key columns only.
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["Col_1", "Col_2", "Col_3"]
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

FAQ

How do I query the total number of rows in a table?

References

The following query types are supported by search indexes: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, Boolean query, geo query, nested query, vector query, and exists query. You can select a query type to query data based on your business requirements.
If you want to sort or paginate the rows that meet the query conditions, you can use the sorting and paging feature. For more information, see Sorting and paging.
If you want to collapse the result set based on a specific column, you can use the collapse (distinct) feature. This way, data of the specified type appears only once in the query results. For more information, see Collapse (distinct).
If you want to analyze data in a data table, such as obtaining the extreme values, sum, and total number of rows, you can perform aggregation operations or execute SQL statements. For more information, see Aggregation and SQL query.
If you want to quickly obtain all rows that meet the query conditions without the need to sort the rows, you can call the ParallelScan and ComputeSplits operations to use the parallel scan feature. For more information, see Parallel scan.