- 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
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Sort context
editSort context
editUse a Painless script to sort the documents in a query.
Variables
-
params(Map, read-only) - User-defined parameters passed in as part of the query.
-
doc(Map, read-only) -
Contains the fields of the current document. For single-valued fields,
the value can be accessed via
doc['fieldname'].value. For multi-valued fields, this returns the first value; other values can be accessed viadoc['fieldname'].get(index) -
_score(doubleread-only) - The similarity score of the current document.
Return
-
doubleorString -
The sort key. The return type depends on the value of the
typeparameter in the script sort config ("number"or"string").
API
The standard Painless API is available.
Example
To run this example, first follow the steps in context examples.
To sort results by the length of the theatre field, submit the following query:
GET /_search { "query": { "term": { "sold": "true" } }, "sort": { "_script": { "type": "number", "script": { "lang": "painless", "source": "doc['theatre'].value.length() * params.factor", "params": { "factor": 1.1 } }, "order": "asc" } } }
Was this helpful?
Thank you for your feedback.