opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 03:32:11 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
Ivana Huckova 20ec54f1f9 Elasticsearch: Use generated types in data source (#62753) 
* Use generated types in frontend

* Export missing MetricAggregationWithMeta

* Remove not needed changes

* Update

* Fix lint

* Update comments
2023-02-03 12:04:12 -05:00

7.0 KiB
Raw Blame History

keywords title
grafana
schema
ElasticsearchDataQuery kind

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

ElasticsearchDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Description
refId string Yes (Inherited from DataQuery)
A - Z
alias string No Alias pattern
bucketAggs BucketAggregation[] No List of bucket aggregations
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
metrics MetricAggregation[] No List of metric aggregations
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default
query string No Lucene query
timeField string No Name of time field

BucketAggregation

Property Type Required Description

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

MetricAggregation

Property Type Required Description