docs-v2/content/flux/v0/stdlib/experimental/iox/sqlinterval.md

2.2 KiB

title description menu weight flux/v0/tags introduced
iox.sqlInterval() function `iox.sqlInterval()` converts a duration value to a SQL interval string.
flux_v0_ref
name parent identifier
iox.sqlInterval experimental/iox experimental/iox/sqlInterval
201
sql
type-conversions
0.192.0

iox.sqlInterval() converts a duration value to a SQL interval string.

Duration values must be positive to work as a SQL interval string.

Function type signature
(d: A) => string

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

d

({{< req >}}) Duration value to convert to SQL interval string.

Examples

Convert a duration to a SQL interval

import "experimental/iox"

iox.sqlInterval(
    d: 1y2mo3w4d5h6m7s8ms,
)// Returns 1 years 2 months 3 weeks 4 days 5 hours 6 minutes 7 seconds 8 milliseconds


Use a Flux duration to define a SQL interval

import "experimental/iox"

windowInterval = 1d12h
sqlQuery = "
SELECT
  DATE_BIN(INTERVAL '${iox.sqlInterval(
        d: windowInterval,
    )}', time, TIMESTAMP '2023-01-01T00:00:00Z') AS time_bin,
  COUNT(field1)
FROM
  measurement
GROUP BY
  time_bin
"

iox.sql(bucket: "example-bucket", query: sqlQuery)