painless-contexts.asciidoc

Painless contexts

A Painless script is evaluated within a context. Each context has values that are available as local variables, an allowlist that controls the available classes, and the methods and fields within those classes (API), and if and what type of value is returned.

Painless scripts typically run within one of the contexts in the following table. Before using a Painless context, configure the example data. Each context example is configured to operate on this data.

Name	Painless Documentation	Elasticsearch Documentation
Runtime field	Painless Documentation	{ref}/runtime.html[Elasticsearch Documentation]
Ingest processor	Painless Documentation	{ref}/script-processor.html[Elasticsearch Documentation]
Update	Painless Documentation	{ref}/docs-update.html[Elasticsearch Documentation]
Update by query	Painless Documentation	{ref}/docs-update-by-query.html[Elasticsearch Documentation]
Reindex	Painless Documentation	{ref}/docs-reindex.html[Elasticsearch Documentation]
Sort	Painless Documentation	{ref}/sort-search-results.html[Elasticsearch Documentation]
Similarity	Painless Documentation	{ref}/index-modules-similarity.html[Elasticsearch Documentation]
Weight	Painless Documentation	{ref}/index-modules-similarity.html[Elasticsearch Documentation]
Score	Painless Documentation	{ref}/query-dsl-function-score-query.html[Elasticsearch Documentation]
Field	Painless Documentation	{ref}/search-fields.html#script-fields[Elasticsearch Documentation]
Filter	Painless Documentation	{ref}/query-dsl-script-query.html[Elasticsearch Documentation]
Minimum should match	Painless Documentation	{ref}/query-dsl-terms-set-query.html[Elasticsearch Documentation]
Metric aggregation initialization	Painless Documentation	{ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Elasticsearch Documentation]
Metric aggregation map	Painless Documentation	{ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Elasticsearch Documentation]
Metric aggregation combine	Painless Documentation	{ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Elasticsearch Documentation]
Metric aggregation reduce	Painless Documentation	{ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Elasticsearch Documentation]
Bucket script aggregation	Painless Documentation	{ref}/search-aggregations-pipeline-bucket-script-aggregation.html[Elasticsearch Documentation]
Bucket selector aggregation	Painless Documentation	{ref}/search-aggregations-pipeline-bucket-selector-aggregation.html[Elasticsearch Documentation]
Watcher condition	Painless Documentation	{ref}/condition-script.html[Elasticsearch Documentation]
Watcher transform	Painless Documentation	{ref}/transform-script.html[Elasticsearch Documentation]

painless-contexts/index.asciidoc