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 2017/06/08 19:22:05 UTC
lucene-solr:branch_6x: SOLR-10351: Add documention
Repository: lucene-solr
Updated Branches:
refs/heads/branch_6x fd9590170 -> afe14bf75
SOLR-10351: Add documention
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/afe14bf7
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/afe14bf7
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/afe14bf7
Branch: refs/heads/branch_6x
Commit: afe14bf751ee76bfd19972775fb0d484571fbb3e
Parents: fd95901
Author: Joel Bernstein <jb...@apache.org>
Authored: Thu Jun 8 15:18:59 2017 -0400
Committer: Joel Bernstein <jb...@apache.org>
Committed: Thu Jun 8 15:21:52 2017 -0400
----------------------------------------------------------------------
solr/solr-ref-guide/src/stream-evaluators.adoc | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/afe14bf7/solr/solr-ref-guide/src/stream-evaluators.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/stream-evaluators.adoc b/solr/solr-ref-guide/src/stream-evaluators.adoc
index 06c15df..83fa8a8 100644
--- a/solr/solr-ref-guide/src/stream-evaluators.adoc
+++ b/solr/solr-ref-guide/src/stream-evaluators.adoc
@@ -36,7 +36,26 @@ can be called on its own or it can be called within the context of a streaming e
== analyze
-// TODO
+The `analyze` function analyzes text using a Lucene/Solr analyzer and returns a list of tokens
+emitted by the analyzer. The `analyze` function can be called on its own or within the
+`select` and `cartasianProduct` Streaming Expressions.
+
+=== analyze Parameters
+
+* `Field Name` | `Raw Text`: Either the field in a tuple or the raw text to be analyzed.
+* `Analyzer field name`: The field name of the analyzer to use to analyze the text.
+
+=== analyze Syntax
+
+The expressions below show the various ways in which you can use the `analyze` evaluator.
+
+[source,text]
+----
+analyze("hello world", analyzerField) // Analyze the raw text
+select(expr, analyze(textField, analyzerField) as outField) // Analyze a text field within a select expression. This will annotate the tuples with output of the analyzer
+cartesianProduct(expr, analyze(textField, analyzer) as outField) // Analyze a text field with a cartesianProduct expression. This will stream each token emitted by the analyzer in its own tuple.
+----
+
== abs