View Source Luminous.Query behaviour (luminous v2.6.1)

A query is embedded in a panel and contains a function which will be executed upon panel refresh to fetch the query's data.

Link to this section Summary

result()

t()

query(atom, t, list)

A module must implement this behaviour to be passed as an argument to define/2. A query must return a list of 2-tuples

define(id, mod)

Initialize a query at compile time. The module must implement the Luminous.Query behaviour.

Execute the query and return the data as multiple TimeSeries structs.

@type result() :: any()

@type t() :: %Luminous.Query{id: atom(), mod: module()}

@callback query(atom(), Luminous.TimeRange.t(), [Luminous.Variable.t()]) :: result()

A module must implement this behaviour to be passed as an argument to define/2. A query must return a list of 2-tuples:

the 2-tuple's first element is the time series' label
the 2-tuple's second element is the label's value the list must contain a 2-tuple with the label :time and a DateTime value.

@spec define(atom(), module()) :: t()

Initialize a query at compile time. The module must implement the Luminous.Query behaviour.

@spec execute(t(), Luminous.TimeRange.t(), [Luminous.Variable.t()]) :: result()

Execute the query and return the data as multiple TimeSeries structs.