Note: This document is a living document and may not represent the current implementation of Flux. Any section that is not currently implemented is commented with a [IMPL#XXX] where XXX is an issue number tracking discussion and progress towards implementation.

An option represents a storage location for any value of a specified type. Options are mutable. An option can hold different values during its lifetime.

Below is a list of built-in options currently implemented in the Flux language:

  • now
  • task
  • location

The now option is a function that returns a time value used as a proxy for the current system time.

// Query should execute as if the below time is the current system time
option now = () => 2006-01-02T15:04:05-07:00

The task option schedules the execution of a Flux query.

option task = {
    name: "foo",        // Name is required.
    every: 1h,          // Task should be run at this interval.
    delay: 10m,         // Delay scheduling this task by this duration.
    cron: "0 2 * * *",  // Cron is a more sophisticated way to schedule. 'every' and 'cron' are mutually exclusive.
    retry: 5,           // Number of times to retry a failed query.

The location option sets the default time zone of all times in the script. The location maps the UTC offset in use at that location for a given time. The default value is set using the time zone of the running process.

option location = fixedZone(offset:-5h) // Set timezone to be 5 hours west of UTC.
option location = loadLocation(name:"America/Denver") // Set location to be America/Denver.

IMPL#660 Implement Location option

This documentation is open source. See a typo? Please, open an issue.

Need help getting up and running? Get Support