Add docs for addLimit
This commit is contained in:
parent
7b15bb7ad5
commit
4cc6af2f41
2 changed files with 49 additions and 1 deletions
|
|
@ -5,4 +5,6 @@
|
|||
On this page you will find the methods you can use in the query builder.
|
||||
|
||||
* [addAggregateWindow()](functions/addAggregateWindow.md)
|
||||
* [addDuplicate()](functions/addDuplicate.md)
|
||||
* [addDuplicate()](functions/addDuplicate.md)
|
||||
* [addGroup()](functions/addGroup.md)
|
||||
* [addLimit()](functions/addLimit.md)
|
||||
46
docs/functions/addLimit.md
Normal file
46
docs/functions/addLimit.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Flux Query Builder Docs
|
||||
|
||||
## Functions » addLimit()
|
||||
|
||||
### Parameters:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Data type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>n</td>
|
||||
<td>integer</td>
|
||||
<td>Maximum number of rows to return.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td>integer</td>
|
||||
<td>Number of rows to skip per table before limiting to <u>n</u>. Default is 0.</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```php
|
||||
->addLimit(20, 40)
|
||||
```
|
||||
|
||||
This will result in the following Flux function part:
|
||||
|
||||
```
|
||||
|> limit(
|
||||
n: 20,
|
||||
offset: 40
|
||||
)
|
||||
```
|
||||
|
||||
### Extra resources
|
||||
|
||||
* [Flux documentation](https://docs.influxdata.com/flux/v0.x/stdlib/universe/limit/)
|
||||
Loading…
Add table
editor.link_modal.header
Reference in a new issue