QueryBuilder🔗

Constructor🔗

func NewQueryBuilder() *QueryBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *QueryBuilder) Build() (dashboardv2beta1.DataQueryKind, error)

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.

func (builder *QueryBuilder) Datasource(datasource cog.Builder[dashboardv2beta1.Dashboardv2beta1DataQueryKindDatasource]) *QueryBuilder

EditorMode🔗

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

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

Exemplar🔗

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

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

Expr🔗

The actual expression/query that will be evaluated by Prometheus

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

Format🔗

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

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

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 *QueryBuilder) Hide(hide bool) *QueryBuilder

Instant🔗

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

func (builder *QueryBuilder) Instant() *QueryBuilder

Interval🔗

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

$__interval and $__rate_interval variables.

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

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 *QueryBuilder) IntervalFactor(intervalFactor float64) *QueryBuilder

LegendFormat🔗

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

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

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

func (builder *QueryBuilder) OldDatasource(datasource common.DataSourceRef) *QueryBuilder

QueryType🔗

Specify the query flavor

TODO make this required and give it a default

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

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 *QueryBuilder) Range() *QueryBuilder

RangeAndInstant🔗

func (builder *QueryBuilder) RangeAndInstant() *QueryBuilder

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 *QueryBuilder) RefId(refId string) *QueryBuilder

Version🔗

func (builder *QueryBuilder) Version(version string) *QueryBuilder