89 lines
1.9 KiB
Markdown
89 lines
1.9 KiB
Markdown
---
|
||
title: mode() function
|
||
description: >
|
||
The `mode()` function computes the mode or value that occurs most often in a
|
||
specified column in the input table.
|
||
aliases:
|
||
- /influxdb/v2.0/reference/flux/functions/built-in/transformations/aggregates/mode/
|
||
- /influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates/mode/
|
||
- /influxdb/cloud/reference/flux/stdlib/built-in/transformations/aggregates/mode/
|
||
menu:
|
||
flux_0_x_ref:
|
||
name: mode
|
||
parent: universe
|
||
weight: 102
|
||
flux/v0.x/tags: [aggregates, transformations]
|
||
related:
|
||
- /{{< latest "influxdb" "v1" >}}/query_language/functions/#mode, InfluxQL – MODE()
|
||
- /flux/v0.x/stdlib/experimental/mode/
|
||
introduced: 0.36.0
|
||
---
|
||
|
||
The `mode()` function computes the mode or value that occurs most often in a
|
||
specified column in the input table.
|
||
_`mode()` is an [aggregate function](/flux/v0.x/function-types/#aggregates)._
|
||
|
||
```js
|
||
mode(column: "_value")
|
||
```
|
||
|
||
If there are multiple modes, it returns all of them in a sorted table.
|
||
Mode only considers non-null values.
|
||
If there is no mode, `mode()` returns `null`.
|
||
|
||
{{% warn %}}
|
||
#### Empty tables
|
||
`mode()` drops empty tables.
|
||
{{% /warn %}}
|
||
|
||
##### Supported data types
|
||
|
||
- String
|
||
- Float
|
||
- Integer
|
||
- UInteger
|
||
- Boolean
|
||
- Time
|
||
|
||
## Parameters
|
||
|
||
### column {data-type="string"}
|
||
The column to use to compute the mode.
|
||
Default is `"_value"`.
|
||
|
||
### tables {data-type="stream of tables"}
|
||
Input data.
|
||
Default is piped-forward data ([`<-`](/flux/v0.x/spec/expressions/#pipe-expressions)).
|
||
|
||
## Examples
|
||
{{% flux/sample-example-intro %}}
|
||
|
||
```js
|
||
import "sampledata"
|
||
|
||
sampledata.int()
|
||
|> mode()
|
||
```
|
||
|
||
{{% expand "View input and output" %}}
|
||
{{< flex >}}
|
||
{{% flex-content %}}
|
||
|
||
##### Input data
|
||
{{% flux/sample "int" %}}
|
||
|
||
{{% /flex-content %}}
|
||
{{% flex-content %}}
|
||
|
||
##### Output data
|
||
| tag | _value |
|
||
| :-- | -----: |
|
||
| t1 | |
|
||
|
||
| tag | _value |
|
||
| :-- | -----: |
|
||
| t2 | 19 |
|
||
|
||
{{% /flex-content %}}
|
||
{{< /flex >}}
|
||
{{% /expand %}} |