TypeSqlBuilder🔗

Constructor🔗

new TypeSqlBuilder()

Builds the object.

public TypeSql build()

The datasource

public TypeSqlBuilder datasource(DataSourceRef datasource)

public TypeSqlBuilder expression(String expression)

public TypeSqlBuilder format(String format)

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)

public TypeSqlBuilder hide(Boolean hide)

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

public TypeSqlBuilder intervalMs(Double intervalMs)

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

public TypeSqlBuilder maxDataPoints(Long maxDataPoints)

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

public TypeSqlBuilder queryType(String queryType)

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

public TypeSqlBuilder refId(String refId)

Optionally define expected query result behavior

public TypeSqlBuilder resultAssertions(com.grafana.foundation.cog.Builder<ExprTypeSqlResultAssertions> resultAssertions)

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

public TypeSqlBuilder timeRange(com.grafana.foundation.cog.Builder<ExprTypeSqlTimeRange> timeRange)