Back to Influxdb

highestMax() function

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

latest2.5 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#L4199-L4209 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

highestMax() selects the record with the highest value in the specified column from each input table and returns the highest n records.

Note: highestMax() drops empty tables.

Function type signature
js
(<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[A] where A: Record

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

Parameters

n

({{< req >}}) Number of records to return.

column

Column to evaluate. Default is _value.

groupColumns

List of columns to group by. Default is [].

tables

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

Examples

Return the highest two values from a stream of tables

js
import "sampledata"

sampledata.int()
    |> highestMax(n: 2, groupColumns: ["tag"])

{{< 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_valuetag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:30Z17t1

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