全部产品
Search
文档中心

表格存储:精确查询

更新时间:Jul 01, 2024

TermQuery采用完整精确匹配的方式查询表中的数据,类似于字符串匹配。对于Text类型字段,只要分词后有词条可以精确匹配即可。

前提条件

参数

参数

说明

tableName

数据表名称。

indexName

多元索引名称。

offset

本次查询的开始位置。

limit

本次查询需要返回的最大数量。

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

queryType

设置查询类型为TableStore.QueryType.TERM_QUERY。

fieldName

要匹配的字段。

term

查询关键词,即要匹配的值。

该词不会被分词,会被当做完整词去匹配。

对于Text类型字段,只要分词后有词条可以精确匹配即可。例如某个Text类型的字段,值为“tablestore is cool”,如果分词后为“tablestore”、“is”、“cool”三个词条,则查询“tablestore”、“is”、“cool”时都满足查询条件。

getTotalCount

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

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

columnToGet

是否返回所有列,包含returnType和returnNames设置。

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

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

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

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

示例

以下示例用于查询表中Col_Keyword列精确匹配"hangzhou"的数据。

/**
 * 查询表中Col_Keyword列精确匹配"hangzhou"的数据。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { //设置查询类型为TableStore.QueryType.TERM_QUERY。
            queryType: TableStore.QueryType.TERM_QUERY,
            query: {
                fieldName: "Col_Keyword",
                term: "hangzhou"
            }
        },
        getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数,默认为false,表示不返回。
    },
    columnToGet: { //返回列设置,可设置为RETURN_SPECIFIED(自定义返回列)、RETURN_ALL(返回所有列)、RETURN_ALL_FROM_INDEX(返回多元索引中的所有列)、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));
});

常见问题

常见问题

相关文档