You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by jb...@apache.org on 2019/11/27 16:27:23 UTC

[lucene-solr] branch visual-guide updated: Visual Guide: Add stats docs

This is an automated email from the ASF dual-hosted git repository.

jbernste pushed a commit to branch visual-guide
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/visual-guide by this push:
     new d31c550  Visual Guide: Add stats docs
d31c550 is described below

commit d31c5500ec87502f78b88832766a4c7023ce5237
Author: Joel Bernstein <jb...@apache.org>
AuthorDate: Wed Nov 27 11:25:45 2019 -0500

    Visual Guide: Add stats docs
---
 .../src/images/math-expressions/stats-table.png    | Bin 0 -> 111191 bytes
 .../src/images/math-expressions/stats.png          | Bin 0 -> 126246 bytes
 solr/solr-ref-guide/src/search-sample.adoc         |  23 ++++++++++++++++++++-
 3 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/solr/solr-ref-guide/src/images/math-expressions/stats-table.png b/solr/solr-ref-guide/src/images/math-expressions/stats-table.png
new file mode 100644
index 0000000..0caaee2
Binary files /dev/null and b/solr/solr-ref-guide/src/images/math-expressions/stats-table.png differ
diff --git a/solr/solr-ref-guide/src/images/math-expressions/stats.png b/solr/solr-ref-guide/src/images/math-expressions/stats.png
new file mode 100644
index 0000000..506a9c3
Binary files /dev/null and b/solr/solr-ref-guide/src/images/math-expressions/stats.png differ
diff --git a/solr/solr-ref-guide/src/search-sample.adoc b/solr/solr-ref-guide/src/search-sample.adoc
index 91bf65a..12ff007 100644
--- a/solr/solr-ref-guide/src/search-sample.adoc
+++ b/solr/solr-ref-guide/src/search-sample.adoc
@@ -22,7 +22,7 @@ visualization and statistical analysis: searching, sampling
 and aggregation.
 
 <<Searching, Searching>> - <<Sampling, Sampling>> - <<Aggregation, Aggregation>>
-- <<facet, facet>> - <<facet2D, facet2D>> - <<timeseries, timeseries>> -
+- <<stats, stats>> - <<facet, facet>> - <<facet2D, facet2D>> - <<timeseries, timeseries>> -
 <<significantTerms, significantTerms>> - <<nodes, nodes>>
 
 == Searching
@@ -135,6 +135,27 @@ Aggregations are a powerful statistical tool for summarizing large data sets and
 surfacing patterns, trends and correlations within the data. Aggregations are also a powerful
 tool for visualization and provide data sets for further statistical analysis.
 
+== stats
+
+The simplest aggregation is the `stats` function. The `stats` function calculates
+aggregations for an entire result set that matches a query. The `stats` function supports
+the following aggregation functions: count(*), sum, min, max and avg. Any number
+and combination of statistics can be calculated in a single function call.
+
+
+The `stats` function can be visualized
+in Zeppelin-Solr as a table. In the example below two statistics are calculated
+over a result set and are displayed in a table:
+
+image::images/math-expressions/stats-table.png[]
+
+The `stats` function can also be visualized using the *Number* visualization which is
+used to highlight important numbers. The example below shows the `count(*)` aggregation
+displayed in the Number visualization:
+
+image::images/math-expressions/stats.png[]
+
+
 === facet
 
 The `facet` function performs single and multi-dimension