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

前提条件

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

参数

参数 说明
path 路径名,嵌套类型的列的树状路径。例如news.title表示嵌套类型的news列中的title子列。
query 嵌套类型的列中子列上的查询,子列上的查询可以是任意Query类型。
score_mode 当列存在多个值时基于哪个值计算分数。
table_name 数据表名称。
index_name 多元索引名称。

示例

查询表中n.n1列的值大于等于100且小于等于300的数据。

  • 5.2.1及之后版本
    使用5.2.1及之后的SDK版本时,默认的返回结果为SearchResponse对象,请求示例如下:
    nested_query = RangeQuery('n.nl', range_from=100, range_to=300, include_lower=True, include_upper=True)
    query = NestedQuery('n', nested_query)
    search_response = client.search(
        table_name, index_name, 
        SearchQuery(query, limit=100, get_total_count=True), 
        ColumnsToGet(return_type=ColumnReturnType.ALL)
    )
    如果需要返回Tuple类型结果,您可以使用如下请求示例实现。
    nested_query = RangeQuery('n.nl', range_from=100, range_to=300, include_lower=True, include_upper=True)
    query = NestedQuery('n', nested_query)
    rows, next_token, total_count, is_all_succeed, agg_result, 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类型,请求示例如下:

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