精确查询

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

前提条件

参数

参数

说明

query_type

设置查询类型为TermQuery。

field_name

要匹配的字段。

term

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

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

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

table_name

数据表名称。

index_name

多元索引名称。

limit

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

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

get_total_count

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

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

columns_to_get

是否返回所有列,包含return_typecolumn_names设置。

  • 当设置return_typeColumnReturnType.SPECIFIED时,可以通过column_names指定返回的列。

  • 当设置return_typeColumnReturnType.ALL时,表示返回所有列。

  • 当设置return_typeColumnReturnType.NONE时,表示不返回所有列,只返回主键列。

示例

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

  • 5.2.1及之后版本

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

    query = TermQuery('Col_Keyword', 'tablestore')
    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 = TermQuery('Col_Keyword', 'tablestore')
    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 = TermQuery('Col_Keyword', 'tablestore')
    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)
    )

常见问题

相关文档