通配符查询中,要匹配的值可以是一个带有通配符的字符串,目前支持星号(*)和问号(?)两种通配符。要匹配的值中可以用星号(*)代表任意字符序列,或者用问号(?)代表任意单个字符,且支持以星号(*)或问号(?)开头。例如查询“table*e”,可以匹配到“tablestore”。

前提条件

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

参数

参数 描述
tableName 数据表名称。
indexName 多元索引名称。
offset 本次查询的开始位置。
limit 本次查询需要返回的最大数量。
queryType 设置查询类型为TableStore.QueryType.WILDCARD_QUERY。
fieldName 列名称。
value 带有通配符的字符串,字符串长度不能超过10字节。
getTotalCount 是否返回匹配的总行数,默认为false,表示不返回表中数据的总行数。

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

columnToGet 是否返回所有列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_SPECIFIED时,需要指定返回的列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL时,表示返回所有列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

/**
 * 使用通配符查询,查询表中Col_Keyword列的值匹配"table*e"的数据。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只是为了获取匹配行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { //设置查询类型为TableStore.QueryType.WILDCARD_QUERY。
            queryType: TableStore.QueryType.WILDCARD_QUERY,
            query: {
                fieldName: "Col_Keyword",
                value: "table*e" //wildcardQuery支持通配符。
            }
        },
        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));
});