Back to Influxdb

limit() function

content/flux/v0/stdlib/universe/limit.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#L1674-L1674 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

limit() returns the first n rows after the specified offset from each input table.

If an input table has less than offset + n rows, limit() returns all rows after the offset.

Function type signature
js
(<-tables: stream[A], n: int, ?offset: int) => stream[A]

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

Parameters

n

({{< req >}}) Maximum number of rows to return.

offset

Number of rows to skip per table before limiting to n. Default is 0.

tables

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

Examples

Limit results to the first three rows in each table

js
import "sampledata"

sampledata.int()
    |> limit(n: 3)

{{< 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:10Z10t1
2021-01-01T00:00:20Z7t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2

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

Limit results to the first three rows in each input table after the first two

js
import "sampledata"

sampledata.int()
    |> limit(n: 3, offset: 2)