grafana/schema-reference.md at 9c47161c14636b4ab5dead9f2294e79d606d16b9

mirror of https://github.com/grafana/grafana.git synced 2025-07-29 03:12:27 +08:00

Files

Agnès Toulet ac445a25d5 Kindsys: update generated doc and add check in CI (#71871 )

* clean up docs

* fix Windows path issue

* add verify-gen-cue to doc pipeline

* fix linting error

2023-07-20 11:48:12 +02:00

keywords

labels

title

grafana

schema

products

cloud

enterprise

oss

LokiDataQuery kind

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

LokiDataQuery

Property	Type	Required	Description
`expr`	string	Yes	The LogQL query.
`refId`	string	Yes	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.
`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
`editorMode`	string	No	Possible values are: `code`, `builder`.
`hide`	boolean	No	true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc)
`instant`	boolean	No	@deprecated, now use queryType.
`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	Specify the query flavor TODO make this required and give it a default
`range`	boolean	No	@deprecated, now use queryType.
`resolution`	integer	No	@deprecated, now use step.
`step`	string	No	Used to set step value for range queries.