Skip to content

DataqueryBuilder🔗

Constructor🔗

func NewDataqueryBuilder() *DataqueryBuilder

Methods🔗

Build🔗

Builds the object.

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

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

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

EditorMode🔗

Specifies which editor is being used to prepare the query. It can be "code" or "builder"

func (builder *DataqueryBuilder) EditorMode(editorMode prometheus.QueryEditorMode) *DataqueryBuilder

Exemplar🔗

Execute an additional query to identify interesting raw samples relevant for the given expr

func (builder *DataqueryBuilder) Exemplar(exemplar bool) *DataqueryBuilder

Expr🔗

The actual expression/query that will be evaluated by Prometheus

func (builder *DataqueryBuilder) Expr(expr string) *DataqueryBuilder

Format🔗

Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap"

func (builder *DataqueryBuilder) Format(format prometheus.PromQueryFormat) *DataqueryBuilder

Hide🔗

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

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

Instant🔗

Returns only the latest value that Prometheus has scraped for the requested time series

func (builder *DataqueryBuilder) Instant() *DataqueryBuilder

Interval🔗

An additional lower limit for the step parameter of the Prometheus query and for the

$__interval and $__rate_interval variables.

func (builder *DataqueryBuilder) Interval(interval string) *DataqueryBuilder

IntervalFactor🔗

@deprecated Used to specify how many times to divide max data points by. We use max data points under query options

See https://github.com/grafana/grafana/issues/48081

func (builder *DataqueryBuilder) IntervalFactor(intervalFactor float64) *DataqueryBuilder

LegendFormat🔗

Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname

func (builder *DataqueryBuilder) LegendFormat(legendFormat string) *DataqueryBuilder

QueryType🔗

Specify the query flavor

TODO make this required and give it a default

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

Range🔗

Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series

func (builder *DataqueryBuilder) Range() *DataqueryBuilder

RangeAndInstant🔗

func (builder *DataqueryBuilder) RangeAndInstant() *DataqueryBuilder

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.

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

See also🔗