すべてのプロダクト
Search
ドキュメントセンター

Tablestore:Aggregation

最終更新日:Sep 30, 2026

このトピックでは、Table Store の集約機能を使用してデータを分析する方法について説明します。この機能を使用すると、最小値、最大値、合計、平均値、件数、個別件数、パーセンタイルなどのメトリックを計算できます。また、フィールド値、範囲、場所、またはフィルターによるデータのグループ化、ヒストグラムと日付ヒストグラムの生成、各グループ内の行の取得、ネストされたクエリの実行も可能です。さらに、複数の集約関数を組み合わせて複雑なクエリを構築することもできます。

操作手順

次の図は、完全な集約手順を示しています。

fig_agg_pro

クエリが完了すると、サーバーは一致するすべてのドキュメントを集約します。したがって、集約を含むリクエストは、含まないリクエストよりも処理が複雑になります。

特徴

集約は、MIN()、MAX()、SUM()、AVG()、COUNT()、COUNT(DISTINCT)、ANY_VALUE()、GROUP BY など、さまざまな SQL 関数に類似した機能を提供します。また、パーセンタイル統計、フィールド値によるグループ化、複数フィールドによるグループ化、範囲によるグループ化、地理的位置によるグループ化、フィルターによるグループ化、ヒストグラム集約、日付ヒストグラム集約、サブ集約などの他の機能もサポートしています。次の表に、これらの機能の詳細を示します。

特徴

説明

最小値

フィールドの最小値を返します。SQL の MIN 関数に似ています。

最大値

フィールドの最大値を返します。SQL の max 関数に似ています。

合計

数値フィールドの値の合計を返します。SQL の sum 関数に似ています。

平均値

数値フィールドの平均値を計算します。SQL の avg 関数に似ています。

件数

指定されたフィールドの値の数、または多次元インデックス内の行の総数を返します。SQL の COUNT 関数に似ています。

個別件数

指定されたフィールドの個別値の数を返します。SQL の COUNT(DISTINCT) 関数に似ています。

パーセンタイル統計

パーセンタイル統計を使用して、データセットのパーセンタイル分布を分析します。たとえば、定常的な O&M 中に、P25、P50、P90、P99 などのパーセンタイルを確認することで、リクエストレイテンシーの分布を追跡できます。

フィールド値によるグループ化

指定されたフィールドの値に基づいてクエリ結果をグループ化します。同じフィールド値を持つ行が 1 つのグループを形成します。この操作は、各グループの値とその行数を返します。

サブ集約

グループ化集約はネストをサポートしており、グループ内にサブ集約を追加できます。

複数フィールドによるグループ化

複数のフィールドに基づいてクエリ結果をグループ化します。この機能は、ページネーショントークンを使用したページングをサポートしています。

範囲によるグループ化

フィールドの値に基づいてクエリ結果をカスタム範囲にグループ化し、各範囲の件数を返します。

地理的位置によるグループ化

原点からの距離によってクエリ結果をグループ化します。この操作は、指定された距離範囲内の項目を同じグループに配置し、各範囲の件数を返します。

フィルターによるグループ化

指定されたフィルターに基づいてクエリ結果をグループ化します。この集約は、各フィルターに一致するドキュメントの件数を返します。結果は、フィルターが追加されたのと同じ順序で返されます。

ヒストグラム集約

指定されたデータ間隔でクエリ結果をグループ化します。同じ間隔内にあるフィールド値を持つ行は、同じグループに配置されます。この操作は、各グループの開始値とそれに対応する行数を返します。

日付ヒストグラム集約

日付フィールドの場合、行を指定された時間間隔のバケットにグループ化し、各バケットの行数を返します。

集約グループからの行の取得

クエリ結果をグループ化した後、トップ行集約は各グループから選択された行を取得します。この機能は、MySQL の ANY_VALUE(field) 関数に似ています。

複数集約

1 つのクエリで複数の集約を組み合わせることができます。

説明

複数の集約を含む複雑なクエリは、応答時間に影響を与える可能性があります。

関連 API

集約の API オペレーションは Search です。

前提条件

Table Store コンソール、CLI、または SDK を使用して集約を実行できます。

重要

Table Store コンソールと CLI は、集約機能の一部のみをサポートしています。

コンソール

  1. [インデックス管理] タブに移動します。

    1. Table Store コンソールにログインします。

    2. 上部のナビゲーションバーで、リソースグループとリージョンを選択します。

    3. [概要] ページで、インスタンス名をクリックするか、[操作] 列の [インスタンス管理] をクリックします。

    4. [インスタンス詳細] タブの [データテーブルリスト] タブで、データテーブル名をクリックするか、[操作] 列の [インデックス管理] をクリックします。

  2. [インデックス管理] タブで、目的の検索インデックスを見つけ、[操作] 列の [検索] をクリックします。

  3. 検索 ダイアログボックスで、クエリ条件を指定します。

    1. デフォルトでは、すべての列が返されます。特定の列を返すには、[すべての列を取得] をオフにし、列名をコンマで区切って入力します。

      説明

      デフォルトでは、Table Store はデータテーブルのプライマリキー列を返します。

    2. 論理演算子 [And]、[Or]、または [Not] を選択します。

      [And] を選択すると、クエリは指定されたすべての条件を満たすデータを返します。[Or] を選択すると、クエリは指定された条件の少なくとも 1 つを満たすデータを返します。[Not] を選択すると、クエリは指定された条件を満たさないデータを返します。

    3. インデックスフィールドを選択し、追加 をクリックして、フィールドのクエリタイプと値を設定します。

      このステップを繰り返して、複数のインデックスフィールドのクエリ条件を追加できます。

    4. デフォルトでは、ソートは無効になっています。結果を特定のフィールドでソートするには、[ソートを有効にする] をオンにし、ソートフィールドを追加して、ソート順を設定します。

    5. デフォルトでは、統計機能は無効になっています。特定のフィールドの統計を収集するには、[統計を収集] スイッチをオンにし、統計を収集したいフィールドを追加してから、必要に応じて統計タイプ、項目、およびデフォルト値を設定します。

      一度に複数のフィールドを統計用に追加できます。[統計タイプ] の有効な値は、[最小値]、[最大値]、[合計]、[平均値]、[件数]、および [個別件数] です。[デフォルト] パラメーターは、行にフィールドが存在しない場合に使用する値を指定します。

  4. OK をクリックします。

    インデックス タブに、クエリに一致するデータと統計結果が表示されます。

CLI

Table Store CLI のsearch コマンドでデータをクエリする際に、集約も実行できます。サポートされている集約タイプには、最小値 (min)、最大値 (max)、合計 (sum)、平均値 (avg)、件数 (count) があります。詳細については、「多次元インデックスの検索」をご参照ください。

  1. 次のsearch コマンドを実行して、search_index 多次元インデックスを使用してテーブル内のデータをクエリおよび分析し、すべてのインデックス付き列を返します。

    search -n search_index --return_all_indexed
  2. プロンプトに従ってクエリ条件を入力します。

    次の例は、gid 列の値が 10 未満または 77 である行を取得するクエリを示しています。このクエリは、gid 列の平均値も計算します。

    {
        "Offset": -1,
        "Limit": 10,
        "Collapse": null,
        "Sort": null,
        "GetTotalCount": true,
        "Token": null,
        "Query": {
            "Name": "BoolQuery",
            "Query": {
                "MinimumShouldMatch": 1,
                "MustQueries": null,
                "MustNotQueries": null,
                "FilterQueries": null,
                "ShouldQueries": [{
                    "Name": "RangeQuery",
                    "Query": {
                        "FieldName": "gid",
                        "From": null,
                        "To": 10,
                        "IncludeLower": false,
                        "IncludeUpper": false
                    }
                }, {
                    "Name": "TermQuery",
                    "Query": {
                        "FieldName": "gid",
                        "Term": 77
                    }
                }]
            }
        },
        "Aggregations": [{
            "Name": "avg",
            "Aggregation": {
                "AggName": "agg1",
                "Field": "gid",
                "MissingValue": null
            }
        }]
    }

Tablestore SDK

集約は、Tablestore SDK for Java、Tablestore SDK for Go、Tablestore SDK for Python、Tablestore SDK for Node.js、Tablestore SDK for .NET、および Tablestore SDK for PHP を使用して実行できます。このトピックの例では、Tablestore SDK for Java を使用します。

重要

集約機能は、多次元インデックスに定義されたフィールドタイプをサポートしています。これらのタイプと、データテーブルのフィールドタイプからのマッピング方法の詳細については、「データ型」をご参照ください。

最小値

フィールドの最小値を返します。SQL の MIN 関数に似ています。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、および Date 型のみがサポートされています。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * product テーブルには各製品の価格が記載されています。浙江省で生産された製品の最低価格をクエリします。
     * SQL ステートメント:SELECT min(column_price) FROM product where place_of_production="Zhejiang";
     */
    public void min(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.term("place_of_production", "Zhejiang"))
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.min("min_agg_1", "column_price").missing(100))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsMinAggregationResult("min_agg_1").getValue());
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            TermQuery query = new TermQuery();
            query.setTerm(ColumnValue.fromString("Zhejiang"));
            query.setFieldName("place_of_production");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.term("place_of_production", "Zhejiang").build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            MinAggregation aggregation = new MinAggregation();
            aggregation.setAggName("min_agg_1");
            aggregation.setFieldName("column_price");
            aggregation.setMissing(ColumnValue.fromLong(100));
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // MinAggregation aggregation2 = AggregationBuilders.min("min_agg_1", "column_price").missing(100).build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsMinAggregationResult("min_agg_1").getValue());
        }
    }

最大値

フィールドの最大値を返します。SQL の max 関数に似ています。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、および Date 型のみがサポートされています。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * product テーブルには各製品の価格が記載されています。浙江省で生産された製品の最高価格をクエリします。
     * SQL ステートメント:SELECT max(column_price) FROM product where place_of_production="Zhejiang";
     */
    public void max(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.term("place_of_production", "Zhejiang"))
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.max("max_agg_1", "column_price").missing(0))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsMaxAggregationResult("max_agg_1").getValue());
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            TermQuery query = new TermQuery();
            query.setTerm(ColumnValue.fromString("Zhejiang"));
            query.setFieldName("place_of_production");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.term("place_of_production", "Zhejiang").build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            MaxAggregation aggregation = new MaxAggregation();
            aggregation.setAggName("max_agg_1");
            aggregation.setFieldName("column_price");
            aggregation.setMissing(ColumnValue.fromLong(100));
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // MaxAggregation aggregation2 = AggregationBuilders.max("max_agg_1", "column_price").missing(100).build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsMaxAggregationResult("max_agg_1").getValue());
        }
    }

合計

数値フィールドの値の合計を返します。SQL の sum 関数に似ています。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long および Double 型のみがサポートされています。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * product テーブルには各製品の価格が記載されています。浙江省で生産された製品の最高価格をクエリします。
     * SQL ステートメント:SELECT sum(column_price) FROM product where place_of_production="Zhejiang";
     */
    public void sum(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.term("place_of_production", "Zhejiang"))
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.sum("sum_agg_1", "column_number").missing(10))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsSumAggregationResult("sum_agg_1").getValue());
        }
    
        // builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            TermQuery query = new TermQuery();
            query.setTerm(ColumnValue.fromString("Zhejiang"));
            query.setFieldName("place_of_production");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.term("place_of_production", "Zhejiang").build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            SumAggregation aggregation = new SumAggregation();
            aggregation.setAggName("sum_agg_1");
            aggregation.setFieldName("column_number");
            aggregation.setMissing(ColumnValue.fromLong(100));
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // SumAggregation aggregation2 = AggregationBuilders.sum("sum_agg_1", "column_number").missing(10).build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsSumAggregationResult("sum_agg_1").getValue());
        }
    }

平均値

数値フィールドの平均値を計算します。SQL の avg 関数に似ています。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、および Date 型のみがサポートされています。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * product テーブルには各製品の売上が記載されています。浙江省で生産された製品の平均価格をクエリします。
     * SQL ステートメント:SELECT avg(column_price) FROM product where place_of_production="Zhejiang";
     */
    public void avg(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.term("place_of_production", "Zhejiang"))
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.avg("avg_agg_1", "column_price"))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsAvgAggregationResult("avg_agg_1").getValue());
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            TermQuery query = new TermQuery();
            query.setTerm(ColumnValue.fromString("Zhejiang"));
            query.setFieldName("place_of_production");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.term("place_of_production", "Zhejiang").build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            AvgAggregation aggregation = new AvgAggregation();
            aggregation.setAggName("avg_agg_1");
            aggregation.setFieldName("column_price");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // AvgAggregation aggregation2 = AggregationBuilders.avg("avg_agg_1", "column_price").build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsAvgAggregationResult("avg_agg_1").getValue());
        }
    }                    

件数

指定されたフィールドの値の数、または多次元インデックス内の行の総数をカウントします。SQL の count 関数に似ています。

説明

多次元インデックス内の行の総数、またはクエリ条件を満たす行の総数をクエリするには、次のメソッドを使用します:

  • 集約の件数機能を使用します。リクエストで count パラメーターを * に設定します。

  • クエリ機能を使用して、クエリ条件を満たす行の数を取得します。クエリで setGetTotalCount パラメーターを true に設定します。MatchAllQuery を使用して、多次元インデックス内の行の総数を取得します。

count 式の値として列名を使用して、多次元インデックス内のその列を含む行の数をクエリします。このメソッドは、スパース列を含むシナリオに適しています。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、Boolean、Keyword、Geo_point、および Date 型のみがサポートされています。

  • 例

    /**
     * 業者のペナルティ記録が業者テーブルに記録されています。浙江省に所在し、ペナルティ記録が存在する業者の数をクエリできます。業者にペナルティ記録が存在しない場合、ペナルティ記録に対応するフィールドもその業者には存在しません。
     * SQL ステートメント:SELECT count(column_history) FROM product where place_of_production="Zhejiang";
     */
    public void count(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.term("place_of_production", "Zhejiang"))
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.count("count_agg_1", "column_history"))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsCountAggregationResult("count_agg_1").getValue());
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            TermQuery query = new TermQuery();
            query.setTerm(ColumnValue.fromString("Zhejiang"));
            query.setFieldName("place_of_production");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.term("place_of_production", "Zhejiang").build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            CountAggregation aggregation = new CountAggregation();
            aggregation.setAggName("count_agg_1");
            aggregation.setFieldName("column_history");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // CountAggregation aggregation2 = AggregationBuilders.count("count_agg_1", "column_history").build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsCountAggregationResult("count_agg_1").getValue());
        }
    }

ユニーク数

指定されたフィールドの個別値の数を返します。SQL の count(distinct) 関数に似ています。

説明

個別値の数は概算値です。

  • 個別件数機能を使用する前の行の総数が 10,000 未満の場合、計算結果は正確な値に近くなります。

  • 個別件数機能を使用する前の行の総数が 1 億以上の場合、誤差率は約 2% です。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、Boolean、Keyword、Geo_point、および Date 型のみがサポートされています。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * 製品が生産された個別省の数をクエリします。
     * SQL ステートメント:SELECT count(distinct column_place) FROM product;
     */
    public void distinctCount(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.matchAll())
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.distinctCount("dis_count_agg_1", "column_place"))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsDistinctCountAggregationResult("dis_count_agg_1").getValue());
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            MatchAllQuery query = new MatchAllQuery();
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.matchAll().build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            DistinctCountAggregation aggregation = new DistinctCountAggregation();
            aggregation.setAggName("dis_count_agg_1");
            aggregation.setFieldName("column_place");
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // DistinctCountAggregation aggregation2 = AggregationBuilders.distinctCount("dis_count_agg_1", "column_place").build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            System.out.println(resp.getAggregationResults().getAsDistinctCountAggregationResult("dis_count_agg_1").getValue());
        }
    }

パーセンタイル統計

パーセンタイル統計を使用して、データセットのパーセンタイル分布を分析します。たとえば、定常的な O&M 中に、P25、P50、P90、P99 などのパーセンタイルを確認することで、リクエストレイテンシーの分布を追跡できます。

説明

結果の精度を向上させるために、p1 や p99 などの極端なパーセンタイル値を指定することを推奨します。p50 などの他の値の代わりに極端なパーセンタイル値を使用すると、返される結果がより正確になります。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、および Date 型のみがサポートされています。

    percentiles

    p50、p90、p99 などのパーセンタイル。1 つまたは複数のパーセンタイルを指定できます。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * パーセンタイルを使用して、システムに送信される各リクエストの応答時間の分布を分析します。
     */
    public void percentilesAgg(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("indexName")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.matchAll())
                                    .limit(0) // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addAggregation(AggregationBuilders.percentiles("percentilesAgg", "latency")
                                            .percentiles(Arrays.asList(25.0d, 50.0d, 99.0d))
                                            .missing(1.0))
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //結果を取得します。
            PercentilesAggregationResult percentilesAggregationResult = resp.getAggregationResults().getAsPercentilesAggregationResult("percentilesAgg");
            for (PercentilesAggregationItem item : percentilesAggregationResult.getPercentilesAggregationItems()) {
                System.out.println("key:" + item.getKey() + " value:" + item.getValue().asDouble());
            }
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            MatchAllQuery query = new MatchAllQuery();
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.matchAll().build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            PercentilesAggregation aggregation = new PercentilesAggregation();
            aggregation.setAggName("percentilesAgg");
            aggregation.setFieldName("latency");
            aggregation.setPercentiles(Arrays.asList(25.0d, 50.0d, 99.0d));
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // AggregationBuilders.percentiles("percentilesAgg", "latency").percentiles(Arrays.asList(25.0d, 50.0d, 99.0d)).missing(1.0).build();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            aggregationList.add(aggregation);
            searchQuery.setAggregationList(aggregationList);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //結果を取得します。
            PercentilesAggregationResult percentilesAggregationResult = resp.getAggregationResults().getAsPercentilesAggregationResult("percentilesAgg");
            for (PercentilesAggregationItem item : percentilesAggregationResult.getPercentilesAggregationItems()) {
                System.out.println("key:" + item.getKey() + " value:" + item.getValue().asDouble());
            }
        }
    }

フィールド値によるグループ化

指定されたフィールドの値に基づいてクエリ結果をグループ化します。同じフィールド値を持つ行が 1 つのグループを形成します。この操作は、各グループの値とその行数を返します。

説明
  • フィールド値によるグループ化は並列計算を使用します。これは不正確な統計手法であるため、結果に軽微な誤差が含まれる可能性があります。

  • 複数フィールドのグループ化を実行するには、ネストされたグループ化または複数フィールドのグループ化のいずれかを使用できます。これらの 2 つのメソッドの比較については、「付録:複数フィールドのグループ化手法の比較」をご参照ください。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long、Double、Boolean、Keyword、および Date 型のみがサポートされています。

    groupBySorter

    グループのソート順。デフォルトでは、グループはグループ内の項目数に基づいて降順でソートされます。複数のソートルールを設定した場合、グループはルールが設定された順序に基づいてソートされます。次のソートルールがサポートされています:

    • groupKeySortInAsc:値のアルファベット順でソートします。

    • groupKeySortInDesc:値のアルファベット逆順でソートします。

    • rowCountSortInAsc:行数の昇順でソートします。

    • rowCountSortInDesc (デフォルト):行数の降順でソートします。

    • subAggSortInAsc:サブ集約結果から得られた値の昇順でソートします。

    • subAggSortInDesc:サブ集約結果から得られた値の降順でソートします。

    size

    返したいグループの数。デフォルト値:10。最大値:2000。

    subAggregations

    各グループのデータに対して実行できるサブ集約操作 (最大値、合計、平均値の計算など)。

    subGroupBys

    各親グループのデータに対して実行できるサブグループ化操作で、データをさらにグループ化します。

  • 例

    単一フィールドによるグループ化

    /**
     * 各カテゴリの製品数、および最大・最小製品価格をクエリします。
     * 返される結果の例:果物:5。最高価格は 2 米ドル、最低価格は 0.5 米ドル。洗面用品:10。最高価格は 13 米ドル、最低価格は 0.1 米ドル。電子機器:3。最高価格は 1,160 米ドル、最低価格は 310 米ドル。その他の製品:15。最高価格は 130 米ドル、最低価格は 11 米ドル。
     */
    public void groupByField(SyncClient client) {
        //builder を使用してクエリ文を作成します。
        {
            SearchRequest searchRequest = SearchRequest.newBuilder()
                    .tableName("<TABLE_NAME>")
                    .indexName("<SEARCH_INDEX_NAME>")
                    .searchQuery(
                            SearchQuery.newBuilder()
                                    .query(QueryBuilders.matchAll())
                                    .limit(0)  // 特定のデータではなく集約結果のみを取得したい場合は、limit を 0 に設定してクエリパフォーマンスを向上させます。
                                    .addGroupBy(GroupByBuilders
                                            .groupByField("name1", "column_type")
                                            .addSubAggregation(AggregationBuilders.min("subName1", "column_price"))
                                            .addSubAggregation(AggregationBuilders.max("subName2", "column_price"))
                                    )
                                    .build())
                    .build();
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            for (GroupByFieldResultItem item : resp.getGroupByResults().getAsGroupByFieldResult("name1").getGroupByFieldResultItems()) {
                //値を表示します。
                System.out.println(item.getKey());
                //行数を表示します。
                System.out.println(item.getRowCount());
                //最低価格を表示します。
                System.out.println(item.getSubAggregationResults().getAsMinAggregationResult("subName1").getValue());
                //最高価格を表示します。
                System.out.println(item.getSubAggregationResults().getAsMaxAggregationResult("subName2").getValue());
            }
        }
    
        //builder を使用せずにクエリ文を作成します。
        {
            SearchRequest searchRequest = new SearchRequest();
            searchRequest.setTableName("<TABLE_NAME>");
            searchRequest.setIndexName("<SEARCH_INDEX_NAME>");
    
            SearchQuery searchQuery = new SearchQuery();
            MatchAllQuery query = new MatchAllQuery();
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、TermQuery を使用してクエリ文を作成する方法と同じ効果があります。
            // Query query2 = QueryBuilders.matchAll().build();
    
            searchQuery.setQuery(query);
            searchQuery.setLimit(0);
    
            GroupByField groupByField = new GroupByField();
            groupByField.setGroupByName("name1");
            groupByField.setFieldName("column_type");
            //サブ集約操作を設定します。
            MinAggregation minAggregation = AggregationBuilders.min("subName1", "column_price").build();
            MaxAggregation maxAggregation = AggregationBuilders.max("subName2", "column_price").build();
            groupByField.setSubAggregations(Arrays.asList(minAggregation, maxAggregation));
    
            // 以下のコメントでは、builder を使用してクエリ文を作成しています。builder を使用してクエリ文を作成する方法は、aggregation を使用してクエリ文を作成する方法と同じ効果があります。
            // GroupByBuilders.groupByField("name1", "column_type")
            //        .addSubAggregation(AggregationBuilders.min("subName1", "column_price"))
            //        .addSubAggregation(AggregationBuilders.max("subName2", "column_price").build());
            List<GroupBy> groupByList = new ArrayList<GroupBy>();
            groupByList.add(groupByField);
            searchQuery.setGroupByList(groupByList);
            searchRequest.setSearchQuery(searchQuery);
    
            //クエリ文を実行します。
            SearchResponse resp = client.search(searchRequest);
            //集約結果を取得します。
            for (GroupByFieldResultItem item : resp.getGroupByResults().getAsGroupByFieldResult("name1").getGroupByFieldResultItems()) {
                //値を表示します。
                System.out.println(item.getKey());
                //行数を表示します。
                System.out.println(item.getRowCount());
                //最低価格を表示します。
                System.out.println(item.getSubAggregationResults().getAsMinAggregationResult("subName1").getValue());
                //最高価格を表示します。
                System.out.println(item.getSubAggregationResults().getAsMaxAggregationResult("subName2").getValue());
            }
        }
    }

    ネストモードでの複数フィールドによるグループ化

    /**
     * ネストモードで複数のフィールドによってクエリ結果をグループ化する例。
     * 多次元インデックスでは、ネストモードで 2 つの groupBy フィールドを使用して、SQL ステートメントで複数の groupBy フィールドを使用するのと同じ効果を実現します。
     * SQL ステートメント:select a,d, sum(b),sum(c) from user group by a,d;
     */
    public void GroupByMultiField(SyncClient client) {
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .returnAllColumns(true)   //より良いクエリパフォーマンスを得るには、returnAllColumns を false に設定し、addColumesToGet の値を指定します。
            //.addColumnsToGet("col_1","col_2")
            .searchQuery(SearchQuery.newBuilder()
                .query(QueryBuilders.matchAll())   //クエリ条件を指定します。クエリ条件は SQL の WHERE 句と同じように使用できます。ネストされたクエリを実行するには QueryBuilders.bool() を使用します。
                .addGroupBy(
                    GroupByBuilders
                        .groupByField("unique name_1", "field_a")
                        .size(20)
                        .addSubGroupBy(
                            GroupByBuilders
                                .groupByField("unique name_2", "field_d")
                                .size(20)
                                .addSubAggregation(AggregationBuilders.sum("unique name_3", "field_b"))
                                .addSubAggregation(AggregationBuilders.sum("unique name_4", "field_c"))
                        )
                )
                .build())
            .build();
        SearchResponse response = client.search(searchRequest);
        //指定された条件を満たす行をクエリします。
        List<Row> rows = response.getRows();
        //集約結果を取得します。
        GroupByFieldResult groupByFieldResult1 = response.getGroupByResults().getAsGroupByFieldResult("unique name_1");
        for (GroupByFieldResultItem resultItem : groupByFieldResult1.getGroupByFieldResultItems()) {
            System.out.println("field_a key:" + resultItem.getKey() + " Count:" + resultItem.getRowCount());
            //サブ集約結果を取得します。
            GroupByFieldResult subGroupByResult = resultItem.getSubGroupByResults().getAsGroupByFieldResult("unique name_2");
            for (GroupByFieldResultItem item : subGroupByResult.getGroupByFieldResultItems()) {
                System.out.println("field_a " + resultItem.getKey() + " field_d key:" + item.getKey() + " Count: " + item.getRowCount());
                double sumOf_field_b = item.getSubAggregationResults().getAsSumAggregationResult("unique name_3").getValue();
                double sumOf_field_c = item.getSubAggregationResults().getAsSumAggregationResult("unique name_4").getValue();
                System.out.println("sumOf_field_b:" + sumOf_field_b);
                System.out.println("sumOf_field_c:" + sumOf_field_c);
            }
        }
    }

    集約のためのグループのソート

    /**
     * 集約のソートルールを設定する例。
     * メソッド:GroupBySorter を指定してソートルールを設定します。複数のソートルールを設定した場合、グループはルールが設定された順序に基づいてソートされます。GroupBySorter は昇順または降順のソートをサポートしています。
     * デフォルトでは、グループは行数の降順でソートされます (GroupBySorter.rowCountSortInDesc())。
     */
    public void groupByFieldWithSort(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .searchQuery(
                SearchQuery.newBuilder()
                    .query(QueryBuilders.matchAll())
                    .limit(0)
                    .addGroupBy(GroupByBuilders
                        .groupByField("name1", "column_type")
                        //.addGroupBySorter(GroupBySorter.subAggSortInAsc("subName1")) //サブ集約結果から得られた値に基づいてグループを昇順でソートします。
                        .addGroupBySorter(GroupBySorter.groupKeySortInAsc())           //集約結果から得られた値に基づいてグループを昇順でソートします。
                        //.addGroupBySorter(GroupBySorter.rowCountSortInDesc())        //各グループの集約結果から得られた行数に基づいてグループを降順でソートします。
                        .size(20)
                        .addSubAggregation(AggregationBuilders.min("subName1", "column_price"))
                        .addSubAggregation(AggregationBuilders.max("subName2", "column_price"))
                    )
                    .build())
            .build();
        //クエリ文を実行します。
        SearchResponse resp = client.search(searchRequest);
    }

ネストされたグループ化

グループ化集約はネストをサポートしており、グループ内にサブ集約を追加できます。

説明

パフォーマンスと複雑さのバランスをとるため、最大ネスト深度は制限されています。詳細については、「多次元インデックスの制限事項」をご参照ください。

  • 適用シナリオ

    • 多階層グループ化 (GroupBy + SubGroupBy)

      第 1 階層でデータをグループ化した後、第 2 階層のグループ化を実行します。たとえば、最初にデータを省でグループ化し、次に市でグループ化して、各省の各市のデータを取得します。

    • グループ化後の集約 (GroupBy + SubAggregation)

      第 1 階層でデータをグループ化した後、各グループのデータに対して集約操作 (最大値や平均値の計算など) を実行します。たとえば、データを省でグループ化した後、各省グループの特定のメトリックの最大値を取得します。

  • 例

    次の例は、省と市でネストされたグループ化を実行し、各省の総注文数、および各市の総注文数と最大注文額を計算する方法を示しています。

    public static void subGroupBy(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
                .tableName("<TABLE_NAME>")
                .indexName("<SEARCH_INDEX_NAME>")
                .returnAllColumns(true)
                .searchQuery(SearchQuery.newBuilder()
                        .query(QueryBuilders.matchAll()).limit(20)
                        //第 1 階層のグループ化:省でグループ化し、各省の注文 ID の数 (総注文数) をカウントします。
                        //第 2 階層のグループ化:市でグループ化し、各市の注文 ID の数 (総注文数) をカウントし、各市の最大注文額を計算します。
                        .addGroupBy(GroupByBuilders.groupByField("provinceName", "province")
                                .addSubAggregation(AggregationBuilders.count("provinceOrderCounts", "order_id"))
                                .addGroupBySorter(GroupBySorter.rowCountSortInDesc())
                                .addSubGroupBy(GroupByBuilders.groupByField("cityName", "city")
                                        .addSubAggregation(AggregationBuilders.count("cityOrderCounts", "order_id"))
                                        .addSubAggregation(AggregationBuilders.max("cityMaxAmount", "order_amount"))
                                        .addGroupBySorter(GroupBySorter.subAggSortInDesc("cityMaxAmount"))))
                        .build())
                .build();
        
        //クエリ文を実行します。
        SearchResponse resp = client.search(searchRequest);
        
        //第 1 階層のグループ化結果 (各省の総注文数) を取得します
        GroupByFieldResult results = resp.getGroupByResults().getAsGroupByFieldResult("provinceName");
        for (GroupByFieldResultItem item : results.getGroupByFieldResultItems()) {
            System.out.println("Province:" + item.getKey()
                    + "\tTotal Orders:" + item.getSubAggregationResults().getAsCountAggregationResult("provinceOrderCounts").getValue());
            
            //第 2 階層のグループ化結果 (各市の総注文数と最大注文額) を取得します
            GroupByFieldResult subResults = item.getSubGroupByResults().getAsGroupByFieldResult("cityName");
            for (GroupByFieldResultItem subItem : subResults.getGroupByFieldResultItems()) {
                System.out.println("\t(City)" + subItem.getKey()
                        + "\tTotal Orders:" + subItem.getSubAggregationResults().getAsCountAggregationResult("cityOrderCounts").getValue()
                        + "\tMaximum Order Amount:" + subItem.getSubAggregationResults().getAsMaxAggregationResult("cityMaxAmount").getValue());
            }
        }
    }

複合グループ化

複数のフィールドに基づいてクエリ結果をグループ化します。この機能は、ページネーショントークンを使用したページングをサポートしています。

重要

この機能は、Java SDK と Go SDK でのみ利用可能です。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    sources

    クエリ結果をグループ化するフィールド。最大 32 個のフィールドでクエリ結果をグループ化し、結果のグループに対して集約操作を実行します。次のグループタイプがサポートされています:

    • GroupByField:フィールド値によるグループ化。groupByName、fieldName、および groupBySorter パラメーターを設定します。

    • GroupByHistogram:ヒストグラムによるクエリ。groupByName、fieldName、interval、および groupBySorter パラメーターを設定します。

    • GroupByDateHistogram:日付ヒストグラムによるクエリ。groupByName、fieldName、interval、timeZone、および groupBySorter パラメーターを設定します。

    重要
    • sources 内のグループ項目については、辞書順でのグループ値 (groupKeySort) によるソートのみがサポートされています。デフォルトでは、グループは降順でソートされます。

    • 特定の列にフィールド値が存在しない場合、返される結果の値は NULL になります。

    nextToken

    データの次のページを取得するために使用されるページネーショントークン。デフォルトでは、このパラメーターは空です。

    最初のリクエストでは、nextToken を空に設定します。クエリ条件を満たすすべてのデータが 1 回のリクエストで返されない場合、レスポンスの nextToken パラメーターは空ではありません。ページングクエリにはこの nextToken を使用します。

    説明

    nextToken を永続化するか、フロントエンドページに送信する必要がある場合は、保存または送信する前に nextToken を文字列として Base64 エンコーディングすることを推奨します。nextToken 自体は文字列ではありません。直接 new String(nextToken) を使用してエンコーディングすると、トークン情報が失われます。

    size

    ページあたりのグループ数。デフォルト値:10。最大値:2000。

    重要
    • 返すグループの数を制限したい場合は、ほとんどの場合、size パラメーターを設定することを推奨します。

    • size パラメーターと suggestedSize パラメーターを同時に設定することはできません。

    suggestedSize

    返すグループの数。サーバー側で許可されている最大グループ数より大きい値または -1 を指定します。サーバー側は、その容量に基づいてグループ数を返します。

    このパラメーターをサーバー側で許可されている最大グループ数より大きい値に設定した場合、システムはその値をサーバー側で許可されている最大グループ数に調整します。実際に返されるグループ数は、min(suggestedSize, サーバー側で許可されている最大グループ数, グループ総数) となります。

    重要

    このパラメーターは、Table Store を Apache Spark や PrestoSQL などの高スループット計算エンジンと相互接続するシナリオに適しています。

    subAggregations

    各グループのデータに対して実行できるサブ集約操作 (最大値、合計、平均値の計算など)。

    subGroupBys

    各親グループのデータに対して実行できるサブグループ化操作で、データをさらにグループ化します。

    重要

    GroupByComposite パラメーターは subGroupBy ではサポートされていません。

  • 例

    /**
     * クエリ結果のグループ化と集約:SourceGroupBy パラメーターに渡された groupbyField、groupByHistogram、groupByDataHistogram などのパラメーターに基づいて、クエリ結果をグループ化し、結果のグループに対して集約操作を実行します。
     * 複数フィールドの集約結果をフラットな構造で返します。
     */
    public static void groupByComposite(SyncClient client) {
        GroupByComposite.Builder compositeBuilder = GroupByBuilders
                .groupByComposite("groupByComposite")
                .size(2000)
                .addSources(GroupByBuilders.groupByField("groupByField", "Col_Keyword")
                        .addGroupBySorter(GroupBySorter.groupKeySortInAsc()).build())
                .addSources(GroupByBuilders.groupByHistogram("groupByHistogram", "Col_Long")
                        .addGroupBySorter(GroupBySorter.groupKeySortInAsc())
                        .interval(5)
                        .build())
                .addSources(GroupByBuilders.groupByDateHistogram("groupByDateHistogram", "Col_Date")
                        .addGroupBySorter(GroupBySorter.groupKeySortInAsc())
                        .interval(5, DateTimeUnit.DAY)
                        .timeZone("+05:30").build());
    
        SearchRequest searchRequest = SearchRequest.newBuilder()
                .indexName("<SEARCH_INDEX_NAME>")
                .tableName("<TABLE_NAME>")
                .returnAllColumnsFromIndex(true)
                .searchQuery(SearchQuery.newBuilder()
                        .addGroupBy(compositeBuilder.build())
                        .build())
                .build();
    
        SearchResponse resp = client.search(searchRequest);
    
        while (true) {
            if (resp.getGroupByResults() == null || resp.getGroupByResults().getResultAsMap().size() == 0) {
                System.out.println("groupByComposite Result is null or empty");
                return;
            }
    
            GroupByCompositeResult result = resp.getGroupByResults().getAsGroupByCompositeResult("groupByComposite");
    
            if(!result.getSourceNames().isEmpty()) {
                for (String sourceGroupByNames: result.getSourceNames()) {
                    System.out.printf("%s\t", sourceGroupByNames);
                }
                System.out.print("rowCount\t\n");
            }
    
    
            for (GroupByCompositeResultItem item : result.getGroupByCompositeResultItems()) {
                for (String value : item.getKeys()) {
                    String val = value == null ? "NULL" : value;
                    System.out.printf("%s\t", val);
    
                }
                System.out.printf("%d\t\n", item.getRowCount());
            }
    
            // トークンを使用してグループをページングします。
            if (result.getNextToken() != null) {
                searchRequest.setSearchQuery(
                        SearchQuery.newBuilder()
                                .addGroupBy(compositeBuilder.nextToken(result.getNextToken()).build())
                                .build()
                );
                resp = client.search(searchRequest);
            } else {
                break;
            }
        }
    }

範囲によるグループ化

フィールドの値に基づいてクエリ結果をカスタム範囲にグループ化し、各範囲の件数を返します。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long および Double 型のみがサポートされています。

    range[double_from, double_to)

    グループ化のための値の範囲。

    最小値を指定するには double_from を Double.MIN_VALUE に設定し、最大値を指定するには double_to を Double.MAX_VALUE に設定します。

    subAggregation and subGroupBy

    サブ集約操作。グループ化結果に基づいてサブ集約操作を実行します。

    たとえば、売上高と省でクエリ結果をグループ化した後、指定された範囲で売上高の割合が最も大きい省を取得します。このクエリを実行するには、GroupByRange で GroupByField を指定する必要があります。

  • 例

    /**
     * 売上高を範囲 [0, 1000)、[1000, 5000)、および [5000, Double.MAX_VALUE) に基づいてグループ化し、各範囲の売上高を取得します。
     */
    public void groupByRange(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .searchQuery(
                SearchQuery.newBuilder()
                    .query(QueryBuilders.matchAll())
                    .limit(0)
                    .addGroupBy(GroupByBuilders
                        .groupByRange("name1", "column_number")
                        .addRange(0, 1000)
                        .addRange(1000, 5000)
                        .addRange(5000, Double.MAX_VALUE)
                    )
                    .build())
            .build();
        //クエリ文を実行します。
        SearchResponse resp = client.search(searchRequest);
        //集約結果を取得します。
        for (GroupByRangeResultItem item : resp.getGroupByResults().getAsGroupByRangeResult("name1").getGroupByRangeResultItems()) {
    
            //行数を表示します。
            System.out.println(item.getRowCount());
        }
    }

地理的グループ化

原点からの距離によってクエリ結果をグループ化します。この操作は、指定された距離範囲内の項目を同じグループに配置し、各範囲の件数を返します。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Geo_point 型のみがサポートされています。

    origin(double lat, double lon)

    中心点の経度と緯度。

    double lat は中心点の緯度を指定します。double lon は中心点の経度を指定します。

    range[double_from, double_to)

    グループ化に使用される距離範囲。単位:メートル。

    最小値を指定するには double_from を Double.MIN_VALUE に設定し、最大値を指定するには double_to を Double.MAX_VALUE に設定します。

    subAggregation and subGroupBy

    サブ集約操作。グループ化結果に基づいてサブ集約操作を実行します。

  • 例

    /**
     * 地理的な場所に基づいてユーザーを Wanda Plaza にグループ化し、各距離範囲のユーザー数を取得します。距離範囲は [0, 1000)、[1000, 5000)、[5000, Double.MAX_VALUE) です。単位:メートル。
     */
    public void groupByGeoDistance(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .searchQuery(
                SearchQuery.newBuilder()
                    .query(QueryBuilders.matchAll())
                    .limit(0)
                    .addGroupBy(GroupByBuilders
                        .groupByGeoDistance("name1", "column_geo_point")
                        .origin(3.1, 6.5)
                        .addRange(0, 1000)
                        .addRange(1000, 5000)
                        .addRange(5000, Double.MAX_VALUE)
                    )
                    .build())
            .build();
        //クエリ文を実行します。
        SearchResponse resp = client.search(searchRequest);
        //集約結果を取得します。
        for (GroupByGeoDistanceResultItem item : resp.getGroupByResults().getAsGroupByGeoDistanceResult("name1").getGroupByGeoDistanceResultItems()) {
           //行数を表示します。
            System.out.println(item.getRowCount());
        }
    }

フィルターによるグループ化

指定されたフィルターに基づいてクエリ結果をグループ化します。この集約は、各フィルターに一致するドキュメントの件数を返します。結果は、フィルターが追加されたのと同じ順序で返されます。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    filter

    クエリに使用できるフィルター。結果は、フィルターが指定された順序で返されます。

    subAggregation and subGroupBy

    サブ集約操作。グループ化結果に基づいてサブ集約操作を実行します。

  • 例

    /**
     * 次のフィルターを指定して、各フィルターに一致する項目数を取得します:売上高が 100 を超える、原産地が浙江省、説明に杭州が含まれる。
     */
    public void groupByFilter(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .searchQuery(
                SearchQuery.newBuilder()
                    .query(QueryBuilders.matchAll())
                    .limit(0) 
                    .addGroupBy(GroupByBuilders
                        .groupByFilter("name1")
                        .addFilter(QueryBuilders.range("number").greaterThanOrEqual(100))
                        .addFilter(QueryBuilders.term("place","Zhejiang"))
                        .addFilter(QueryBuilders.match("text","Hangzhou"))
                    )
                    .build())
            .build();
        //クエリ文を実行します。
        SearchResponse resp = client.search(searchRequest);
        //フィルターの順序に基づいて集約結果を取得します。
        for (GroupByFilterResultItem item : resp.getGroupByResults().getAsGroupByFilterResult("name1").getGroupByFilterResultItems()) {
            //行数を表示します。
            System.out.println(item.getRowCount());
        }
    }

ヒストグラムによるグループ化

指定されたデータ間隔でクエリ結果をグループ化します。同じ間隔内にあるフィールド値を持つ行は、同じグループに配置されます。この操作は、各グループの開始値とそれに対応する行数を返します。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Long および Double 型のみがサポートされています。

    interval

    集約結果を取得するために使用されるデータ間隔。

    fieldRange[min,max]

    interval パラメーターと共に使用してグループ数を制限する範囲。(fieldRange.max-fieldRange.min)/interval の数式を使用して決定されるグループ数は 2,000 を超えることはできません。

    minDocCount

    最小行数。グループ内の行数が最小行数より少ない場合、そのグループの集約結果は返されません。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

  • 例

    /**
     * 年齢層別のユーザー分布に関する統計を収集します。
     */
    public static void groupByHistogram(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
            .tableName("<TABLE_NAME>")
            .indexName("<SEARCH_INDEX_NAME>")
            .searchQuery(
                SearchQuery.newBuilder()
                    .addGroupBy(GroupByBuilders
                        .groupByHistogram("groupByHistogram", "age")
                        .interval(10)
                        .minDocCount(0L)
                        .addFieldRange(0, 99))
                    .build())
            .build();
        //クエリ文を実行します。
        SearchResponse resp = ots.search(searchRequest);
        //集約操作が実行されたときに返される結果を取得します。
        GroupByHistogramResult results = resp.getGroupByResults().getAsGroupByHistogramResult("groupByHistogram");
        for (GroupByHistogramItem item : results.getGroupByHistogramItems()) {
            System.out.println("key:" + item.getKey().asLong() + " value:" + item.getValue());
        }
    }

日付ヒストグラム

日付フィールドのクエリ結果を、指定された時間間隔でバケットにグループ化します。各バケットには同じ間隔の行が含まれ、その開始時刻と行数が返されます。

重要

この機能には、Tablestore Java SDK 5.16.1 以降が必要です。完全なバージョン履歴については、「Java SDK バージョン履歴」をご参照ください。

  • パラメーター

    パラメーター

    説明

    groupByName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    fieldName

    集約操作を実行するために使用されるフィールドの名前。Date 型のみがサポートされています。

    重要

    検索インデックスの Date 型は Tablestore SDK for Java V5.13.9 以降でサポートされています。

    interval

    統計間隔。

    fieldRange[min,max]

    interval パラメーターと共に使用してグループ数を制限する範囲。(fieldRange.max-fieldRange.min)/interval の数式を使用して決定されるグループ数は 2,000 を超えることはできません。

    minDocCount

    最小行数。グループ内の行数が最小行数より少ない場合、そのグループの集約結果は返されません。

    missing

    集約操作が実行されるフィールドのデフォルト値。フィールド値が空の行に適用されます。

    • missing パラメーターの値を指定しない場合、その行は無視されます。

    • missing パラメーターの値を指定した場合、このパラメーターの値がその行のフィールド値として使用されます。

    timeZone

    +hh:mm または -hh:mm 形式のタイムゾーン (例:+08:00 または -09:00)。このパラメーターは、フィールドが Date 型の場合にのみ必須です。

    Date 型のフィールドにこのパラメーターが指定されていない場合、集約結果に N 時間のオフセットが発生する可能性があります。この問題を回避するには、timeZone パラメーターを指定します。

  • 例

    /**
     * 2017 年 5 月 1 日 10:00:00 から 2017 年 5 月 21 日 13:00:00 までの col_date フィールドのデータの毎日の分布に関する統計を収集します。
     */
    public static void groupByDateHistogram(SyncClient client) {
        //クエリ文を作成します。
        SearchRequest searchRequest = SearchRequest.newBuilder()
        .returnAllColumns(false)
        .indexName("<SEARCH_INDEX_NAME>")
        .tableName("<TABLE_NAME>")
        .searchQuery(
            SearchQuery.newBuilder()
            .query(QueryBuilders.matchAll())
            .limit(0)
            .getTotalCount(false)
            .addGroupBy(GroupByBuilders
                        .groupByDateHistogram("groupByDateHistogram", "col_date")
                        .interval(1, DateTimeUnit.DAY)
                        .minDocCount(1)
                        .missing("2017-05-01 13:01:00")
                        .fieldRange("2017-05-01 10:00", "2017-05-21 13:00:00"))
            .build())
        .build();
        //クエリ文を実行します。
        SearchResponse resp = ots.search(searchRequest);
        //集約操作が実行されたときに返される結果を取得します。
        List<GroupByDateHistogramItem> items = resp.getGroupByResults().getAsGroupByDateHistogramResult("groupByDateHistogram").getGroupByDateHistogramItems();
        for (GroupByDateHistogramItem item : items) {
            System.out.printf("millisecondTimestamp:%d, count:%d \n", item.getTimestamp(), item.getRowCount());
        }
    }

トップ行集約

クエリ結果をグループ化した後、トップ行集約は各グループから選択された行を取得します。この機能は、MySQL の ANY_VALUE(field) 関数に似ています。

説明

トップ行集約を使用する場合、多次元インデックスにネスト型、Geopoint、または配列型のフィールドが含まれていると、集約は各行のプライマリキーのみを返します。他のフィールドを取得するには、データテーブルを別途クエリします。

  • パラメーター

    パラメーター

    説明

    aggregationName

    集約操作の一意の名前。この名前に基づいて特定の集約操作の結果をクエリします。

    limit

    各グループに対して返される最大行数。デフォルトでは、1 行のデータのみが返されます。

    sort

    グループ内のデータをソートするために使用されるソートメソッド。

    columnsToGet

    返したいフィールド。多次元インデックス内のフィールドのみがサポートされています。Array、Date、Geopoint、および Nested フィールドはサポートされていません。

    このパラメーターの値は、SearchRequest の columnsToGet パラメーターの値と同じです。SearchRequest の columnsToGet パラメーターに値を指定するだけで済みます。

  • 例

    /**
     * 学校の活動申込書には、生徒の名前、クラス、担任教師、クラス委員長などの情報を指定できるフィールドが含まれています。生徒をクラス別にグループ化して、申込統計と各クラスのプロパティ情報を表示します。
     * SQL ステートメント:select className, teacher, monitor, COUNT(*) as number from table GROUP BY className;
     */
    public void testTopRows(SyncClient client) {
        SearchRequest searchRequest = SearchRequest.newBuilder()
                .indexName("<SEARCH_INDEX_NAME>")
                .tableName("<TABLE_NAME>")
                .searchQuery(
                        SearchQuery.newBuilder()
                                .query(QueryBuilders.matchAll())
                                .limit(0) 
                                .addGroupBy(GroupByBuilders.groupByField("groupName", "className")
                                        .size(5)  //返したいグループの数を指定します。返されるグループ数の最大値については、「多次元インデックスの制限事項」トピックの GroupByField によって返されるグループ数の説明をご参照ください。
                                        .addSubAggregation(AggregationBuilders.topRows("topRowsName")
                                                .limit(1)
                                                .sort(new Sort(Arrays.asList(new FieldSort("teacher", SortOrder.DESC)))) //教師で降順にソートします。
                                        )
                                )
                                .build())
                .addColumnsToGet(Arrays.asList("teacher", "monitor"))
                .build();
        SearchResponse resp = client.search(searchRequest);
        List<GroupByFieldResultItem> items = resp.getGroupByResults().getAsGroupByFieldResult("groupName").getGroupByFieldResultItems();
        for (GroupByFieldResultItem item : items) {
            String className = item.getKey();
            long number = item.getRowCount();
            List<Row> topRows = item.getSubAggregationResults().getAsTopRowsAggregationResult("topRowsName").getRows();
            Row row = topRows.get(0);
            String teacher = row.getLatestColumn("teacher").getValue().asString();
            String monitor = row.getLatestColumn("monitor").getValue().asString();
        }
    }

複数集約

1 つのクエリで複数の集約を組み合わせることができます。

説明

複数の集約を含む複雑なクエリは、応答時間を増加させる可能性があります。

複数の集約の組み合わせ

public void multipleAggregation(SyncClient client) {
    //クエリ文を作成します。
    SearchRequest searchRequest = SearchRequest.newBuilder()
        .tableName("<TABLE_NAME>")
        .indexName("<SEARCH_INDEX_NAME>")
        .searchQuery(
            SearchQuery.newBuilder()
                .query(QueryBuilders.matchAll())
                .limit(0) 
                .addAggregation(AggregationBuilders.min("name1", "long"))
                .addAggregation(AggregationBuilders.sum("name2", "long"))
                .addAggregation(AggregationBuilders.distinctCount("name3", "long"))
                .build())
        .build();
    //クエリ文を実行します。
    SearchResponse resp = client.search(searchRequest);
    //集約操作の結果から最小値を取得します。
    System.out.println(resp.getAggregationResults().getAsMinAggregationResult("name1").getValue());
    //集約操作の結果から合計を取得します。
    System.out.println(resp.getAggregationResults().getAsSumAggregationResult("name2").getValue());
    //集約操作の結果から個別値の数を取得します。
    System.out.println(resp.getAggregationResults().getAsDistinctCountAggregationResult("name3").getValue());
}

Aggregation と GroupBy の組み合わせ

public void multipleGroupBy(SyncClient client) {
    //クエリ文を作成します。
    SearchRequest searchRequest = SearchRequest.newBuilder()
        .tableName("<TABLE_NAME>")
        .indexName("<SEARCH_INDEX_NAME>")
        .searchQuery(
            SearchQuery.newBuilder()
                .query(QueryBuilders.matchAll())
                .limit(0)
                .addAggregation(AggregationBuilders.min("name1", "long"))
                .addAggregation(AggregationBuilders.sum("name2", "long"))
                .addAggregation(AggregationBuilders.distinctCount("name3", "long"))
                .addGroupBy(GroupByBuilders.groupByField("name4", "type"))
                .addGroupBy(GroupByBuilders.groupByRange("name5", "long").addRange(1, 15))
                .build())
        .build();
    //クエリ文を実行します。
    SearchResponse resp = client.search(searchRequest);
    //集約操作の結果から最小値を取得します。
    System.out.println(resp.getAggregationResults().getAsMinAggregationResult("name1").getValue());
    //集約操作の結果から合計を取得します。
    System.out.println(resp.getAggregationResults().getAsSumAggregationResult("name2").getValue());
    //集約操作の結果から個別値の数を取得します。
    System.out.println(resp.getAggregationResults().getAsDistinctCountAggregationResult("name3").getValue());
    //集約操作の結果から GroupByField の値を取得します。
    for (GroupByFieldResultItem item : resp.getGroupByResults().getAsGroupByFieldResult("name4").getGroupByFieldResultItems()) {
        //キーを表示します。
        System.out.println(item.getKey());
        //行数を表示します。
        System.out.println(item.getRowCount());
    }
    //集約操作の結果から GroupByRange の値を取得します。
    for (GroupByRangeResultItem item : resp.getGroupByResults().getAsGroupByRangeResult("name5").getGroupByRangeResultItems()) {
        //行数を表示します。
        System.out.println(item.getRowCount());
    }
}

付録:複数フィールドのグループ化手法の比較

クエリ結果を複数のフィールドでグループ化する場合は、ネストモードで groupBy パラメーターを使用するか、GroupByComposite パラメーターを使用します。次の表に、ネストモードの groupBy パラメーターと GroupByComposite パラメーターの違いを示します。

特徴

groupBy (ネスト)

複数フィールドのグループ化

size

2000

2000

フィールドの制限

最大 3 階層までサポートされています。

最大 32 階層までサポートされています。

ページング

サポートされていません

nextToken パラメーターを使用してサポートされています

グループ内の行のソートルール

  • アルファベット順またはアルファベット逆順

  • 行数の昇順または行数の降順

  • サブ集約結果から得られた値の昇順またはサブ集約結果から得られた値の降順

アルファベット順またはアルファベット逆順

集約をサポート

はい

はい

互換性

Date 型のフィールドの場合、クエリ結果は指定されたフォーマットで返されます。

DATE 型のフィールドの場合、クエリ結果はタイムスタンプ文字列として返されます。