类似于TermQuery,但是TermsQuery可以指定多个查询关键词,查询匹配这些词的数据。多个查询关键词中只要有一个词精确匹配,该行数据就会被返回,等价于SQL中的In。

前提条件

  • 已初始化Client,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

参数

参数 说明
tableName 数据表名称。
indexName 多元索引名称。
offset 本次查询的开始位置。
limit 本次查询需要返回的最大数量。

如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。

queryType 设置查询类型为TableStore.QueryType.TERMS_QUERY。
fieldName 要匹配的字段。
terms 多个查询关键词,即要匹配的值。

多个查询关键词中只要有一个词精确匹配,该行数据就会被返回。

getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

返回匹配的总行数会影响查询性能。

columnToGet 是否返回所有列,包含returnType和returnNames设置。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_SPECIFIED时,可以通过returnNames指定返回的列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL时,表示返回所有列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

/**
 * 查询表中Col_Keyword列精确匹配"hangzhou"或"shanghai"的数据。
 * TermsQuery可以使用多个Term同时查询。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { //设置查询类型为TableStore.QueryType.TERMS_QUERY。
            queryType: TableStore.QueryType.TERMS_QUERY,
            query: {
                fieldName: "Col_Keyword",
                terms: ["hangzhou", "shanghai"]
            }
        },
        getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数,默认为false,表示不返回。
    },
    columnToGet: { //返回列设置RETURN_SPECIFIED(自定义)、RETURN_ALL(所有列)和RETURN_NONE(不返回)。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});