Files
grafana/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
T
48a374f50b loki: implement schema for loki query (#62114)
* loki: implement schema for loki query

* removed forgotten code

* better types

* adjust cue-maturity-level

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

* sync docs to schema change

* removed forgotten go code

* updated schema docs

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* updated schema docs

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* update schema docs

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* update schema docs

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* updated schema docs

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* updated schema docs

* add documentation to the resolution field

* move direction-field to schema

* loki: cue: moved deprecated fields to the bottom

---------

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
2023-02-02 16:18:30 +00:00

7.1 KiB

keywords, title
keywords title
grafana
schema
LokiDataQuery kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

LokiDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Description
expr string Yes The LogQL query.
refId string Yes (Inherited from DataQuery)
A - Z
datasource No (Inherited from DataQuery)
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
editorMode string No Possible values are: code, builder.
hide boolean No (Inherited from DataQuery)
true if query is disabled (ie should not be returned to the dashboard)
instant boolean No @deprecated, now use queryType.
key string No (Inherited from DataQuery)
Unique, guid like, string used in explore mode
legendFormat string No Used to override the name of the series.
maxLines integer No Used to limit the number of log rows returned.
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default
range boolean No @deprecated, now use queryType.
resolution integer No Used to scale the interval value.

DataQuery

These are the common properties available to all queries in all datasources. Specific implementations will extend this interface, adding the required properties for the given context.

Property Type Required Description
refId string Yes A - Z
datasource No 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
hide boolean No true if query is disabled (ie should not be returned to the dashboard)
key string No Unique, guid like, string used in explore mode
queryType string No Specify the query flavor
TODO make this required and give it a default