Documentation

truncateTimeColumn() function

truncateTimeColumn() truncates all input time values in the _time to a specified unit.

Truncate to weeks

When truncating a time value to the week (1w), weeks are determined using the Unix epoch (1970-01-01T00:00:00Z UTC). The Unix epoch was on a Thursday, so all calculated weeks begin on Thursday.

Function type signature
(<-tables: stream[{B with _time: C}], unit: duration, ?timeColumn: A) => stream[{B with _time: C, _time: time}] where C: Timeable

For more information, see Function type signatures.

Parameters

unit

(Required) Unit of time to truncate to.

Example units:

  • 1ns (nanosecond)
  • 1us (microsecond)
  • 1ms (millisecond)
  • 1s (second)
  • 1m (minute)
  • 1h (hour)
  • 1d (day)
  • 1w (week)
  • 1mo (month)
  • 1y (year)

timeColumn

Time column to truncate. Default is _time.

Note: Currently, assigning a custom value to this parameter will have no effect.

tables

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

Examples

Truncate all time values to the minute

import "sampledata"

sampledata.int()
    |> truncateTimeColumn(unit: 1m)

View example input and output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: