Sort context
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
Use a Painless script to sort the documents in a query.
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.
doubleorString- The sort key. The return type depends on the value of the
typeparameter in the script sort config ("number"or"string").
The standard Painless API is available.
To run the example, first install the eCommerce sample data.
The following request sorts documents by the average price per item, calculated by dividing the taxful_total_price by the total_quantity.
Documents with a higher average item price appear at the top of the results.
GET /kibana_sample_data_ecommerce/_search
{
"sort": {
"_script": {
"type": "number",
"script": {
"lang": "painless",
"source": """
doc['taxful_total_price'].value / doc['total_quantity'].value
"""
},
"order": "desc"
}
}
}