バケットスクリプト集約

親パイプライン集約で、親のマルチバケット集約内の指定されたメトリックに対してバケットごとの計算を実行できるスクリプトを実行します。指定されたメトリックは数値でなければならず、スクリプトは数値を返す必要があります。

構文

bucket_script 集約は、単独で次のようになります:

Js

  1. {
  2.   "bucket_script": {
  3.    "buckets_path": {
  4.    "my_var1": "the_sum",
  5.    "my_var2": "the_value_count"
  6.    },
  7.    "script": "params.my_var1 / params.my_var2"
  8.   }
  9. }
ここで、my_var1 はスクリプトで使用するこのバケットのパスの変数名であり、the_sum はその変数に使用するメトリックへのパスです。


表 54. bucket_script パラメータ


| パラメータ名 | 説明 | 必須 | デフォルト値 |
| :— | :— | :— | :— |
| script | この集約のために実行するスクリプト。スクリプトはインライン、ファイル、またはインデックス化されたものが可能です。(詳細についてはスクリプティングを参照してください)
| 必須 | |
| buckets_path | 変数に使用するバケットへの関連パスを持つスクリプト変数のマップです。
(詳細についてはbuckets_path 構文を参照してください) | 必須 | |
| gap_policy | データにギャップが見つかったときに適用するポリシーです。(詳細についてはデータのギャップの処理を参照してください) | オプション | skip |
| format | 出力値のためのDecimalFormatパターン。指定された場合、フォーマットされた値は集約のvalue_as_string プロパティに返されます。 | オプション | null |

次のスニペットは、毎月のTシャツの売上高を総売上高と比較した比率パーセンテージを計算します:

Python

  1. resp = client.search(
  2.    index="sales",
  3.    size=0,
  4.    aggs={
  5.    "sales_per_month": {
  6.    "date_histogram": {
  7.    "field": "date",
  8.    "calendar_interval": "month"
  9.    },
  10.    "aggs": {
  11.    "total_sales": {
  12.    "sum": {
  13.    "field": "price"
  14.    }
  15.    },
  16.    "t-shirts": {
  17.    "filter": {
  18.    "term": {
  19.    "type": "t-shirt"
  20.    }
  21.    },
  22.    "aggs": {
  23.    "sales": {
  24.    "sum": {
  25.    "field": "price"
  26.    }
  27.    }
  28.    }
  29.    },
  30.    "t-shirt-percentage": {
  31.    "bucket_script": {
  32.    "buckets_path": {
  33.    "tShirtSales": "t-shirts>sales",
  34.    "totalSales": "total_sales"
  35.    },
  36.    "script": "params.tShirtSales / params.totalSales * 100"
  37.    }
  38.    }
  39.    }
  40.    }
  41.    },
  42. )
  43. print(resp)

Ruby

  1. response = client.search(
  2.   index: 'sales',
  3.   body: {
  4.    size: 0,
  5.    aggregations: {
  6.    sales_per_month: {
  7.    date_histogram: {
  8.    field: 'date',
  9.    calendar_interval: 'month'
  10.    },
  11.    aggregations: {
  12.    total_sales: {
  13.    sum: {
  14.    field: 'price'
  15.    }
  16.    },
  17.    "t-shirts": {
  18.    filter: {
  19.    term: {
  20.    type: 't-shirt'
  21.    }
  22.    },
  23.    aggregations: {
  24.    sales: {
  25.    sum: {
  26.    field: 'price'
  27.    }
  28.    }
  29.    }
  30.    },
  31.    "t-shirt-percentage": {
  32.    bucket_script: {
  33.    buckets_path: {
  34.    "tShirtSales": 't-shirts>sales',
  35.    "totalSales": 'total_sales'
  36.    },
  37.    script: 'params.tShirtSales / params.totalSales * 100'
  38.    }
  39.    }
  40.    }
  41.    }
  42.    }
  43.   }
  44. )
  45. puts response

Js

  1. const response = await client.search({
  2.   index: "sales",
  3.   size: 0,
  4.   aggs: {
  5.    sales_per_month: {
  6.    date_histogram: {
  7.    field: "date",
  8.    calendar_interval: "month",
  9.    },
  10.    aggs: {
  11.    total_sales: {
  12.    sum: {
  13.    field: "price",
  14.    },
  15.    },
  16.    "t-shirts": {
  17.    filter: {
  18.    term: {
  19.    type: "t-shirt",
  20.    },
  21.    },
  22.    aggs: {
  23.    sales: {
  24.    sum: {
  25.    field: "price",
  26.    },
  27.    },
  28.    },
  29.    },
  30.    "t-shirt-percentage": {
  31.    bucket_script: {
  32.    buckets_path: {
  33.    tShirtSales: "t-shirts>sales",
  34.    totalSales: "total_sales",
  35.    },
  36.    script: "params.tShirtSales / params.totalSales * 100",
  37.    },
  38.    },
  39.    },
  40.    },
  41.   },
  42. });
  43. console.log(response);

コンソール

  1. POST /sales/_search
  2. {
  3.   "size": 0,
  4.   "aggs": {
  5.    "sales_per_month": {
  6.    "date_histogram": {
  7.    "field": "date",
  8.    "calendar_interval": "month"
  9.    },
  10.    "aggs": {
  11.    "total_sales": {
  12.    "sum": {
  13.    "field": "price"
  14.    }
  15.    },
  16.    "t-shirts": {
  17.    "filter": {
  18.    "term": {
  19.    "type": "t-shirt"
  20.    }
  21.    },
  22.    "aggs": {
  23.    "sales": {
  24.    "sum": {
  25.    "field": "price"
  26.    }
  27.    }
  28.    }
  29.    },
  30.    "t-shirt-percentage": {
  31.    "bucket_script": {
  32.    "buckets_path": {
  33.    "tShirtSales": "t-shirts>sales",
  34.    "totalSales": "total_sales"
  35.    },
  36.    "script": "params.tShirtSales / params.totalSales * 100"
  37.    }
  38.    }
  39.    }
  40.    }
  41.   }
  42. }

次のような応答があるかもしれません:

コンソール-結果

  1. {
  2.    "took": 11,
  3.    "timed_out": false,
  4.    "_shards": ...,
  5.    "hits": ...,
  6.    "aggregations": {
  7.    "sales_per_month": {
  8.    "buckets": [
  9.    {
  10.    "key_as_string": "2015/01/01 00:00:00",
  11.    "key": 1420070400000,
  12.    "doc_count": 3,
  13.    "total_sales": {
  14.    "value": 550.0
  15.    },
  16.    "t-shirts": {
  17.    "doc_count": 1,
  18.    "sales": {
  19.    "value": 200.0
  20.    }
  21.    },
  22.    "t-shirt-percentage": {
  23.    "value": 36.36363636363637
  24.    }
  25.    },
  26.    {
  27.    "key_as_string": "2015/02/01 00:00:00",
  28.    "key": 1422748800000,
  29.    "doc_count": 2,
  30.    "total_sales": {
  31.    "value": 60.0
  32.    },
  33.    "t-shirts": {
  34.    "doc_count": 1,
  35.    "sales": {
  36.    "value": 10.0
  37.    }
  38.    },
  39.    "t-shirt-percentage": {
  40.    "value": 16.666666666666664
  41.    }
  42.    },
  43.    {
  44.    "key_as_string": "2015/03/01 00:00:00",
  45.    "key": 1425168000000,
  46.    "doc_count": 2,
  47.    "total_sales": {
  48.    "value": 375.0
  49.    },
  50.    "t-shirts": {
  51.    "doc_count": 1,
  52.    "sales": {
  53.    "value": 175.0
  54.    }
  55.    },
  56.    "t-shirt-percentage": {
  57.    "value": 46.666666666666664
  58.    }
  59.    }
  60.    ]
  61.    }
  62.    }
  63. }