TypeSqlBuilder🔗

Constructor🔗

new TypeSqlBuilder()

Builds the object.

build()

The datasource

datasource(\Grafana\Foundation\Dashboard\DataSourceRef $datasource)

expression(string $expression)

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)

hide(bool $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

intervalMs(float $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

maxDataPoints(int $maxDataPoints)

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

queryType(string $queryType)

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

refId(string $refId)

Optionally define expected query result behavior

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Expr\ExprTypeSqlResultAssertions> $resultAssertions

resultAssertions(\Grafana\Foundation\Cog\Builder $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

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Expr\ExprTypeSqlTimeRange> $timeRange

timeRange(\Grafana\Foundation\Cog\Builder $timeRange)