Skip to content

QueryBuilder🔗

Constructor🔗

new QueryBuilder()

Methods🔗

build🔗

Builds the object.

public Query build()

convertToUTC🔗

public QueryBuilder convertToUTC(Boolean convertToUTC)

dataset🔗

public QueryBuilder dataset(String dataset)

datasource🔗

New type for datasource reference

Not creating a new type until we figure out how to handle DS refs for group by, adhoc, and every place that uses DataSourceRef in TS.

public QueryBuilder datasource(com.grafana.foundation.cog.Builder<Dashboardv2beta1DataQueryKindDatasource> datasource)

editorMode🔗

public QueryBuilder editorMode(EditorMode editorMode)

format🔗

public QueryBuilder format(QueryFormat format)

hide🔗

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

public QueryBuilder hide(Boolean hide)

location🔗

public QueryBuilder location(String location)

oldDatasource🔗

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

public QueryBuilder oldDatasource(DataSourceRef datasource)

partitioned🔗

public QueryBuilder partitioned(Boolean partitioned)

partitionedField🔗

public QueryBuilder partitionedField(String partitionedField)

project🔗

public QueryBuilder project(String project)

queryPriority🔗

public QueryBuilder queryPriority(QueryPriority queryPriority)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public QueryBuilder queryType(String queryType)

rawQuery🔗

public QueryBuilder rawQuery(Boolean rawQuery)

rawSql🔗

public QueryBuilder 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.

public QueryBuilder refId(String refId)

sharded🔗

public QueryBuilder sharded(Boolean sharded)

sql🔗

public QueryBuilder sql(com.grafana.foundation.cog.Builder<SQLExpression> sql)

table🔗

public QueryBuilder table(String table)

timeShift🔗

public QueryBuilder timeShift(String timeShift)

version🔗

public QueryBuilder version(String version)

See also🔗