嵌套类型查询

NestedQuery用于查询嵌套类型字段中子行的数据。嵌套类型不能直接查询,需要通过NestedQuery包装,NestedQuery中需要指定嵌套类型字段的路径和一个子查询,其中子查询可以是任意Query类型。

前提条件

参数

参数

说明

path

路径名,嵌套类型的列的树状路径。例如news.title表示嵌套类型的news列中的title子列。

query

嵌套类型的列中子列上的查询,子列上的查询可以是任意Query类型。

score_mode

当列存在多个值时基于哪个值计算分数。

table_name

数据表名称。

index_name

多元索引名称。

inner_hits

嵌套类型字段的子列的配置参数。包括如下配置项:

  • sort:Nested子行返回时的排序规则。

  • offset:当Nested列包含多个子行时,子行返回的起始位置。

  • limit:当Nested列包含多个子行时,返回子行的数量。默认值为3。

  • highlight:Nested子列高亮参数配置。具体参数配置说明请参见摘要与高亮

示例

单层级嵌套类型查询示例

以下示例用于查询表中col_nested.col_long列的值大于等于100且小于等于300的数据。

  • 5.2.1及之后版本

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

    nested_query = RangeQuery('col_nested.col_long', range_from=100, range_to=300, include_lower=True, include_upper=True)
    query = NestedQuery('col_nested', nested_query)
    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)

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

    nested_query = RangeQuery('col_nested.col_long', range_from=100, range_to=300, include_lower=True, include_upper=True)
    query = NestedQuery('col_nested', nested_query)
    rows, next_token, total_count, is_all_succeed, agg_result, 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类型,请求示例如下:

    nested_query = RangeQuery('col_nested.col_long', range_from=100, range_to=300, include_lower=True, include_upper=True)
    query = NestedQuery('col_nested', nested_query)
    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)
    )

嵌套类型查询使用查询摘要与高亮示例

以下示例用于使用NestedQuery功能查询表中col_nested嵌套类型字段中col_text子列的值能够匹配tablestore的数据,并在返回结果中对查询词进行高亮显示。

def _print_rows(request_id, rows, total_count):
    print('Request ID:%s' % request_id)

    for row in rows:
        print(row)

    print('Rows return: %d' % len(rows))
    print('Total count: %d' % total_count)


def _print_search_hit(hits):
    for search_hit in hits:
        print('\t score is %.6f' % search_hit.score)
        for highlight_field in search_hit.highlight_result.highlight_fields:
            print('\t\t highlight:%s:%s' % (highlight_field.field_name, highlight_field.field_fragments))
        for inner_result in search_hit.search_inner_hits:
            print('\t\t path:%s' % (inner_result.path))
            _print_search_hit(inner_result.search_hits)


def highlight_query_for_nested(client):
    print('********** Begin HighlightQueryForNested **********')

    sort = Sort(
        sorters=[FieldSort('col_nested.col_long', sort_order=SortOrder.ASC)]
    )

    highlight_parameter = HighlightParameter("col_nested.col_text", 1, 18, '<b>', '</b>', HighlightFragmentOrder.TEXT_SEQUENCE)
    highlight_clause = Highlight([highlight_parameter], HighlightEncoder.PLAIN_MODE)

    inner_hits_parameter = InnerHits(None, 0, 10, highlight_clause)
    query = NestedQuery('n', MatchQuery('col_nested.col_text', 'tablestore'), ScoreMode.AVG, inner_hits_parameter)

    search_response = client.search('<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
                                    SearchQuery(query, limit=2, get_total_count=True),
                                    ColumnsToGet(return_type=ColumnReturnType.ALL_FROM_INDEX)
                                    )

    print('----- Print Rows:')
    print('search rows count:%d' % len(search_response.rows))
    _print_rows(search_response.request_id,search_response.rows,search_response.total_count)

    print('----- Print Highlight Result:')
    search_hits = search_response.search_hits
    print('search hit count:%d' % len(search_hits))

    _print_search_hit(search_hits)

    print('********** End HighlightQuery **********')

常见问题

相关文档