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

如果查询的模式为*word*,则您可以使用性能更好的模糊查询,具体实现方法如下:
  1. 创建多元索引时,设置列为Text类型且设置分词类型为模糊分词。
  2. 使用多元索引查询数据时,使用MatchPhraseQuery且设置查询词为word。

前提条件

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

参数

参数 描述
query 设置查询类型为WildcardQuery。
field_name 列名称。
value 带有通配符的字符串,字符串长度不能超过20个字符。
table_name 数据表名称。
index_name 多元索引名称。
limit 本次查询需要返回的最大数量。
get_total_count 是否返回匹配的总行数,默认为False。

设置get_total_count为True后会影响查询性能。

ColumnsToGet 是否返回所有列。
  • 当设置return_type为ColumnReturnType.SPECIFIED时,需要指定返回的列。
  • 当设置return_type为ColumnReturnType.ALL时,表示返回所有列。
  • 当设置return_type为ColumnReturnType.NONE时,表示不返回所有列,只返回主键列。

示例

查询表中k列的值匹配'key00*'的数据。

  • 5.2.1及之后版本
    使用5.2.1及之后的SDK版本时,默认的返回结果为SearchResponse对象,请求示例如下:
    query = WildcardQuery('k', 'key00*')
    search_response = client.search(
        table_name, index_name, 
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    )
    如果需要返回Tuple类型结果,您可以使用如下请求示例实现。
    query = WildcardQuery('k', 'key00*')
    rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search(
        table_name, index_name, 
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    ).v1_response()
  • 5.2.1之前版本

    使用5.2.1之前的SDK版本时,默认的返回结果为Tuple类型,请求示例如下:

    query = WildcardQuery('k', 'key00*')
    rows, next_token, total_count, is_all_succeed = client.search(
        table_name, index_name, 
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    )