You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2021/01/28 16:33:32 UTC
svn commit: r1070647 [29/35] - in
/websites/production/lucene/content/solr/guide/8_8: ./
images/math-expressions/ meta-docs/
Modified: websites/production/lucene/content/solr/guide/8_8/stream-api.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/stream-api.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/stream-api.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Stream Request Handler API | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Stream Request Handler API | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="stream-api">
+<body class="" id="stream-api">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1824,7 +1844,7 @@ and the states are those of a Thread.</p
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/stream-decorator-reference.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/stream-decorator-reference.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/stream-decorator-reference.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Stream Decorator Reference | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Stream Decorator Reference | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="stream-decorator-reference">
+<body class="" id="stream-decorator-reference">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -2113,16 +2133,16 @@ complement(
</div></section></section>
<section class="sect1"><h2 id="eval">eval</h2><p>The <code>eval</code> function allows for use cases where new streaming expressions are generated on the fly and then evaluated.
The <code>eval</code> function wraps a streaming expression and reads a single tuple from the underlying stream.
-The <code>eval</code> function then retrieves a string Streaming Expressions from the <code>expr_s</code> field of the tuple.
-The <code>eval</code> function then compiles the string Streaming Expression and emits the tuples.</p>
+The <code>eval</code> function then retrieves a string streaming expression from the <code>expr_s</code> field of the tuple.
+The <code>eval</code> function then compiles the string streaming expression and emits the tuples.</p>
<section class="sect2"><h3 id="eval-parameters">eval Parameters</h3><div class="ulist"><ul><li><p><code>StreamExpression</code>: (Mandatory) The stream which provides the streaming expression to be evaluated.</p></li></ul></div></section>
<section class="sect2"><h3 id="eval-syntax">eval Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>eval(expr)</code></pre></code></pre></div>
<p>In the example above the <code>eval</code> expression reads the first tuple from the underlying expression. It then compiles and
-executes the string Streaming Expression in the expr_s field.</p></section></section>
+executes the string streaming expression in the <code>expr_s</code> field.</p></section></section>
<section class="sect1"><h2 id="executor">executor</h2><p>The <code>executor</code> function wraps a stream source that contains streaming expressions, and executes the expressions in parallel. The <code>executor</code> function looks for the expression in the <code>expr_s</code> field in each tuple. The <code>executor</code> function has an internal thread pool that runs tasks that compile and run expressions in parallel on the same worker node. This function can also be parallelized across worker nodes by wrapping it in the <a href="#parallel"><code>parallel</code></a> function to provide parallel execution of expressions across a cluster.</p>
<p>The <code>executor</code> function does not do anything specific with the output of the expressions that it runs. Therefore the expressions that are executed must contain the logic for pushing tuples to their destination. The <a href="#update">update function</a> can be included in the expression being executed to send the tuples to a SolrCloud collection for storage.</p>
<p>This model allows for asynchronous execution of jobs where the output is stored in a SolrCloud collection where it can be accessed as the job progresses.</p>
-<section class="sect2"><h3 id="executor-parameters">executor Parameters</h3><div class="ulist"><ul><li><p><code>threads</code>: (Optional) The number of threads in the executors thread pool for executing expressions.</p></li><li><p><code>StreamExpression</code>: (Mandatory) The stream source which contains the Streaming Expressions to execute.</p></li></ul></div></section>
+<section class="sect2"><h3 id="executor-parameters">executor Parameters</h3><div class="ulist"><ul><li><p><code>threads</code>: (Optional) The number of threads in the executors thread pool for executing expressions.</p></li><li><p><code>StreamExpression</code>: (Mandatory) The stream source which contains the streaming expressions to execute.</p></li></ul></div></section>
<section class="sect2"><h3 id="executor-syntax">executor Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>daemon(id="myDaemon",
terminate="true",
executor(threads=10,
@@ -2516,7 +2536,7 @@ select(
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/stream-evaluator-reference.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/stream-evaluator-reference.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/stream-evaluator-reference.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Stream Evaluator Reference | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Stream Evaluator Reference | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="stream-evaluator-reference">
+<body class="" id="stream-evaluator-reference">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1869,7 +1889,7 @@ if(gt(fieldA,fieldB),cbrt(fieldA),cbrt(f
<div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>ceil(100.4) // returns 101.
ceil(fieldA) // returns the next highest whole number for fieldA.
if(gt(fieldA,fieldB),ceil(fieldA),ceil(fieldB)) // if fieldA > fieldB then return the ceil of fieldA, else return the ceil of fieldB.</code></pre></code></pre></div></section></section>
-<section class="sect1"><h2 id="col">col</h2><p>The <code>col</code> function returns a numeric array from a list of Tuples. The <code>col</code>
+<section class="sect1"><h2 id="col">col</h2><p>The <code>col</code> function returns a numeric array from a list of tuples. The <code>col</code>
function is used to create numeric arrays from stream sources.</p>
<section class="sect2"><h3 id="col-parameters">col Parameters</h3><div class="ulist"><ul><li><p><code>list of Tuples</code></p></li><li><p><code>field name</code>: The field to create the array from.</p></li></ul></div></section>
<section class="sect2"><h3 id="col-syntax">col Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>col(tupleList, fieldName)</code></pre></code></pre></div></section></section>
@@ -2075,10 +2095,10 @@ set by any function that returns a matri
<section class="sect2"><h3 id="getrowlabels-parameters">getRowLabels Parameters</h3><div class="ulist"><ul><li><p><code>matrix</code>: The matrix to return the row labels from.</p></li></ul></div></section>
<section class="sect2"><h3 id="getrowlabels-syntax">getRowLabels Syntax</h3><p>getRowLabels(matrix)</p></section>
<section class="sect2"><h3 id="getrowlabels-returns">getRowLabels Returns</h3><p>string array: The labels for each row in the matrix</p></section></section>
-<section class="sect1"><h2 id="getvalue">getValue</h2><p>The <code>getValue</code> function returns the value of a single Tuple entry by key.</p>
-<section class="sect2"><h3 id="getvalue-parameters">getValue Parameters</h3><div class="ulist"><ul><li><p><code>tuple</code>: The Tuple to return the entry from.</p></li><li><p><code>key</code>: The key of the entry to return the value for.</p></li></ul></div></section>
+<section class="sect1"><h2 id="getvalue">getValue</h2><p>The <code>getValue</code> function returns the value of a single tuple entry by key.</p>
+<section class="sect2"><h3 id="getvalue-parameters">getValue Parameters</h3><div class="ulist"><ul><li><p><code>tuple</code>: The tuple to return the entry from.</p></li><li><p><code>key</code>: The key of the entry to return the value for.</p></li></ul></div></section>
<section class="sect2"><h3 id="getvalue-syntax">getValue Syntax</h3><p>getValue(tuple, key)</p></section>
-<section class="sect2"><h3 id="getvalue-returns">getValue Returns</h3><p>object: Returns an object of the same type as the Tuple entry.</p></section></section>
+<section class="sect2"><h3 id="getvalue-returns">getValue Returns</h3><p>object: Returns an object of the same type as the tuple entry.</p></section></section>
<section class="sect1"><h2 id="grandsum">grandSum</h2><p>The <code>grandSum</code> function sums all the values in a matrix.</p>
<section class="sect2"><h3 id="grandsum-parameters">grandSum Parameters</h3><div class="ulist"><ul><li><p><code>matrix</code>: The matrix to operate on.</p></li></ul></div></section>
<section class="sect2"><h3 id="grandsum-syntax">grandSum Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>grandSum(matrix)</code></pre></code></pre></div></section>
@@ -2249,7 +2269,7 @@ normalizeSum(matrix)</code></pre></code>
not(fieldA) // true if fieldA is false else false
not(eq(fieldA,fieldB)) // true if fieldA != fieldB</code></pre></code></pre></div></section></section>
<section class="sect1"><h2 id="olsregress">olsRegress</h2><p>The <code>olsRegress</code> function performs <a href="https://en.wikipedia.org/wiki/Ordinary_least_squares">ordinary least squares</a>, multivariate, linear regression.</p>
-<p>The <code>olsRegress</code> function returns a single Tuple containing the regression model with estimated regression parameters, RSquared and regression diagnostics.</p>
+<p>The <code>olsRegress</code> function returns a single tuple containing the regression model with estimated regression parameters, RSquared and regression diagnostics.</p>
<p>The output of <code>olsRegress</code> can be used with the <a href="#predict">predict</a> function to predict values based on the regression model.</p>
<section class="sect2"><h3 id="olsregress-parameters">olsRegress Parameters</h3><div class="ulist"><ul><li><p><code>matrix</code>: The regressor observation matrix. Each row in the matrix represents a single multi-variate regressor observation. Note that there is no need to add an initial unitary column (column of 1’s) when specifying a model including an intercept term, this column will be added automatically.</p></li><li><p><code>numeric array</code>: The outcomes array which matches up with each row in the regressor observation matrix.</p></li></ul></div></section>
<section class="sect2"><h3 id="olsregress-syntax">olsRegress Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>olsRegress(matrix, numericArray) // This performs the olsRegression analysis on given regressor matrix and outcome array.</code></pre></code></pre></div></section>
@@ -2402,8 +2422,8 @@ scalarSubtract(number, matrix) // Subtra
<section class="sect2"><h3 id="setrowlabels-parameters">setRowLabels Parameters</h3><div class="ulist"><ul><li><p><code>matrix</code>: The matrix to set the row labels to.</p></li><li><p><code>string array</code>: The row labels to set to the matrix</p></li></ul></div></section>
<section class="sect2"><h3 id="setrowlabels-syntax">setRowLabels Syntax</h3><p>setRowLabels(matrix, labels)</p></section>
<section class="sect2"><h3 id="setrowlabels-returns">setRowLabels Returns</h3><p>matrix: The matrix with the labels set.</p></section></section>
-<section class="sect1"><h2 id="setvalue">setValue</h2><p>The <code>setValue</code> function sets a new value for a Tuple entry.</p>
-<section class="sect2"><h3 id="setvalue-parameters">setValue Parameters</h3><div class="ulist"><ul><li><p><code>tuple</code>: The Tuple to return the entry from.</p></li><li><p><code>key</code>: The key of the entry to set.</p></li><li><p><code>value</code>: The value to set.</p></li></ul></div></section>
+<section class="sect1"><h2 id="setvalue">setValue</h2><p>The <code>setValue</code> function sets a new value for a tuple entry.</p>
+<section class="sect2"><h3 id="setvalue-parameters">setValue Parameters</h3><div class="ulist"><ul><li><p><code>tuple</code>: The tuple to return the entry from.</p></li><li><p><code>key</code>: The key of the entry to set.</p></li><li><p><code>value</code>: The value to set.</p></li></ul></div></section>
<section class="sect2"><h3 id="setvalue-syntax">setValue Syntax</h3><p>setValue(tuple, key, value)</p></section>
<section class="sect2"><h3 id="setvalue-returns">setValue Returns</h3><p>tuple: Returns the new modified tuple</p></section></section>
<section class="sect1"><h2 id="sin">sin</h2><p>The <code>sin</code> function returns the trigonometric sine of a number.</p>
@@ -2513,7 +2533,7 @@ probability distribution framework and i
<a class="btn btn-primary prev float-left" href="stream-decorator-reference.html">Stream Decorator Reference</a>
- <a class="btn btn-primary next float-right" href="math-expressions.html">Math Expressions</a>
+ <a class="btn btn-primary next float-right" href="math-expressions.html">Streaming Expressions and Math Expressions</a>
</div>
</nav>
@@ -2525,7 +2545,7 @@ probability distribution framework and i
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/stream-screen.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/stream-screen.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/stream-screen.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Stream Screen | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Stream Screen | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="stream-screen">
+<body class="" id="stream-screen">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1692,7 +1712,7 @@
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/stream-source-reference.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/stream-source-reference.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/stream-source-reference.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Stream Source Reference | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Stream Source Reference | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="stream-source-reference">
+<body class="" id="stream-source-reference">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1709,11 +1729,11 @@ jdbc(
driver="org.hsqldb.jdbcDriver",
get_column_name="false"
)</code></pre></code></pre></div></section></section>
-<section class="sect1"><h2 id="drill">drill</h2><p>The <code>drill</code> function is designed to support efficient high cardinality aggregation. The <code>drill</code>
-function sends a request to the <code>export</code> handler in a specific collection which includes a Streaming
-Expression that the <code>export</code> handler applies to the sorted result set. The <code>export</code> handler then emits the aggregated tuples.
-The <code>drill</code> function reads and emits the aggregated tuples fromn each shard maintaining the sort order,
-but does not merge the aggregations. Streaming Expression functions can be wrapped around the <code>drill</code> function to
+<section class="sect1"><h2 id="drill">drill</h2><p>The <code>drill</code> function is designed to support efficient high cardinality aggregation.
+The <code>drill</code> function sends a request to the <code>export</code> handler in a specific collection which includes a streaming expression that the <code>export</code> handler applies to the sorted result set.
+The <code>export</code> handler then emits the aggregated tuples.
+The <code>drill</code> function reads and emits the aggregated tuples from each shard maintaining the sort order, but does not merge the aggregations.
+Streaming expression functions can be wrapped around the <code>drill</code> function to
merge the aggregates.</p>
<section class="sect2"><h3 id="drill-parameters">drill Parameters</h3><div class="ulist"><ul><li><p><code>collection</code>: (Mandatory) the collection being searched.</p></li><li><p><code>q</code>: (Mandatory) The query to perform on the Solr index.</p></li><li><p><code>fl</code>: (Mandatory) The list of fields to return.</p></li><li><p><code>sort</code>: (Mandatory) The sort criteria.</p></li><li><p><code>expr</code>: The streaming expression that is sent to the export handler that operates over the sorted
result set. The <code>input()</code> function provides the stream of sorted tuples from the export handler (see examples below).</p></li></ul></div></section>
@@ -1731,8 +1751,8 @@ result set. The <code>input()</code> fun
rollup(input(), over="author", count(*))),
over="author",
sum(count(*)))</code></pre></code></pre></div></section></section>
-<section class="sect1"><h2 id="echo">echo</h2><p>The <code>echo</code> function returns a single Tuple echoing its text parameter. <code>Echo</code> is the simplest stream source designed to provide text
-to a text analyzing stream decorator.</p>
+<section class="sect1"><h2 id="echo">echo</h2><p>The <code>echo</code> function returns a single tuple echoing its text parameter.
+<code>Echo</code> is the simplest stream source designed to provide text to a text analyzing stream decorator.</p>
<section class="sect2"><h3 id="echo-syntax">echo Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>echo("Hello world")</code></pre></code></pre></div></section></section>
<section class="sect1"><h2 id="facet">facet</h2><p>The <code>facet</code> function provides aggregations that are rolled up over buckets. Under the covers the facet function pushes down the aggregation into the search engine using Solr’s JSON Facet API. This provides sub-second performance for many use cases. The facet function is appropriate for use with a low to moderate number of distinct values in the bucket fields. To support high cardinality aggregations see the rollup function.</p>
<section class="sect2"><h3 id="facet-parameters">facet Parameters</h3><div class="ulist"><ul><li><p><code>collection</code>: (Mandatory) Collection the facets will be aggregated from.</p></li><li><p><code>q</code>: (Mandatory) The query to build the aggregations from.</p></li><li><p><code>buckets</code>: (Mandatory) Comma separated list of fields to rollup over. The comma separated list represents the dimensions in a multi-dimensional rollup.</p></li><li><p><code>bucketSorts</code>: (Mandatory) Comma separated list of sorts to apply to each dimension in the buckets parameters. Sorts can be on the computed metrics or on the bucket values.</p></li><li><p><code>rows</code>: (Default 10) The number of rows to return. '-1' will return all rows.</p></li><li><p><code>offset</code>:(Default 0) The offset in the result set to start from.</p></li><li><p><code>overfetch</code>: (Default 150) Over-fetching is used to provide accurate aggregations over high cardinality fields.</p></li><li><p><co
de>method</code>: The JSON facet API aggregation method.</p></li><li><p><code>bucketSizeLimit</code>: Sets the absolute number of rows to fetch. This is incompatible with rows, offset and overfetch. This value is applied to each dimension. '-1' will fetch all the buckets.</p></li><li><p><code>metrics</code>: List of metrics to compute for the buckets. Currently supported metrics are <code>sum(col)</code>, <code>avg(col)</code>, <code>min(col)</code>, <code>max(col)</code>, <code>count(*)</code>, <code>per(col, 50)</code>. The <code>per</code> metric calculates a percentile
@@ -1916,10 +1936,12 @@ for a numeric column and can be specifie
id="uniqueId",
q="topic query",
fl="id, name, country")</code></pre></code></pre></div></section></section>
-<section class="sect1"><h2 id="tuple">tuple</h2><p>The <code>tuple</code> function emits a single Tuple with name/value pairs. The values can be set to variables assigned in a <code>let</code> expression, literals, Stream Evaluators or
-Stream Expressions. In the case of Stream Evaluators the tuple will output the return value from the evaluator.
-This could be a numeric, list or map. If a value is set to a Stream Expression, the <code>tuple</code> function will flatten
-the tuple stream from the Stream Expression into a list of Tuples.</p>
+<section class="sect1"><h2 id="tuple">tuple</h2><p>The <code>tuple</code> function emits a single tuple with name/value pairs.
+The values can be set to variables assigned in a <code>let</code> expression, literals, stream evaluators or stream expressions.
+In the case of stream evaluators the tuple will output the return value from the evaluator.
+This could be a numeric, list, or map.
+If a value is set to a stream expression, the <code>tuple</code> function will flatten
+the tuple stream from the stream expression into a list of tuples.</p>
<section class="sect2"><h3 id="tuple-parameters">tuple Parameters</h3><div class="ulist"><ul><li><p>name=value pairs</p></li></ul></div></section>
<section class="sect2"><h3 id="tuple-syntax">tuple Syntax</h3><div class="listingblock"><pre class="rouge highlight"><code class="language-text" data-lang="text"><pre class="highlight"><code>tuple(a=add(1,1),
b=search(collection1, q="cat:a", fl="a, b, c", sort="a desc"))</code></pre></code></pre></div></section></section>
@@ -1952,7 +1974,7 @@ the tuple stream from the Stream Express
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/streaming-expressions.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/streaming-expressions.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/streaming-expressions.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Streaming Expressions | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Streaming Expressions | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="streaming-expressions">
+<body class="" id="streaming-expressions">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1657,16 +1677,14 @@
<li><a href="#stream-language-basics">Stream Language Basics</a>
<ul class="sectlevel2">
<li><a href="#streaming-requests-and-responses">Streaming Requests and Responses</a></li>
-<li><a href="#data-requirements">Data Requirements</a></li>
-<li><a href="#request-routing">Request Routing</a></li>
-<li><a href="#adding-custom-expressions">Adding Custom Expressions</a></li>
</ul>
</li>
-<li><a href="#types-of-streaming-expressions">Types of Streaming Expressions</a>
+<li><a href="#elements-of-the-lanaguage">Elements of the Lanaguage</a>
<ul class="sectlevel2">
-<li><a href="#about-stream-sources">About Stream Sources</a></li>
-<li><a href="#about-stream-decorators">About Stream Decorators</a></li>
-<li><a href="#about-stream-evaluators">About Stream Evaluators</a></li>
+<li><a href="#stream-sources">Stream Sources</a></li>
+<li><a href="#stream-decorators">Stream Decorators</a></li>
+<li><a href="#math-expressions">Math Expressions</a></li>
+<li><a href="#visualization">Visualization</a></li>
</ul>
</li>
</ul>
@@ -1674,33 +1692,21 @@
<section class="content">
- <section id="preamble" aria-label="Preamble"><p>Streaming Expressions provide a simple yet powerful stream processing language for SolrCloud.</p>
-<p>Streaming expressions are a suite of functions that can be combined to perform many different parallel computing tasks. These functions are the basis for the <a href="parallel-sql-interface.html#parallel-sql-interface">Parallel SQL Interface</a>.</p>
-<p>There is a growing library of functions that can be combined to implement:</p>
-<div class="ulist"><ul><li><p>Request/response stream processing</p></li><li><p>Batch stream processing</p></li><li><p>Fast interactive MapReduce</p></li><li><p>Aggregations (Both pushed down faceted and shuffling MapReduce)</p></li><li><p>Parallel relational algebra (distributed joins, intersections, unions, complements)</p></li><li><p>Publish/subscribe messaging</p></li><li><p>Distributed graph traversal</p></li><li><p>Machine learning and parallel iterative model training</p></li><li><p>Anomaly detection</p></li><li><p>Recommendation systems</p></li><li><p>Retrieve and rank services</p></li><li><p>Text classification and feature extraction</p></li><li><p>Streaming NLP</p></li><li><p>Statistical Programming</p></li></ul></div>
-<p>Streams from outside systems can be joined with streams originating from Solr and users can add their own stream functions by following Solr’s <a href="https://lucene.apache.org/solr/8_8_0//solr-solrj/org/apache/solr/client/solrj/io/stream/package-summary.html">Java streaming API</a>.</p>
-<div class="admonitionblock important">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-important" title="Important"></i>
-</td>
-<td class="content">
-<p>Both streaming expressions and the streaming API are considered experimental, and the APIs are subject to change.</p>
-</td>
-</tr>
-</table>
-</div></section>
-<section class="sect1"><h2 id="stream-language-basics">Stream Language Basics</h2><p>Streaming Expressions are comprised of streaming functions which work with a Solr collection. They emit a stream of tuples (key/value Maps).</p>
-<p>Many of the provided streaming functions are designed to work with entire result sets rather than the top N results like normal search. This is supported by the <a href="exporting-result-sets.html#exporting-result-sets">/export handler</a>.</p>
+ <section id="preamble" aria-label="Preamble"><p>Streaming expressions exposes the capabilities of SolrCloud as composable functions.
+These functions provide a system for searching, transforming, analyzing, and visualizing data stored in SolrCloud collections.</p>
+<p>At a high level there a four main capabilities that will be explored in the documentation:</p>
+<div class="ulist"><ul><li><p><strong>Searching</strong>, sampling and aggregating results from Solr.</p></li><li><p><strong>Transforming</strong> result sets after they are retrieved from Solr.</p></li><li><p><strong>Analyzing</strong> and modeling result sets using probability and statistics and machine learning libraries.</p></li><li><p><strong>Visualizing</strong> result sets, aggregations and statistical models of the data.</p></li></ul></div></section>
+<section class="sect1"><h2 id="stream-language-basics">Stream Language Basics</h2><p>Streaming expressions are comprised of streaming functions which work with a Solr collection.
+They emit a stream of tuples (key/value Maps).</p>
+<p>Some of the provided streaming functions are designed to work with entire result sets rather than the top N results like normal search.
+This is supported by the <a href="exporting-result-sets.html#exporting-result-sets">/export handler</a>.</p>
<p>Some streaming functions act as stream sources to originate the stream flow. Other streaming functions act as stream decorators to wrap other stream functions and perform operations on the stream of tuples. Many streams functions can be parallelized across a worker collection. This can be particularly powerful for relational algebra functions.</p>
<section class="sect2"><h3 id="streaming-requests-and-responses">Streaming Requests and Responses</h3><p>Solr has a <code>/stream</code> request handler that takes streaming expression requests and returns the tuples as a JSON stream. This request handler is implicitly defined, meaning there is nothing that has to be defined in <code>solrconfig.xml</code> - see <a href="implicit-requesthandlers.html#implicit-requesthandlers">Implicit RequestHandlers</a>.</p>
<p>The <code>/stream</code> request handler takes one parameter, <code>expr</code>, which is used to specify the streaming expression. For example, this curl command encodes and POSTs a simple <code>search()</code> expression to the <code>/stream</code> handler:</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>curl --data-urlencode <span style="color: #d14">'expr=search(enron_emails,
q="from:1800flowers*",
fl="from, to",
- sort="from asc",
- qt="/export")'</span> http://localhost:8983/solr/enron_emails/stream</code></pre></code></pre></div>
+ sort="from asc")'</span> http://localhost:8983/solr/enron_emails/stream</code></pre></code></pre></div>
<p>Details of the parameters for each function are included below.</p>
<p>For the above example the <code>/stream</code> handler responded with the following JSON response:</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-json" data-lang="json"><pre class="highlight"><code><span style="background-color: #f8f8f8">{</span><span style="color: #000080">"result-set"</span><span style="background-color: #f8f8f8">:{</span><span style="color: #000080">"docs"</span><span style="background-color: #f8f8f8">:[</span><span style="color: #bbbbbb">
@@ -1720,34 +1726,23 @@
</span><span style="background-color: #f8f8f8">{</span><span style="color: #000080">"from"</span><span style="background-color: #f8f8f8">:</span><span style="color: #d14">"1800flowers@shop2u.com"</span><span style="background-color: #f8f8f8">,</span><span style="color: #000080">"to"</span><span style="background-color: #f8f8f8">:</span><span style="color: #d14">"ebass@enron.com"</span><span style="background-color: #f8f8f8">},</span><span style="color: #bbbbbb">
</span><span style="background-color: #f8f8f8">{</span><span style="color: #000080">"EOF"</span><span style="background-color: #f8f8f8">:</span><span style="color: #000000;font-weight: bold">true</span><span style="background-color: #f8f8f8">,</span><span style="color: #000080">"RESPONSE_TIME"</span><span style="background-color: #f8f8f8">:</span><span style="color: #009999">33</span><span style="background-color: #f8f8f8">}]}</span><span style="color: #bbbbbb">
</span><span style="background-color: #f8f8f8">}</span></code></pre></code></pre></div>
-<p>Note the last tuple in the above example stream is <code>{"EOF":true,"RESPONSE_TIME":33}</code>. The <code>EOF</code> indicates the end of the stream. To process the JSON response, you’ll need to use a streaming JSON implementation because streaming expressions are designed to return the entire result set which may have millions of records. In your JSON client you’ll need to iterate each doc (tuple) and check for the EOF tuple to determine the end of stream.</p>
-<p>The <a href="https://lucene.apache.org/solr/8_8_0//solr-solrj/org/apache/solr/client/solrj/io/package-summary.html"><code>org.apache.solr.client.solrj.io</code></a> package provides Java classes that compile streaming expressions into streaming API objects. These classes can be used to execute streaming expressions from inside a Java application. For example:</p>
-<div class="listingblock"><pre class="rouge highlight"><code class="language-java" data-lang="java"><pre class="highlight"><code> <span style="background-color: #f8f8f8">StreamFactory</span> <span style="background-color: #f8f8f8">streamFactory</span> <span style="color: #000000;font-weight: bold">=</span> <span style="color: #000000;font-weight: bold">new</span> <span style="background-color: #f8f8f8">DefaultStreamFactory</span><span style="color: #000000;font-weight: bold">().</span><span style="color: #008080">withCollectionZkHost</span><span style="color: #000000;font-weight: bold">(</span><span style="color: #d14">"collection1"</span><span style="color: #000000;font-weight: bold">,</span> <span style="background-color: #f8f8f8">zkServer</span><span style="color: #000000;font-weight: bold">.</span><span style="color: #008080">getZkAddress</span><span style="color: #000000;font-weight: bold">());</span>
- <span style="background-color: #f8f8f8">InjectionDefense</span> <span style="background-color: #f8f8f8">defense</span> <span style="color: #000000;font-weight: bold">=</span> <span style="color: #000000;font-weight: bold">new</span> <span style="background-color: #f8f8f8">InjectionDefense</span><span style="color: #000000;font-weight: bold">(</span><span style="color: #d14">"parallel(collection1, group(search(collection1, q=\"*:*\", fl=\"id,a_s,a_i,a_f\", sort=\"a_s asc,a_f asc\", partitionKeys=\"a_s\"), by=\"a_s asc\"), workers=\"2\", zkHost=\"?$?\", sort=\"a_s asc\")"</span><span style="color: #000000;font-weight: bold">);</span>
- <span style="background-color: #f8f8f8">defense</span><span style="color: #000000;font-weight: bold">.</span><span style="color: #008080">addParameter</span><span style="color: #000000;font-weight: bold">(</span><span style="background-color: #f8f8f8">zkhost</span><span style="color: #000000;font-weight: bold">);</span>
- <span style="background-color: #f8f8f8">ParallelStream</span> <span style="background-color: #f8f8f8">pstream</span> <span style="color: #000000;font-weight: bold">=</span> <span style="color: #000000;font-weight: bold">(</span><span style="background-color: #f8f8f8">ParallelStream</span><span style="color: #000000;font-weight: bold">)</span><span style="background-color: #f8f8f8">streamFactory</span><span style="color: #000000;font-weight: bold">.</span><span style="color: #008080">constructStream</span><span style="color: #000000;font-weight: bold">(</span><span style="background-color: #f8f8f8">defense</span><span style="color: #000000;font-weight: bold">.</span><span style="color: #008080">safeExpressionString</span><span style="color: #000000;font-weight: bold">());</span></code></pre></code></pre></div>
-<p>Note that InjectionDefense need only be used if the string being inserted could contain user supplied data. See the
-javadoc for <code>InjectionDefense</code> for usage details and SOLR-12891 for an example of the potential risks.
-Also note that for security reasons normal parameter substitution no longer applies to the expr parameter
-unless the jvm has been started with <code>-DStreamingExpressionMacros=true</code> (usually via <code>solr.in.sh</code>)</p></section>
-<section class="sect2"><h3 id="data-requirements">Data Requirements</h3><p>Because streaming expressions relies on the <code>/export</code> handler, many of the field and field type requirements to use <code>/export</code> are also requirements for <code>/stream</code>, particularly for <code>sort</code> and <code>fl</code> parameters. Please see the section <a href="exporting-result-sets.html#exporting-result-sets">Exporting Result Sets</a> for details.</p></section>
-<section class="sect2"><h3 id="request-routing">Request Routing</h3><p>Streaming Expressions respect the <a href="distributed-requests.html#shards-preference-parameter">shards.preference parameter</a> for any call to Solr.</p>
-<p>The value of <code>shards.preference</code> that is used to route requests is determined in the following order. The first option available is used.
-- Provided as a parameter in the streaming expression (e.g., <code>search(…​., shards.preference="replica.type:PULL")</code>)
-- Provided in the URL Params of the streaming expression (e.g., <code><a class="bare" href="http://solr_url:8983/solr/stream?expr=…​.&shards.preference=replica.type:PULL">http://solr_url:8983/solr/stream?expr=…​.&shards.preference=replica.type:PULL</a></code>)
-- Set as a default in the Cluster properties.</p></section>
-<section class="sect2"><h3 id="adding-custom-expressions">Adding Custom Expressions</h3><p>Creating your own custom expressions can be easily done by implementing the <a href="https://lucene.apache.org/solr/8_8_0//solr-solrj/org/apache/solr/client/solrj/io/stream/expr/Expressible.html">Expressible</a> interface. To add a custom expression to the
-list of known mappings for the <code>/stream</code> and <code>/graph</code> handlers, you just need to declare it as a plugin in <code>solrconfig.xml</code> via:</p>
-<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><expressible</span> <span style="color: #008080">name=</span><span style="color: #d14">"custom"</span> <span style="color: #008080">class=</span><span style="color: #d14">"org.example.CustomStreamingExpression"</span><span style="color: #000080">/></span></code></pre></code></pre></div></section></section>
-<section class="sect1"><h2 id="types-of-streaming-expressions">Types of Streaming Expressions</h2><section class="sect2"><h3 id="about-stream-sources">About Stream Sources</h3><p>Stream sources originate streams. The most commonly used one of these is <code>search</code>, which does a query.</p>
+<p>Note the last tuple in the above example stream is <code>{"EOF":true,"RESPONSE_TIME":33}</code>. The <code>EOF</code> indicates the end of the stream. To process the JSON response, you’ll need to use a streaming JSON implementation because streaming expressions are designed to return the entire result set which may have millions of records. In your JSON client you’ll need to iterate each doc (tuple) and check for the EOF tuple to determine the end of stream.</p></section></section>
+<section class="sect1"><h2 id="elements-of-the-lanaguage">Elements of the Lanaguage</h2><section class="sect2"><h3 id="stream-sources">Stream Sources</h3><p>Stream sources originate streams. There are rich set of searching, sampling and aggregation stream sources to choose from.</p>
<p>A full reference to all available source expressions is available in <a href="stream-source-reference.html#stream-source-reference">Stream Source Reference</a>.</p></section>
-<section class="sect2"><h3 id="about-stream-decorators">About Stream Decorators</h3><p>Stream decorators wrap other stream functions or perform operations on a stream.</p>
+<section class="sect2"><h3 id="stream-decorators">Stream Decorators</h3><p>Stream decorators wrap stream sources and other stream decorators to transform a stream.</p>
<p>A full reference to all available decorator expressions is available in <a href="stream-decorator-reference.html#stream-decorator-reference">Stream Decorator Reference</a>.</p></section>
-<section class="sect2"><h3 id="about-stream-evaluators">About Stream Evaluators</h3><p>Stream Evaluators can be used to evaluate (calculate) new values based on other values in a tuple. That newly evaluated value can be put into the tuple (as part of a <code>select(…​)</code> clause), used to filter streams (as part of a <code>having(…​)</code> clause), and for other things. Evaluators can contain field names, raw values, or other evaluators, giving you the ability to create complex evaluation logic, including conditional if/then choices.</p>
-<p>In cases where you want to use raw values as part of an evaluation you will need to consider the order of how evaluators are parsed.</p>
-<div class="olist arabic"><ol class="arabic"><li>If the parameter can be parsed into a valid number, then it is considered a number. For example, <code>add(3,4.5)</code></li><li>If the parameter can be parsed into a valid boolean, then it is considered a boolean. For example, <code>eq(true,false)</code></li><li>If the parameter can be parsed into a valid evaluator, then it is considered an evaluator. For example, <code>eq(add(10,4),add(7,7))</code></li><li>The parameter is considered a field name, even if it quoted. For example, <code>eq(fieldA,"fieldB")</code></li></ol></div>
-<p>If you wish to use a raw string as part of an evaluation, you will want to consider using the <code>raw(string)</code> evaluator. This will always return the raw value, no matter what is entered.</p>
-<p>A full reference to all available evaluator expressions is available in <a href="stream-evaluator-reference.html#stream-evaluator-reference">Stream Evaluator Reference</a>.</p></section></section>
+<section class="sect2"><h3 id="math-expressions">Math Expressions</h3><p>Math expressions are a vector and matrix math library that can be combined with streaming expressions to perform analysis and build mathematical models
+of the result sets.
+From a language standpoint math expressions are a sub-language of streaming expressions that don’t return streams of tuples.
+Instead they operate on and return numbers, vectors, matrices and mathematical models.
+The documentation will show how to combine streaming expressions and math
+expressions.</p>
+<p>The math expressions user guide is available in <<>></p>
+<p>From a language standpoint math expressions are referred to as <strong>stream evaluators</strong>.</p>
+<p>A full reference to all available evaluator expressions is available in <a href="stream-evaluator-reference.html#stream-evaluator-reference">Stream Evaluator Reference</a>.</p></section>
+<section class="sect2"><h3 id="visualization">Visualization</h3><p>Visualization of both streaming expressions and math expressions is done using Apache Zeppelin and the Zeppelin-Solr Interpreter.</p>
+<p>Visualizing Streaming expressions and setting up of Apache Zeppelin is documented in <a href="math-start.html#zeppelin-solr-interpreter">Zeppelin-Solr Interpreter</a>.</p>
+<p>The <a href="math-expressions.html#math-expressions">Math Expressions User Guide</a> has in depth coverage of visualization techniques.</p></section></section>
</section>
@@ -1777,7 +1772,7 @@ list of known mappings for the <code>/st
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/suggester.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/suggester.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/suggester.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Suggester | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Suggester | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="suggester">
+<body class="" id="suggester">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1922,7 +1942,7 @@ accommodate 3.0</code></pre></code></pre
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_8/suggestions-screen.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_8/suggestions-screen.html (original)
+++ websites/production/lucene/content/solr/guide/8_8/suggestions-screen.html Thu Jan 28 16:33:25 2021
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Suggestions Screen | Apache Solr Reference Guide 8.8-DRAFT</title>
+<title>Suggestions Screen | Apache Solr Reference Guide 8.8</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -68,7 +68,7 @@
</script>
</head>
-<body class="DRAFT" id="suggestions-screen">
+<body class="" id="suggestions-screen">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -76,11 +76,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.8.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -872,11 +867,36 @@
</li>
<li class="sb-level2">
- <a href="math-expressions.html">Math Expressions</a>
+ <a href="math-expressions.html">Streaming Expressions and Math Expressions</a>
<ul>
<li class="sb-level3">
+ <a href="visualization.html">Visualization</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="math-start.html">Getting Started</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="loading.html">Loading Data</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="search-sample.html">Searching, Sampling and Aggregation</a>
+
+ </li>
+
+ <li class="sb-level3">
+ <a href="transform.html">Transforming Data</a>
+
+ </li>
+
+ <li class="sb-level3">
<a href="scalar-math.html">Scalar Math</a>
</li>
@@ -897,12 +917,12 @@
</li>
<li class="sb-level3">
- <a href="vectorization.html">Streams and Vectorization</a>
+ <a href="term-vectors.html">Text Analysis and Term Vectors</a>
</li>
<li class="sb-level3">
- <a href="term-vectors.html">Text Analysis and Term Vectors</a>
+ <a href="probability-distributions.html">Probability Distributions</a>
</li>
@@ -912,12 +932,12 @@
</li>
<li class="sb-level3">
- <a href="probability-distributions.html">Probability Distributions</a>
+ <a href="regression.html">Linear Regression</a>
</li>
<li class="sb-level3">
- <a href="simulations.html">Monte Carlo Simulations</a>
+ <a href="curve-fitting.html">Curve Fitting</a>
</li>
@@ -927,32 +947,32 @@
</li>
<li class="sb-level3">
- <a href="regression.html">Linear Regression</a>
+ <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
</li>
<li class="sb-level3">
- <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a>
+ <a href="dsp.html">Digital Signal Processing</a>
</li>
<li class="sb-level3">
- <a href="curve-fitting.html">Curve Fitting</a>
+ <a href="simulations.html">Monte Carlo Simulations</a>
</li>
<li class="sb-level3">
- <a href="dsp.html">Digital Signal Processing</a>
+ <a href="machine-learning.html">Machine Learning</a>
</li>
<li class="sb-level3">
- <a href="machine-learning.html">Machine Learning</a>
+ <a href="computational-geometry.html">Computational Geometry</a>
</li>
<li class="sb-level3">
- <a href="computational-geometry.html">Computational Geometry</a>
+ <a href="logs.html">Log Analytics</a>
</li>
@@ -1709,7 +1729,7 @@ Since autoscaling features are only avai
<div class="row">
<div class="col-lg-12 footer">
©2021 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.8-DRAFT <br />Site last generated: 2021-01-19 <br />
+ Site Version: 8.8 <br />Site last generated: 2021-01-28 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>