Dataquery🔗

Constructor🔗

Dataquery()

Methods🔗

build🔗

Builds the object.

def build() -> prometheus.Dataquery

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

def datasource(datasource: dashboard.DataSourceRef) -> typing.Self

editor_mode🔗

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

def editor_mode(editor_mode: prometheus.QueryEditorMode) -> typing.Self

exemplar🔗

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

def exemplar(exemplar: bool) -> typing.Self

expr🔗

The actual expression/query that will be evaluated by Prometheus

def expr(expr: str) -> typing.Self

format_val🔗

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

def format_val(format_val: prometheus.PromQueryFormat) -> typing.Self

hide🔗

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

def hide(hide: bool) -> typing.Self

instant🔗

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

def instant() -> typing.Self

interval🔗

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

$__interval and $__rate_interval variables.

def interval(interval: str) -> typing.Self

interval_factor🔗

@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

def interval_factor(interval_factor: float) -> typing.Self

legend_format🔗

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

def legend_format(legend_format: str) -> typing.Self

query_type🔗

Specify the query flavor

TODO make this required and give it a default

def query_type(query_type: str) -> typing.Self

range_val🔗

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

def range_val() -> typing.Self

range_and_instant🔗

def range_and_instant() -> typing.Self

ref_id🔗

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.

def ref_id(ref_id: str) -> typing.Self