Back to Influxdb

experimental.mode() function

content/flux/v0/stdlib/experimental/mode.md

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

experimental.mode() computes the mode or value that occurs most often in the _value column in each input table.

experimental.mode only considers non-null values. If there are multiple modes, it returns all modes in a sorted table. If there is no mode, it returns null.

Supported types

  • string
  • float
  • int
  • uint
  • bool
  • time
Function type signature
js
(<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}]

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

Parameters

tables

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

Examples

Compute the mode of input tables

js
import "experimental"
import "sampledata"

sampledata.int()
    |> experimental.mode()

{{< 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

*tag_value
t1
*tag_value
t219

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