文档

通配符查询

更新时间:

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

如果查询的模式为*word*(等价于SQL中的WHERE field_a LIKE '%word%'),则您可以使用性能更好的模糊查询,具体实现方法请参见模糊查询。该方案不会随数据量变大而导致性能下降。

说明

如果要实现NOT LIKE功能,则WildcardQuery需要和BoolQuery中的must_not_queries结合使用。

前提条件

参数

参数

描述

query

设置查询类型为WildcardQuery。

field_name

列名称。

value

带有通配符的字符串,字符串长度不能超过32个字符。

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时,表示不返回所有列,只返回主键列。

示例

以下示例用于使用通配符查询表中Col_Keyword列的值中匹配'tablestor*'的数据。

  • 5.2.1及之后版本

    使用5.2.1及之后的SDK版本时,默认的返回结果为SearchResponse对象,请求示例如下:

    query = WildcardQuery('Col_Keyword', 'tablestor*')
    search_response = client.search(
        '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', 
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    )
    print('request_id : %s' % search_response.request_id)
    print('is_all_succeed : %s' % search_response.is_all_succeed)
    print('total_count : %s' % search_response.total_count)
    print('rows : %s' % search_response.rows)
    
    # # 当需要进行深度翻页时,推荐使用next_token进行翻页(翻页深度无限制)
    # all_rows = []
    # next_token = None
    # # first round
    # search_response = client.search(
    #     '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
    #     SearchQuery(query, next_token=next_token, limit=100, get_total_count=True),
    #     columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
    # all_rows.extend(search_response.rows)
    # 
    # # loop
    # while search_response.next_token:
    #     search_response = client.search(
    #         '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
    #         SearchQuery(query, next_token=search_response.next_token, limit=100, get_total_count=True),
    #         columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
    #     all_rows.extend(search_response.rows)
    # print('Total rows:%s' % len(all_rows))

    如果需要返回Tuple类型结果,您可以使用如下请求示例实现。

    query = WildcardQuery('Col_Keyword', 'tablestor*')
    rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search(
        '<TABLE_NAME>', '<SEARCH_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('Col_Keyword', 'tablestor*')
    rows, next_token, total_count, is_all_succeed = client.search(
        '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    )

常见问题

相关文档