Skip to content

TypeSqlBuilder🔗

Constructor🔗

func NewTypeSqlBuilder() *TypeSqlBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *TypeSqlBuilder) Build() (variants.Dataquery, error)

Datasource🔗

The datasource

func (builder *TypeSqlBuilder) Datasource(datasource dashboard.DataSourceRef) *TypeSqlBuilder

Expression🔗

func (builder *TypeSqlBuilder) Expression(expression string) *TypeSqlBuilder

Hide🔗

true if query is disabled (ie should not be returned to the dashboard)

NOTE: this does not always imply that the query should not be executed since

the results from a hidden query may be used as the input to other queries (SSE etc)

func (builder *TypeSqlBuilder) Hide(hide bool) *TypeSqlBuilder

IntervalMs🔗

Interval is the suggested duration between time points in a time series query.

NOTE: the values for intervalMs is not saved in the query model. It is typically calculated

from the interval required to fill a pixels in the visualization

func (builder *TypeSqlBuilder) IntervalMs(intervalMs float64) *TypeSqlBuilder

MaxDataPoints🔗

MaxDataPoints is the maximum number of data points that should be returned from a time series query.

NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated

from the number of pixels visible in a visualization

func (builder *TypeSqlBuilder) MaxDataPoints(maxDataPoints int64) *TypeSqlBuilder

QueryType🔗

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

func (builder *TypeSqlBuilder) QueryType(queryType string) *TypeSqlBuilder

RefId🔗

RefID is the unique identifier of the query, set by the frontend call.

func (builder *TypeSqlBuilder) RefId(refId string) *TypeSqlBuilder

ResultAssertions🔗

Optionally define expected query result behavior

func (builder *TypeSqlBuilder) ResultAssertions(resultAssertions cog.Builder[expr.ExprTypeSqlResultAssertions]) *TypeSqlBuilder

TimeRange🔗

TimeRange represents the query range

NOTE: unlike generic /ds/query, we can now send explicit time values in each query

NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly

func (builder *TypeSqlBuilder) TimeRange(timeRange cog.Builder[expr.ExprTypeSqlTimeRange]) *TypeSqlBuilder

See also🔗