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

前提条件

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

参数

参数 说明
path 路径名,嵌套类型字段的树状路径。例如news.title表示嵌套类型的news字段中的title子列。
query 嵌套类型字段的子列上的查询,子列上的查询可以是任意Query类型。
scoreMode 当字段存在多个值时基于哪个值计算分数。
getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

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

tableName 数据表名称。
indexName 多元索引名称。
columnsToGet 是否返回所有列,包含returnAll和columns设置。

returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

当设置returnAll为true时,表示返回所有列。

示例

使用嵌套类型查询的示例如下:

  • 示例1

    查询col_nested.nested_1为"tablestore"的数据。其中col_nested为嵌套类型字段,子行中包含nested_1和nested_2两列。

    private static void nestedQuery(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        NestedQuery nestedQuery = new NestedQuery(); //设置查询类型为NestedQuery。
        nestedQuery.setPath("col_nested"); //设置嵌套类型列的路径。
        TermQuery termQuery = new TermQuery(); //构造NestedQuery的子查询。
        termQuery.setFieldName("col_nested.nested_1"); //设置列名,注意带有嵌套类型列的路径。
        termQuery.setTerm(ColumnValue.fromString("tablestore")); //设置要查询的值。
        nestedQuery.setQuery(termQuery);
        nestedQuery.setScoreMode(ScoreMode.None);
        searchQuery.setQuery(nestedQuery);
        //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }
  • 示例2

    查询col_nested.nested_2.nested_2_2为"tablestore"的数据。其中col_nested为嵌套类型字段,col_nested的子行中包含nested_1和nested_2两列,nested_2的子行中又包含nested_2_1和nested_2_2两列。

    private static void nestedQuery(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        NestedQuery nestedQuery = new NestedQuery(); //设置查询类型为NestedQuery。
        nestedQuery.setPath("col_nested.nested_2"); //设置嵌套类型列的路径,即要查询字段的父路径。
        TermQuery termQuery = new TermQuery(); //构造NestedQuery的子查询。
        termQuery.setFieldName("col_nested.nested_2.nested_2_2"); //设置列名,即要查询字段的完整路径。
        termQuery.setTerm(ColumnValue.fromString("tablestore")); //设置要查询的值。
        nestedQuery.setQuery(termQuery);
        nestedQuery.setScoreMode(ScoreMode.None);
        searchQuery.setQuery(nestedQuery);
        //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }