mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 01:02:26 +08:00
0fcc864bbb
* 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>
56 lines
7.1 KiB
Markdown
56 lines
7.1 KiB
Markdown
---
|
|
keywords:
|
|
- grafana
|
|
- schema
|
|
title: ElasticsearchDataQuery kind
|
|
---
|
|
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
|
|
|
## ElasticsearchDataQuery
|
|
|
|
#### Maturity: [experimental](../../../maturity/#experimental)
|
|
#### Version: 0.0
|
|
|
|
|
|
|
|
It extends [DataQuery](#dataquery).
|
|
|
|
| Property | Type | Required | Description |
|
|
|--------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>A - Z |
|
|
| `alias` | string | No | Alias pattern |
|
|
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | List of bucket aggregations |
|
|
| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*<br/>For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
|
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>true if query is disabled (ie should not be returned to the dashboard) |
|
|
| `key` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Unique, guid like, string used in explore mode |
|
|
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | List of metric aggregations |
|
|
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>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.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>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<br/>TODO make this required and give it a default |
|
|
|
|
### MetricAggregation
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|------|----------|-------------|
|
|
|
|
|