Back to Influxdb

sort() function

content/flux/v0/stdlib/universe/sort.md

latest3.1 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/universe/universe.flux#L2500-L2500 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

sort() orders rows in each input table based on values in specified columns.

Output data

One output table is produced for each input table. Output tables have the same schema as their corresponding input tables.

Sorting with null values

When desc: false, null values are last in the sort order. When desc: true, null values are first in the sort order.

Function type signature
js
(<-tables: stream[A], ?columns: [string], ?desc: bool) => stream[A] where A: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

columns

List of columns to sort by. Default is ["_value"].

Sort precedence is determined by list order (left to right).

desc

Sort results in descending order. Default is false.

tables

Input data. Default is piped-forward data (<-).

Examples

Sort values in ascending order

js
import "sampledata"

sampledata.int()
    |> sort()

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:50Z4t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:30Z17t1
_time_value*tag
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:50Z1t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:30Z19t2

{{% /expand %}} {{< /expand-wrapper >}}