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

Adjust approx agg deprecation wording (#7518)

This commit is contained in:
Jonathan Wei 2019-04-19 19:31:50 -07:00 committed by Fangjin Yang
parent 5939fc28ea
commit 3487663de9
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/content/querying/aggregations.md
View File

@ -282,7 +282,9 @@ Compared to the Theta sketch, the HLL sketch does not support set operations and
#### Cardinality/HyperUnique (Deprecated) #### Cardinality/HyperUnique (Deprecated)
<div class="note caution"> <div class="note caution">
The Cardinality and HyperUnique aggregators are deprecated. Please use <a href="../development/extensions-core/datasketches-theta.html">DataSketches Theta Sketch</a> or <a href="../development/extensions-core/datasketches-hll.html">DataSketches HLL Sketch</a> instead. The Cardinality and HyperUnique aggregators are deprecated.
For new use cases, we recommend evaluating <a href="../development/extensions-core/datasketches-theta.html">DataSketches Theta Sketch</a> or <a href="../development/extensions-core/datasketches-hll.html">DataSketches HLL Sketch</a> instead.
For existing users, we recommend evaluating the newer DataSketches aggregators and migrating if possible.
</div> </div>
The [Cardinality and HyperUnique](../querying/hll-old.html) aggregators are older aggregator implementations available by default in Druid that also provide distinct count estimates using the HyperLogLog algorithm. The newer DataSketches Theta and HLL extension-provided aggregators described above have superior accuracy and performance and are recommended instead. The [Cardinality and HyperUnique](../querying/hll-old.html) aggregators are older aggregator implementations available by default in Druid that also provide distinct count estimates using the HyperLogLog algorithm. The newer DataSketches Theta and HLL extension-provided aggregators described above have superior accuracy and performance and are recommended instead.
@ -291,6 +293,8 @@ The DataSketches team has published a [comparison study](https://datasketches.gi
Please note that `hyperUnique` aggregators are not mutually compatible with Datasketches HLL or Theta sketches. Please note that `hyperUnique` aggregators are not mutually compatible with Datasketches HLL or Theta sketches.
Although deprecated, we will continue to support the older Cardinality/HyperUnique aggregators for backwards compatibility.
##### Multi-column handling ##### Multi-column handling
Note the DataSketches Theta and HLL aggregators currently only support single-column inputs. If you were previously using the Cardinality aggregator with multiple-column inputs, equivalent operations using Theta or HLL sketches are described below: Note the DataSketches Theta and HLL aggregators currently only support single-column inputs. If you were previously using the Cardinality aggregator with multiple-column inputs, equivalent operations using Theta or HLL sketches are described below:
@ -324,6 +328,11 @@ We do not recommend the fixed buckets histogram for general use, as its usefulne
#### Approximate Histogram (Deprecated) #### Approximate Histogram (Deprecated)
<div class="note caution">
The Approximate Histogram aggregator is deprecated.
We recommend using <a href="../development/extensions-core/datasketches-quantiles.html">DataSketches Quantiles</a> instead.
</div>
The [Approximate Histogram](../development/extensions-core/approximate-histograms.html) extension-provided aggregator also provides quantile estimates and histogram approximations, based on [http://jmlr.org/papers/volume11/ben-haim10a/ben-haim10a.pdf](http://jmlr.org/papers/volume11/ben-haim10a/ben-haim10a.pdf). The [Approximate Histogram](../development/extensions-core/approximate-histograms.html) extension-provided aggregator also provides quantile estimates and histogram approximations, based on [http://jmlr.org/papers/volume11/ben-haim10a/ben-haim10a.pdf](http://jmlr.org/papers/volume11/ben-haim10a/ben-haim10a.pdf).
The algorithm used by this deprecated aggregator is highly distribution-dependent and its output is subject to serious distortions when the input does not fit within the algorithm's limitations. The algorithm used by this deprecated aggregator is highly distribution-dependent and its output is subject to serious distortions when the input does not fit within the algorithm's limitations.
@ -335,7 +344,7 @@ A [study published by the DataSketches team](https://datasketches.github.io/docs
It is not possible to determine a priori how well this aggregator will behave for a given input stream, nor does the aggregator provide any indication that serious distortions are present in the output. It is not possible to determine a priori how well this aggregator will behave for a given input stream, nor does the aggregator provide any indication that serious distortions are present in the output.
For these reasons, we have deprecated this aggregator and do not recommend its use. For these reasons, we have deprecated this aggregator and recommend using the DataSketches Quantiles aggregator instead for new and existing use cases, although we will continue to support Approximate Histogram for backwards compatibility.
## Miscellaneous Aggregations ## Miscellaneous Aggregations