root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 171 Packages Projects Releases Wiki Activity
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md

56 lines
7.0 KiB
Markdown
Raw Normal View History

Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
2023-02-02 16:01:02 +08:00
---
keywords:
- grafana
- schema
title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
## ElasticsearchDataQuery
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
2023-02-02 16:01:02 +08:00
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-04 01:04:12 +08:00
#### Maturity: experimental
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
#### Version: 0.0
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
2023-02-02 16:01:02 +08:00
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
It extends [DataQuery](#dataquery).
| Property | Type | Required | Description |
|--------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>A - Z |
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-04 01:04:12 +08:00
| `alias` | string | No | Alias pattern |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | List of bucket aggregations |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
| `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 &#124; 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 |
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-04 01:04:12 +08:00
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | List of metric aggregations |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
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-04 01:04:12 +08:00
| `query` | string | No | Lucene query |
| `timeField` | string | No | Name of time field |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### BucketAggregation
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
2023-02-02 16:01:02 +08:00
| Property | Type | Required | Description |
|----------|------|----------|-------------|
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### 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 &#124; 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
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
2023-02-02 16:01:02 +08:00
| Property | Type | Required | Description |
|----------|------|----------|-------------|