MatchQuery采用近似匹配的方式查询表中的数据。对Text类型的列值和查询关键词会先按照设置好的分词器做切分,然后按照切分好后的词去查询。

前提条件

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

参数

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

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

queryType 设置查询类型为TableStore.QueryType.MATCH_QUERY。
fieldName 要匹配的列。

匹配查询可应用于Text类型。

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

当要匹配的列为Text类型时,查询关键词会被切分成多个词,分词类型为创建多元索引时设置的分词器类型。如果创建多元索引时未设置分词器类型,则默认分词类型为单字分词。

例如当要匹配的列为Text类型时,分词类型为单字分词,则查询词为"this is",可以匹配到“...,this is tablestore”、“is this tablestore”、“tablestore is cool”、“this"、“is”等。

operator 逻辑运算符。默认为OR,表示当分词后的多个词只要有部分匹配时,则行数据满足查询条件。

如果设置operator为AND,则只有分词后的所有词都在列值中时,才表示行数据满足查询条件。

minimumShouldMatch 最小匹配个数。

只有当某一行数据的fieldName列的值中至少包括最小匹配个数的词时,才会返回该行数据。

说明 minimumShouldMatch需要与逻辑运算符OR配合使用。
getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

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

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

示例

/**
 * 查询表中Col_Keyword列的值能够匹配"hangzhou"的数据,返回匹配到的总行数和一些匹配成功的行。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了取行数,但不需要具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { //设置查询类型为MatchQuery。
            queryType: TableStore.QueryType.MATCH_QUERY,
            query: {
                fieldName: "Col_Keyword", //设置要匹配的列。
                text: "hangzhou" //设置要匹配的值。
            }
        },
        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));
});