Skip to content

DataqueryBuilder🔗

Constructor🔗

new DataqueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

column🔗

column(string $column)

connectionArgs🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Athena\ConnectionArgs> $connectionArgs

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

datasource🔗

For mixed data sources the selected datasource is on the query level.

For non mixed scenarios this is undefined.

TODO find a better way to do this ^ that's friendly to schema

TODO this shouldn't be unknown but DataSourceRef | null

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

format🔗

format(\Grafana\Foundation\Athena\FormatOptions $format)

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)

hide(bool $hide)

queryID🔗

queryID(string $queryID)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

queryType(string $queryType)

rawSQL🔗

rawSQL(string $rawSQL)

refId🔗

A unique identifier for the query within the list of targets.

In server side expressions, the refId is used as a variable name to identify results.

By default, the UI will assign A->Z; however setting meaningful names may be useful.

refId(string $refId)

table🔗

table(string $table)

See also🔗