Back to Elasticsearch

Sort processor [sort-processor]

docs/reference/enrich-processor/sort-processor.md

9.4.01.5 KB
Original Source

Sort processor [sort-processor]

Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array.

$$$sort-options$$$

NameRequiredDefaultDescription
fieldyes-The field to be sorted
orderno"asc"The sort order to use. Accepts "asc" or "desc".
target_fieldnofieldThe field to assign the sorted value to, by default field is updated in-place
descriptionno-Description of the processor. Useful for describing the purpose of the processor or its configuration.
ifno-Conditionally execute the processor. See Conditionally run a processor.
ignore_failurenofalseIgnore failures for the processor. See Handling pipeline failures.
on_failureno-Handle failures for the processor. See Handling pipeline failures.
tagno-Identifier for the processor. Useful for debugging and metrics.
js
{
  "sort": {
    "field": "array_field_to_sort",
    "order": "desc"
  }
}

% NOTCONSOLE