opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 03:52:31 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
Robert Horvath 0fcc864bbb Docs: Add Schema maturity docs (#61963) 
* Docs: Add Schema maturity docs

* Remove 'which category' section from maturity.md

Co-authored-by: sam boyer <sdboyer@grafana.com>

* Remove Maturity process guides from maturity.md

Co-authored-by: sam boyer <sdboyer@grafana.com>

* Remove Defaults and Field optionality from maturity.md

Co-authored-by: sam boyer <sdboyer@grafana.com>

* Remove MaybeRemove section from maturity.md

Co-authored-by: sam boyer <sdboyer@grafana.com>

* Remove Milestone 3 and 4 from maturity.md

Co-authored-by: sam boyer <sdboyer@grafana.com>

* Rearrange schema maturity docs

* Regenerate schema docs after merge with main

* Update Maturity docs headers, keep single h1

* Update wording in Schema docs

Co-authored-by: Tania <yalyna.ts@gmail.com>

* Regenerate docs after merge with main

---------

Co-authored-by: sam boyer <sdboyer@grafana.com>
Co-authored-by: Tania <yalyna.ts@gmail.com>
2023-02-07 11:02:05 +01:00

7.1 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