Files
2023-02-07 11:39:22 +00:00

5.5 KiB

keywords title
grafana
schema
ParcaDataQuery kind

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

ParcaDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Description
labelSelector string Yes Specifies the query label selectors. Default: {}.
profileTypeId string Yes Specifies the type of profile to 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
hide boolean No (Inherited from DataQuery)
true if query is disabled (ie should not be returned to the dashboard)
key string No (Inherited from DataQuery)
Unique, guid like, string used in explore mode
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default

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