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!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.