Tablestore:ネストされたクエリ

単一レベルのネストされたクエリの例

次の例は、`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` はネストされたフィールドであり、その子行には `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());
}

複合ネストされたクエリの例

次の例は、データをクエリする方法を示しています。ご自身のクエリ要件に合った例を参照してください。

public static void nestedQuery(SyncClient client) {
    // 条件 1: col_nested の子行における col_keyword 列の値が "tablestore" であること。
    TermQuery termQuery = new TermQuery();
    termQuery.setFieldName("col_nested.col_keyword");
    termQuery.setTerm(ColumnValue.fromString("tablestore"));

    // 条件 2: 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("<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());
}

public static void nestedQuery(SyncClient client) {
        // 条件 1: 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);

        // 条件 2: 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(existsQuery);

        // 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("<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` ネストされたフィールドの `Level1_Col1_Nested` サブフィールドの値が `hangzhou shanghai` と一致するデータを `NestedQuery` を使用してクエリする方法を示しています。検索クエリは、返された結果内でハイライト表示されます。

/**
 * NestedQuery でサマリーおよびハイライトを使用します。innerHits を使用してパラメーターを設定します。
 */
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.match("Col_Nested.Level1_Col1_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 検索ヒット。
 * @param prefix 階層情報を示すために、ネストされた構造を出力する際に追加するプレフィックス。
 */
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) の 2 つのサブフィールドが含まれていると仮定します。`Level1_Col2_Nested` ネストされたフィールドには、`Level2_Col1_Text` サブフィールドが含まれます。

次の例は、`Col_Nested` フィールドの `Level1_Col1_Text` サブフィールドおよび `Level1_Col2_Nested` 下の `Level2_Col1_Text` サブフィールドの両方にサマリーおよびハイライト機能を使用するために、`NestedQuery` に `BoolQuery` を追加する方法を示しています。

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())
            .build();
    SearchResponse resp = client.search(searchRequest);
    // ハイライトされた結果を出力します。
    printSearchHit(resp.getSearchHits(), "");
}

/**
 * searchHit のコンテンツを出力します。
 * @param searchHits 検索ヒット。
 * @param prefix 階層情報を示すために、ネストされた構造を出力する際に追加するプレフィックス。
 */
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();
    }
}