全部产品
Search
文档中心

表格存储:全匹配查询

更新时间:Apr 29, 2026

全匹配查询(MatchAllQuery)可以匹配所有行,常用于查询表中数据总行数,或者随机返回几条数据。

前提条件

参数

参数

说明

tableName

数据表名称。

indexName

多元索引名称。

offset

本次查询的起始位置。

limit

本次查询返回的最大行数。

仅需获取总行数而不需要具体数据时,设置为 0。

query

查询类型。全匹配查询设置为 TableStore.QueryType.MATCH_ALL_QUERY

getTotalCount

是否返回匹配的总行数。默认值为 false

设置为 true 会影响查询性能。

columnToGet

每行匹配结果返回的列。通过 returnTypereturnNames 配置。

  • 当设置returnType为TableStore.ColumnReturnType.RETURN_SPECIFIED时,需要通过returnNames指定返回的列。

  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL时,表示返回所有列。

  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX时,表示返回多元索引中的所有列。.

  • 当设置returnType为TableStore.ColumnReturnType.RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

以下示例通过全匹配查询统计数据表的总行数:

/**
 * 通过全匹配查询统计数据表的总行数。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 仅需获取总行数时设置为 0,不返回具体数据。
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true // 设置为 true 返回匹配的总行数。默认值为 false。
    },
    columnToGet: { // RETURN_SPECIFIED:返回指定列;RETURN_ALL:返回所有列;RETURN_ALL_FROM_INDEX:返回多元索引中的所有列;RETURN_NONE:仅返回主键列。
        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));
});

常见问题

如何查看表的总行数

相关文档