GroupByField は、クエリ結果をフィールド値でグループ化します。この集計方法を使用すると、フィールド値に基づいてクエリ結果をグループ化できます。同じ値は一緒にグループ化されます。各グループの同一値と、各グループ内の同一値の数が返されます。
リクエスト パラメーター
message GroupByField {
optional string field_name = 1;
optional int32 size = 2;
optional GroupBySort sort = 3;
optional Aggregations sub_aggs = 4;
optional GroupBys sub_group_bys = 5;
optional int64 min_doc_count = 6;
}パラメーター | タイプ | 必須 | 説明 |
field_name | string | はい | 集計に使用するフィールド。 |
size | int32 | はい | 返されるグループの数。デフォルト値: 10。最大値: 2000。グループの数が 2,000 を超える場合は、最初の 2,000 グループのみが返されます。 |
sort | いいえ | グループ内の項目の並べ替えルール。デフォルトでは、グループ項目は降順に並べ替えられます。複数の並べ替えルールを設定した場合、データはルールが設定された順序で並べ替えられます。 | |
sub_aggs | いいえ | グループ化結果に対して実行されるサブ集計操作。 | |
sub_group_bys | いいえ | グループ化結果に対して実行されるサブ GroupBy 操作。 | |
min_doc_count | int64 | いいえ | 行の最小数。グループ内の行数が最小行数より少ない場合、そのグループの集計結果は返されません。 |
レスポンス パラメーター
message GroupByFieldResult {
repeated GroupByFieldResultItem group_by_field_result_items = 1;
}パラメーター | タイプ | 必須 | 説明 |
group_by_field_result_items | repeated GroupByFieldResultItem | はい | 返されたグループに関する情報。 |