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

前提条件

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

参数

参数 说明
Path 路径名,嵌套类型的列的树状路径。例如news.title表示嵌套类型的news列中的title子列。
Query 嵌套类型的列中子列上的查询,子列上的查询可以是任意Query类型。
ScoreMode 当列存在多个值时基于哪个值计算分数。
TableName 数据表名称。
IndexName 多元索引名称。
ColumnsToGet 是否返回所有列。包含ReturnAll和Columns以及ReturnAllFromIndex设置。
ReturnAll默认为false,表示不返回所有列。此时可以通过如下任一设置返回所需列。如果未设置Columns和ReturnAllFromIndex,则只返回主键列。
  • 设置Columns指定返回的列。
  • 设置ReturnAllFromIndex为true返回多元索引中的所有列。

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

示例

/// <summary>
/// 查询col1_nested.nested_1为tablestore的数据。其中col1_nested为嵌套类型字段,子行中包含nested_1和nested_2两列。
/// </summary>
/// <param name="otsClient"></param>
public static void NestedQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    //设置返回匹配的总行数。
    searchQuery.GetTotalCount = true;
    var nestedQuery = new NestedQuery();
    nestedQuery.Path = "col1_nested"; //设置嵌套类型字段的路径。
    TermQuery termQuery = new TermQuery("col1_nested.nested_1",new ColumnValue("tablestore"));//构造NestedQuery的子查询。
    nestedQuery.Query = termQuery;
    nestedQuery.ScoreMode = ScoreMode.None;

    var request = new SearchRequest(TableName, IndexName, searchQuery);
    //通过ColumnsToGet参数可以设置返回多元索引中所有列、返回指定列或返回所有列,如果不设置此参数,则默认只返回主键列。
    request.ColumnsToGet = new ColumnsToGet()
    {
        //设置为返回多元索引中所有列。
        ReturnAllFromIndex = true
        //设置为返回指定列。
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        //设置为返回所有列。
        //ReturnAll = true
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); //打印匹配到的总行数,非返回行数。
}