docs-v2/content/flux/v0/stdlib/universe/limit.md

3.4 KiB

title description menu weight flux/v0/tags introduced
limit() function `limit()` returns the first `n` rows after the specified `offset` from each input table.
flux_v0_ref
name parent identifier
limit universe universe/limit
101
transformations
selectors
0.7.0

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

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 -2 t1
2021-01-01T00:00:10Z 10 t1
2021-01-01T00:00:20Z 7 t1
2021-01-01T00:00:30Z 17 t1
2021-01-01T00:00:40Z 15 t1
2021-01-01T00:00:50Z 4 t1
_time _value *tag
2021-01-01T00:00:00Z 19 t2
2021-01-01T00:00:10Z 4 t2
2021-01-01T00:00:20Z -3 t2
2021-01-01T00:00:30Z 19 t2
2021-01-01T00:00:40Z 13 t2
2021-01-01T00:00:50Z 1 t2

Output data

_time _value *tag
2021-01-01T00:00:00Z -2 t1
2021-01-01T00:00:10Z 10 t1
2021-01-01T00:00:20Z 7 t1
_time _value *tag
2021-01-01T00:00:00Z 19 t2
2021-01-01T00:00:10Z 4 t2
2021-01-01T00:00:20Z -3 t2

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

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

import "sampledata"

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