docs-v2/content/flux/v0/stdlib/timezone/location.md

2.1 KiB

title description menu weight flux/v0/tags
timezone.location() function `timezone.location()` returns a location record based on a location or timezone name.
flux_v0_ref
name parent identifier
timezone.location timezone timezone/location
101
date/time
location

timezone.location() returns a location record based on a location or timezone name.

Function type signature
(name: string) => {zone: string, offset: duration}

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

Parameters

name

({{< req >}}) Location name (as defined by your operating system timezone database).

Examples

Return a timezone-based location record

import "timezone"

timezone.location(name: "America/Los_Angeles")// Returns {offset: 0ns, zone: "America/Los_Angeles"}


Set the location option using a timezone-based location

import "timezone"

option location = timezone.location(name: "America/Los_Angeles")

[!Note] The location option only affects boundaries used for windowing, specifically around time shifts like daylight savings. It does not change timestamps in the _time column, which are always UTC.