- Painless Scripting Language: other versions:
- Painless Guide
- Painless Language Specification
- Painless contexts
- Context example data
- Runtime fields context
- Ingest processor context
- Update context
- Update by query context
- Reindex context
- Sort context
- Similarity context
- Weight context
- Score context
- Field context
- Filter context
- Minimum should match context
- Metric aggregation initialization context
- Metric aggregation map context
- Metric aggregation combine context
- Metric aggregation reduce context
- Bucket script aggregation context
- Bucket selector aggregation context
- Analysis Predicate Context
- Watcher condition context
- Watcher transform context
- Painless API Reference
- Shared API
- Aggregation Selector API
- Aggs API
- Aggs Combine API
- Aggs Init API
- Aggs Map API
- Aggs Reduce API
- Analysis API
- Bucket Aggregation API
- Field API
- Filter API
- Ingest API
- Interval API
- Moving Function API
- Number Sort API
- Painless Test API
- Processor Conditional API
- Score API
- Script Heuristic API
- Similarity API
- Similarity Weight API
- String Sort API
- Template API
- Terms Set API
- Update API
- Watcher Condition API
- Watcher Transform API
- Xpack Template API
Bucket selector aggregation context
editBucket selector aggregation context
editUse a Painless script in an
bucket_selector
aggregation
to determine if a bucket should be retained or filtered out.
Variables
edit-
params
(Map
, read-only) -
User-defined parameters passed in as part of the query. The parameters
include values defined as part of the
buckets_path
.
Return
edit- boolean
- True if the bucket should be retained, false if the bucket should be filtered out.
API
editTo run this example, first follow the steps in context examples.
The painless context in a bucket_selector
aggregation provides a params
map. This map contains both
user-specified custom values, as well as the values from other aggregations specified in the buckets_path
property.
Unlike some other aggregation contexts, the bucket_selector
context must return a boolean true
or false
.
This example finds the max of each bucket, adds a user-specified base_cost, and retains all of the
buckets that are greater than 10
.
params.max + params.base_cost > 10
Note that the values are extracted from the params
map. The script is in the form of an expression
that returns true
or false
. In context, the aggregation looks like this:
GET /seats/_search { "size": 0, "aggs": { "theatres": { "terms": { "field": "theatre", "size": 10 }, "aggs": { "max_cost": { "max": { "field": "cost" } }, "filtering_agg": { "bucket_selector": { "buckets_path": { "max": "max_cost" }, "script": { "params": { "base_cost": 5 }, "source": "params.max + params.base_cost > 10" } } } } } } }