MatchAllQuery可以匹配所有行,常用于查询表中数据总行数,或者随机返回几条数据。
前提条件
参数
参数 | 说明 |
---|---|
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
offset | 本次查询的开始位置。 |
limit | 本次查询需要返回的最大数量。 如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。 |
query | 设置查询类型为TableStore.QueryType.MATCH_ALL_QUERY。 |
getTotalCount | 是否返回匹配的总行数,默认为false,表示不返回。 返回匹配的总行数会影响查询性能。 |
columnToGet | 是否返回所有列,包含returnType和returnNames设置。
|
示例
/**
* 通过MatchAllQuery查询表中数据的总行数。
*/
client.search({
tableName: TABLE_NAME,
indexName: INDEX_NAME,
searchQuery: {
offset: 0,
limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
query: {
queryType: TableStore.QueryType.MATCH_ALL_QUERY
},
getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数,默认为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));
});