Query🔗

Constructor🔗

Query()

Methods🔗

build🔗

Builds the object.

def build() -> dashboardv2beta1.DataQueryKind

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.

def datasource(ref: cogbuilder.Builder[dashboardv2beta1.Dashboardv2beta1DataQueryKindDatasource]) -> typing.Self

direction🔗

def direction(direction: loki.LokiQueryDirection) -> typing.Self

editor_mode🔗

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

expr🔗

The LogQL query.

def expr(expr: str) -> 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🔗

@deprecated, now use queryType.

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

legend_format🔗

Used to override the name of the series.

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

max_lines🔗

Used to limit the number of log rows returned.

def max_lines(max_lines: int) -> typing.Self

old_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 old_datasource(datasource: common.DataSourceRef) -> 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🔗

@deprecated, now use queryType.

def range_val(range_val: bool) -> 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

resolution🔗

@deprecated, now use step.

def resolution(resolution: int) -> typing.Self

step🔗

Used to set step value for range queries.

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

version🔗

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