查詢巢狀型別欄位中子行的資料 - Tablestore

NestedQuery用於查詢巢狀型別欄位中子行的資料。巢狀型別不能直接查詢，需要通過NestedQuery封裝，NestedQuery中需要指定巢狀型別欄位的路徑和一個子查詢，其中子查詢可以是任意Query類型。

重要

巢狀型別查詢只能查詢巢狀型別的列。
在一個請求中可以同時查詢普通列和巢狀型別的列。巢狀型別的更多資訊請參見巢狀型別。

介面

巢狀型別查詢的介面為Search或者ParallelScan，具體的Query類型為NestedQuery。

參數

參數	說明
path	路徑名，巢狀型別欄位的樹狀路徑。例如news.title表示巢狀型別的news欄位中的title子列。
query	巢狀型別欄位的子列上的查詢，子列上的查詢可以是任意Query類型。
scoreMode	當欄位存在多個值時基於哪個值計算分數。
getTotalCount	是否返回匹配的總行數，預設為false，表示不返回。返回匹配的總行數會影響查詢效能。
weight	查詢權重，用於全文檢索索引情境中的score排序。查詢時指定列的算分權重，值越大，結果中分數的值會越大。取值範圍為正浮點數。使用此參數不會影響返回的結果數，只會影響返回的結果中的分數。
tableName	資料表名稱。
indexName	多元索引名稱。
columnsToGet	是否返回所有列，包含returnAll和columns設定。 returnAll預設為false，表示不返回所有列，此時可以通過columns指定返回的列；如果未通過columns指定返回的列，則只返回主鍵列。當設定returnAll為true時，表示返回所有列。
InnerHits	巢狀型別欄位的子列的配置參數。包括如下配置項： sort：Nested子列返回時的定序。 offset：當Nested列包含多個子行時，子行返回的起始位置。 limit：當Nested列包含多個子行時，返回子行的數量。預設值為3。 highlight：Nested子列高亮參數配置。具體參數配置說明請參見摘要與高亮。

使用方式

您可以使用控制台或者SDK進行巢狀型別查詢。進行巢狀型別查詢之前，您需要完成如下準備工作。

使用阿里雲帳號或者具有Table Store操作許可權的RAM使用者進行操作。如果需要為RAM使用者授權Table Store操作許可權，請參見通過RAM Policy為RAM使用者授權進行配置。
使用SDK方式進行操作時，如果當前無可用AccessKey，則需要為阿里雲帳號或者RAM使用者建立AccessKey。具體操作，請參見建立AccessKey。
警告
阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
已建立資料表。具體操作，請參見資料表操作。
已為資料表建立多元索引。具體操作，請參見建立多元索引。
使用SDK方式進行操作時，還需要完成初始化Client。具體操作，請參見初始化OTSClient。

使用控制台

通過Table Store控制台只能進行單層級巢狀型別的資料查詢。

進入索引管理頁簽。
1. 登入Table Store控制台。
2. 在頁面上方，選擇資源群組和地區。
3. 在概覽頁面，單擊執行個體名稱或在操作列單擊執行個體管理。
4. 在執行個體詳情頁簽下的資料表列表頁簽，單擊資料表名稱或在操作列單擊索引管理。
在索引管理頁簽，單擊目標多元索引操作列的搜尋。
在查詢資料對話方塊，查詢資料。
1. 系統預設返回所有列，如需顯示指定屬性列，關閉擷取所有列並輸入需要返回的屬性列，多個屬性列之間用半形逗號（,）隔開。
  說明
  系統預設會返回資料表的主鍵列。
2. 根據需要選擇邏輯操作符為 And、Or 或者 Not。
  當選擇邏輯操作符為 And 時，返回滿足指定條件的資料。當選擇邏輯操作符為 Or 時，如果配置了單個條件，則返回滿足指定條件的資料；如果配置了多個條件，則返回滿足任意一個條件的資料。當選擇邏輯操作符為 Not 時，返回不滿足指定條件的資料。
3. 選擇巢狀型別欄位，單擊添加。
4. 選擇子欄位後，設定查詢類型為所需的查詢類型（例如精確查詢（TermQuery））和輸入要查詢的值。
5. 系統預設關閉排序功能，如需根據指定欄位對返回結果進行排序，開啟是否排序開關後，根據需要添加要進行排序的欄位並配置排序方式。
6. 系統預設關閉統計功能，如需對指定欄位進行資料統計，開啟是否統計開關後，根據需要添加要進行統計的欄位和配置統計資訊。
單擊確定。
符合查詢條件的資料會顯示在索引管理頁簽中。

使用SDK

通過SDK可以進行單層級巢狀型別和多層級巢狀型別的資料查詢。使用巢狀型別查詢時，您可以使用查詢摘要與高亮功能在返回結果中反白關鍵詞。關於查詢摘要與高亮的更多資訊，請參見摘要與高亮。

您可以通過Java SDK、Go SDK、Python SDK、Node.js SDK、.NET SDK和PHP SDK使用巢狀型別查詢。此處以Java SDK為例介紹巢狀型別查詢的使用。

單層級巢狀型別查詢樣本

以下樣本用於查詢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("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", 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());
}

多層級巢狀型別查詢樣本

以下樣本用於查詢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("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", 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());
}

巢狀型別組合查詢樣本

查詢需求

假設資料表中有col_string（String類型）和col_nested（String類型）兩列，其中col_nested用於儲存JSON格式的資料。資料表的具體資料樣本請參見下表。

說明

此處為了便於示範查詢樣本，為每行資料添加了行編號列。

行編號	col_string	col_nested
1	a	[{"col_keyword": "tablestore"},{"col_keyword": "searchindex","col_long": 1}]
2	b	[{"col_keyword": "tablestore","col_long": 1}]
3	c	[{"col_keyword": "searchindex"},{"col_long": 1}]

假設對col_nested列資料有如下查詢需求：

同一個子行滿足多個查詢條件
例如查詢col_nested列中同一子行同時滿足col_keyword列值為"tablestore"並且col_long列值非空的行資料。
不同子行滿足多個查詢條件
例如查詢col_nested列中只要不同子行能滿足col_keyword值為"tablestore"和col_long值非空兩個條件的行資料。

為了滿足上述查詢需求，您需要執行如下操作：

為資料表建立一個多元索引，並在多元索引中將col_nested列設定為巢狀型別。
其中col_nested列包含col_keyword（Keyword類型）和col_long（Long類型）兩個子欄位。
結合查詢需求使用合適的查詢方式進行資料查詢。
- 如果要實現同一個子行滿足多個查詢條件的查詢需求，您需要在NestedQuery下設定多個BoolQuery進行查詢。
- 如果要實現不同子行滿足多個查詢條件的查詢需求，您需要在BoolQuery下設定多個NestedQuery進行查詢。

進行資料查詢的樣本如下，請根據要實現的查詢需求參考相應樣本進行操作。

同一子行滿足多個條件查詢樣本

以下樣本用於查詢col_nested列的同一子行同時滿足col_nested.col_keyword為"tablestore"並且col_nested.col_long非空條件的行資料。

根據資料表的資料樣本可知，只有行編號2對應的行資料滿足查詢條件。

public static void nestedQuery(SyncClient client) {
    // 查詢條件一：要求col_nested子行的col_keyword列值為"tablestore"
    TermQuery termQuery = new TermQuery();
    termQuery.setFieldName("col_nested.col_keyword");
    termQuery.setTerm(ColumnValue.fromString("tablestore"));

    // 查詢條件二：要求col_nested子行的col_long非空
    ExistsQuery existsQuery = new ExistsQuery();
    existsQuery.setFieldName("col_nested.col_long");

    // 通過BoolQuery的And條件，查詢同時滿足上述條件的子行
    List<Query> mustQueries = new ArrayList<>();
    mustQueries.add(termQuery);
    mustQueries.add(existsQuery);
    BoolQuery boolQuery = new BoolQuery();
    boolQuery.setMustQueries(mustQueries);

    // NestedQuery內部設定BoolQuery，要求某一子行同時滿足多個查詢條件
    NestedQuery nestedQuery = new NestedQuery();    //設定查詢類型為NestedQuery。
    nestedQuery.setPath("col_nested");   //設定巢狀型別列的路徑，即要查詢欄位的父路徑。
    nestedQuery.setQuery(boolQuery);
    nestedQuery.setScoreMode(ScoreMode.None);

    SearchQuery searchQuery = new SearchQuery();
    searchQuery.setQuery(nestedQuery);

    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());
}

不同子行滿足多個條件查詢樣本

以下樣本用於查詢col_nested的多個子行能滿足col_nested.col_keyword為"tablestore"和col_nested.col_long非空兩個條件的行資料。

根據資料表的資料樣本可知，行編號1和行編號2對應的行資料均滿足查詢條件。

public static void nestedQuery(SyncClient client) {
        // 查詢條件一：要求col_nested子行的col_keyword列值為"tablestore"
        TermQuery termQuery = new TermQuery();
        termQuery.setFieldName("col_nested.col_keyword");
        termQuery.setTerm(ColumnValue.fromString("tablestore"));
        NestedQuery nestedTermQuery = new NestedQuery();
        nestedTermQuery.setPath("col_nested");
        nestedTermQuery.setScoreMode(ScoreMode.None);
        nestedTermQuery.setQuery(termQuery);

        // 查詢條件二：要求col_nested子行的col_long非空
        ExistsQuery existsQuery = new ExistsQuery();
        existsQuery.setFieldName("col_nested.col_long");
        NestedQuery nestedExistsQuery = new NestedQuery();
        nestedExistsQuery.setPath("col_nested");
        nestedExistsQuery.setScoreMode(ScoreMode.None);
        nestedExistsQuery.setQuery(termQuery);

        // 通過BoolQuery的And條件，查詢滿足上述條件的行
        List<Query> mustQueries = new ArrayList<>();
        mustQueries.add(nestedTermQuery);
        mustQueries.add(nestedExistsQuery);

        // BoolQuery內部包括多個NestedQuery，多個子行分別滿足查詢條件即可
        BoolQuery boolQuery = new BoolQuery();
        boolQuery.setMustQueries(mustQueries);

        SearchQuery searchQuery = new SearchQuery();
        searchQuery.setQuery(boolQuery);

        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());
    }

巢狀型別查詢使用查詢摘要與高亮樣本

以下樣本用於使用NestedQuery功能查詢表中Col_Nested巢狀型別欄位中Level1_Col1_Nested子列的值能夠匹配hangzhou shanghai的資料，並在返回結果中對查詢詞進行高亮顯示。

/**
 * NestedQuery查詢摘要與高亮，通過innerHits設定參數。
 */
public static void NestedQueryQueryWithHighlighting1(SyncClient client) {
        SearchRequest searchRequest = SearchRequest.newBuilder()
                .tableName("<TABLE_NAME>")
                .indexName("<SEARCH_INDEX_NAME>")
                .returnAllColumnsFromIndex(true)
                .searchQuery(SearchQuery.newBuilder()
                        .limit(5)
                        .query(QueryBuilders.nested()
                                .path("Col_Nested")
                                .scoreMode(ScoreMode.Min)
                                .query(QueryBuilders.match("Col_Nested.Level1_Colqia1_Nested", "hangzhou shanghai"))
                                .innerHits(InnerHits.newBuilder()
                                        .highlight(Highlight.newBuilder()
                                                .addFieldHighlightParam("Col_Nested.Level1_Col1_Nested", HighlightParameter.newBuilder().build())
                                                .build())
                                        .build()))
                        .build())
                .build();
        SearchResponse resp = client.search(searchRequest);

        // 列印高亮結果。
        printSearchHit(resp.getSearchHits(), "");
}

/**
 * 列印searchHit內容。
 * @param searchHits searchHits
 * @param prefix Nested結構輸出時，增加首碼以列印層次資訊。
 */
private static void printSearchHit(List<SearchHit> searchHits, String prefix) {
    for (SearchHit searchHit : searchHits) {
        if (searchHit.getScore() != null) {
            System.out.printf("%s Score: %s\n", prefix, searchHit.getScore());
        }

        if (searchHit.getOffset() != null) {
            System.out.printf("%s Offset: %s\n", prefix, searchHit.getOffset());
        }

        if (searchHit.getRow() != null) {
            System.out.printf("%s Row: %s\n", prefix, searchHit.getRow().toString());
        }

        // 列印各欄位高亮分區結果。
        if (searchHit.getHighlightResultItem() != null) {
            System.out.printf("%s Highlight: \n", prefix);
            StringBuilder strBuilder = new StringBuilder();
            for (Map.Entry<String, HighlightField> entry : searchHit.getHighlightResultItem().getHighlightFields().entrySet()) {
                strBuilder.append(entry.getKey()).append(":").append("[");
                strBuilder.append(StringUtils.join(",", entry.getValue().getFragments())).append("]\n");
            }
            System.out.printf("%s   %s", prefix, strBuilder);
        }

        // 巢狀型別高亮結果。
        for (SearchInnerHit searchInnerHit : searchHit.getSearchInnerHits().values()) {
            System.out.printf("%s Path: %s\n", prefix, searchInnerHit.getPath());
            System.out.printf("%s InnerHit: \n", prefix);
            printSearchHit(searchInnerHit.getSubSearchHits(), prefix + "    ");
        }

        System.out.println();
    }
}

假設多層級巢狀型別欄位Col_Nested中包括Level1_Col1_Text（Text類型）和Level1_Col2_Nested（Nested類型）兩列，其中Level1_Col2_Nested巢狀型別欄位包括Level2_Col1_Text子列。

以下樣本用於通過在NestedQuery中添加BoolQuery對Col_Nested欄位中的Level1_Col1_Text子列和Level1_Col2_Nested下的Level2_Col1_Text子列同時使用查詢摘要與高亮功能。

public static void NestedQueryWithHighlighting(SyncClient client) {
    SearchRequest searchRequest = SearchRequest.newBuilder()
        .tableName("<TABLE_NAME>")
        .indexName("<SEARCH_INDEX_NAME>")
        .returnAllColumnsFromIndex(true)
        .searchQuery(SearchQuery.newBuilder()
            .limit(5)
            .query(QueryBuilders.nested()
                .path("Col_Nested")
                .scoreMode(ScoreMode.Min)
                .query(QueryBuilders.bool()
                    .should(QueryBuilders.match("Col_Nested.Level1_Col1_Text", "hangzhou shanghai"))
                    .should(QueryBuilders.nested()
                        .path("Col_Nested.Level1_Col2_Nested")
                        .scoreMode(ScoreMode.Min)
                        .query(QueryBuilders.match("Col_Nested.Level1_Col2_Nested.Level2_Col1_Text", "hangzhou shanghai"))
                        .innerHits(InnerHits.newBuilder()
                            .highlight(Highlight.newBuilder()
                                .addFieldHighlightParam("Col_Nested.Level1_Col2_Nested.Level2_Col1_Text", HighlightParameter.newBuilder().build())
                                .build())
                            .build())))
                .innerHits(InnerHits.newBuilder()
                    .sort(new Sort(Arrays.asList(
                        new ScoreSort(),
                        new DocSort()
                    )))
                    .highlight(Highlight.newBuilder()
                        .addFieldHighlightParam("Col_Nested.Level1_Col1_Text", HighlightParameter.newBuilder().build())
                        .build())
                .build())))
        .build();
    SearchResponse resp = client.search(searchRequest);

    // 列印高亮結果。
    printSearchHit(resp.getSearchHits(), "");
}

/**
 * 列印searchHit內容。
 * @param searchHits searchHits
 * @param prefix Nested結構輸出時，增加首碼以列印層次資訊。
 */
private static void printSearchHit(List<SearchHit> searchHits, String prefix) {
    for (SearchHit searchHit : searchHits) {
        if (searchHit.getScore() != null) {
            System.out.printf("%s Score: %s\n", prefix, searchHit.getScore());
        }

        if (searchHit.getOffset() != null) {
            System.out.printf("%s Offset: %s\n", prefix, searchHit.getOffset());
        }

        if (searchHit.getRow() != null) {
            System.out.printf("%s Row: %s\n", prefix, searchHit.getRow().toString());
        }

        // 列印各欄位高亮分區結果。
        if (searchHit.getHighlightResultItem() != null) {
            System.out.printf("%s Highlight: \n", prefix);
            StringBuilder strBuilder = new StringBuilder();
            for (Map.Entry<String, HighlightField> entry : searchHit.getHighlightResultItem().getHighlightFields().entrySet()) {
                strBuilder.append(entry.getKey()).append(":").append("[");
                strBuilder.append(StringUtils.join(",", entry.getValue().getFragments())).append("]\n");
            }
            System.out.printf("%s   %s", prefix, strBuilder);
        }

        // 巢狀型別高亮結果。
        for (SearchInnerHit searchInnerHit : searchHit.getSearchInnerHits().values()) {
            System.out.printf("%s Path: %s\n", prefix, searchInnerHit.getPath());
            System.out.printf("%s InnerHit: \n", prefix);
            printSearchHit(searchInnerHit.getSubSearchHits(), prefix + "    ");
        }

        System.out.println();
    }
}

計費說明

使用多元索引查詢資料時會消耗讀輸送量。更多資訊，請參見多元索引計量計費。

Tablestore：巢狀型別查詢

介面

參數