Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve doc of movingAverage (#11262) 

* Make doc more directive

Signed-off-by: frank chen <frank.chen021@outlook.com>

* Add limitation

Signed-off-by: frank chen <frank.chen021@outlook.com>

* Suppress spelling check error
This commit is contained in:
frank chen 2021-05-28 13:10:55 +08:00 committed by GitHub
parent 04fefb0ca3
commit e664bfd433
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/development/extensions-contrib/moving-average-query.md
View File

@ -50,12 +50,28 @@ It runs the query in two main phases:
## Operations
To use this extension, make sure to [load](../../development/extensions.md#loading-extensions) `druid-moving-average-query` only to the Broker.
### Installation
Use [pull-deps](../../operations/pull-deps.md) tool shipped with Druid to install this [extension](../../development/extensions.md#community-extensions) on all Druid broker nodes.
```bash
java -classpath "<your_druid_dir>/lib/*" org.apache.druid.cli.Main tools pull-deps -c org.apache.druid.extensions.contrib:druid-moving-average-query:{VERSION}
```
### Enabling
After installation, to enable this extension, just add `druid-moving-average-query` to `druid.extensions.loadList` in brokers' `runtime.properties` file and then restart broker nodes.
For example:
```bash
druid.extensions.loadList=["druid-moving-average-query"]
```
## Configuration
There are currently no configuration properties specific to Moving Average.
## Limitations
* movingAverage is not supported by Druid router(including the Web Console), all queries should be sent to broker nodes directly.
* movingAverage is missing support for the following groupBy properties: `subtotalsSpec`, `virtualColumns`.
* movingAverage is missing support for the following timeseries properties: `descending`.
* movingAverage is missing support for [SQL-compatible null handling](https://github.com/apache/druid/issues/4349) (So setting druid.generic.useDefaultValueForNull in configuration will give an error).

1
website/.spelling
View File

@ -584,6 +584,7 @@ longSum
movingAverage
postAggregations
postAveragers
pull-deps
- ../docs/development/extensions-contrib/opentsdb-emitter.md
defaultMetrics.json
namespacePrefix