2.6 KiB
2.6 KiB
title | description | menu | weight | flux/v0/tags | introduced | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
boundaries.month() function | `boundaries.month()` returns a record with `start` and `stop` boundary timestamps for the current month. |
|
301 |
|
0.177.1 |
boundaries.month()
returns a record with start
and stop
boundary timestamps for the current month.
now()
determines the current month.
Function type signature
(?month_offset: int) => {stop: time, start: time}
{{% caption %}} For more information, see Function type signatures. {{% /caption %}}
Parameters
month_offset
Number of months to offset from the current month. Default is 0
.
Use a negative offset to return boundaries from previous months. Use a positive offset to return boundaries for future months.
Examples
- Return start and stop timestamps for the current month
- Query data from this month
- Query data from last month
Return start and stop timestamps for the current month
import "experimental/date/boundaries"
option now = () => 2022-05-10T10:10:00Z
boundaries.month(
)// Returns {start:2022-05-01T00:00:00.000000000Z, stop:2022-06-01T00:00:00.000000000Z}
Query data from this month
import "experimental/date/boundaries"
thisMonth = boundaries.month()
from(bucket: "example-bucket")
|> range(start: thisMonth.start, stop: thisMonth.stop)
Query data from last month
import "experimental/date/boundaries"
lastMonth = boundaries.month(month_offset: -1)
from(bucket: "example-bucket")
|> range(start: lastMonth.start, stop: lastMonth.stop)