From 9beafb612fa22b747b8728d7d954ea6e2bd37844 Mon Sep 17 00:00:00 2001 From: Cassandra Targett Date: Mon, 25 Sep 2017 14:35:52 -0500 Subject: [PATCH] Ref Guide: rename Streaming docs to fix broken intra-doc links in the PDF due to mismatching anchor names --- solr/solr-ref-guide/src/major-changes-in-solr-7.adoc | 2 +- ...corators.adoc => stream-decorator-reference.adoc} | 12 ++++++------ ...aluators.adoc => stream-evaluator-reference.adoc} | 4 ++-- ...eam-sources.adoc => stream-source-reference.adoc} | 11 ++++++----- solr/solr-ref-guide/src/streaming-expressions.adoc | 8 ++++---- 5 files changed, 19 insertions(+), 18 deletions(-) rename solr/solr-ref-guide/src/{stream-decorators.adoc => stream-decorator-reference.adoc} (95%) rename solr/solr-ref-guide/src/{stream-evaluators.adoc => stream-evaluator-reference.adoc} (99%) rename solr/solr-ref-guide/src/{stream-sources.adoc => stream-source-reference.adoc} (98%) diff --git a/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc b/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc index 29682df4c4a..a82a028bac3 100644 --- a/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc +++ b/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc @@ -63,7 +63,7 @@ See the section <> ** <>. See also information about related deprecations in the section <> below. ** <> -** <> +** <> ** <> ** <> diff --git a/solr/solr-ref-guide/src/stream-decorators.adoc b/solr/solr-ref-guide/src/stream-decorator-reference.adoc similarity index 95% rename from solr/solr-ref-guide/src/stream-decorators.adoc rename to solr/solr-ref-guide/src/stream-decorator-reference.adoc index 2afb52421ab..5851e45c2a3 100644 --- a/solr/solr-ref-guide/src/stream-decorators.adoc +++ b/solr/solr-ref-guide/src/stream-decorator-reference.adoc @@ -1,6 +1,6 @@ = Stream Decorator Reference -:page-shortname: stream-decorators -:page-permalink: stream-decorators.html +:page-shortname: stream-decorator-reference +:page-permalink: stream-decorator-reference.html :page-tocclass: right :page-toclevels: 1 // Licensed to the Apache Software Foundation (ASF) under one @@ -386,7 +386,7 @@ As you can see in the examples above, the `cartesianProduct` function does suppo == classify -The `classify` function classifies tuples using a logistic regression text classification model. It was designed specifically to work with models trained using the <>. The `classify` function uses the <> to retrieve a stored model and then scores a stream of tuples using the model. The tuples read by the classifier must contain a text field that can be used for classification. The classify function uses a Lucene analyzer to extract the features from the text so the model can be applied. By default the `classify` function looks for the analyzer using the name of text field in the tuple. If the Solr schema on the worker node does not contain this field, the analyzer can be looked up in another field by specifying the `analyzerField` parameter. +The `classify` function classifies tuples using a logistic regression text classification model. It was designed specifically to work with models trained using the <>. The `classify` function uses the <> to retrieve a stored model and then scores a stream of tuples using the model. The tuples read by the classifier must contain a text field that can be used for classification. The classify function uses a Lucene analyzer to extract the features from the text so the model can be applied. By default the `classify` function looks for the analyzer using the name of text field in the tuple. If the Solr schema on the worker node does not contain this field, the analyzer can be looked up in another field by specifying the `analyzerField` parameter. Each tuple that is classified is assigned two scores: @@ -500,7 +500,7 @@ daemon(id="uniqueId", ) ---- -The sample code above shows a `daemon` function wrapping an `update` function, which is wrapping a `topic` function. When this expression is sent to the `/stream` handler, the `/stream` hander sees the `daemon` function and keeps it in memory where it will run at intervals. In this particular example, the `daemon` function will run the `update` function every second. The `update` function is wrapping a <>, which will stream tuples that match the `topic` function query in batches. Each subsequent call to the topic will return the next batch of tuples for the topic. The `update` function will send all the tuples matching the topic to another collection to be indexed. The `terminate` parameter tells the daemon to terminate when the `topic` function stops sending tuples. +The sample code above shows a `daemon` function wrapping an `update` function, which is wrapping a `topic` function. When this expression is sent to the `/stream` handler, the `/stream` hander sees the `daemon` function and keeps it in memory where it will run at intervals. In this particular example, the `daemon` function will run the `update` function every second. The `update` function is wrapping a <>, which will stream tuples that match the `topic` function query in batches. Each subsequent call to the topic will return the next batch of tuples for the topic. The `update` function will send all the tuples matching the topic to another collection to be indexed. The `terminate` parameter tells the daemon to terminate when the `topic` function stops sending tuples. The effect of this is to push documents that match a specific query into another collection. Custom push functions can be plugged in that push documents out of Solr and into other systems, such as Kafka or an email system. @@ -643,7 +643,7 @@ daemon(id="myDaemon", id="myTopic"))) ---- -In the example above a <> wraps an executor, which wraps a <> that is returning tuples with expressions to execute. When sent to the stream handler, the daemon will call the executor at intervals which will cause the executor to read from the topic and execute the expressions found in the `expr_s` field. The daemon will repeatedly call the executor until all the tuples that match the topic have been iterated, then it will terminate. This is the approach for executing batches of streaming expressions from a `topic` queue. +In the example above a <> wraps an executor, which wraps a <> that is returning tuples with expressions to execute. When sent to the stream handler, the daemon will call the executor at intervals which will cause the executor to read from the topic and execute the expressions found in the `expr_s` field. The daemon will repeatedly call the executor until all the tuples that match the topic have been iterated, then it will terminate. This is the approach for executing batches of streaming expressions from a `topic` queue. == fetch @@ -1001,7 +1001,7 @@ The expression above shows a `parallel` function wrapping a `reduce` function. T The `priority` function is a simple priority scheduler for the <> function. The `executor` function doesn't directly have a concept of task prioritization; instead it simply executes tasks in the order that they are read from it's underlying stream. The `priority` function provides the ability to schedule a higher priority task ahead of lower priority tasks that were submitted earlier. -The `priority` function wraps two <> that are both emitting tuples that contain streaming expressions to execute. The first topic is considered the higher priority task queue. +The `priority` function wraps two <> that are both emitting tuples that contain streaming expressions to execute. The first topic is considered the higher priority task queue. Each time the `priority` function is called, it checks the higher priority task queue to see if there are any tasks to execute. If tasks are waiting in the higher priority queue then the priority function will emit the higher priority tasks. If there are no high priority tasks to run, the lower priority queue tasks are emitted. diff --git a/solr/solr-ref-guide/src/stream-evaluators.adoc b/solr/solr-ref-guide/src/stream-evaluator-reference.adoc similarity index 99% rename from solr/solr-ref-guide/src/stream-evaluators.adoc rename to solr/solr-ref-guide/src/stream-evaluator-reference.adoc index 35997109432..eea5ede3a11 100644 --- a/solr/solr-ref-guide/src/stream-evaluators.adoc +++ b/solr/solr-ref-guide/src/stream-evaluator-reference.adoc @@ -1,6 +1,6 @@ = Stream Evaluator Reference -:page-shortname: stream-evaluators -:page-permalink: stream-evaluators.html +:page-shortname: stream-evaluator-reference +:page-permalink: stream-evaluator-reference.html :page-tocclass: right :page-toclevels: 1 // Licensed to the Apache Software Foundation (ASF) under one diff --git a/solr/solr-ref-guide/src/stream-sources.adoc b/solr/solr-ref-guide/src/stream-source-reference.adoc similarity index 98% rename from solr/solr-ref-guide/src/stream-sources.adoc rename to solr/solr-ref-guide/src/stream-source-reference.adoc index 2b59edf9be8..cf6e4514d6e 100644 --- a/solr/solr-ref-guide/src/stream-sources.adoc +++ b/solr/solr-ref-guide/src/stream-source-reference.adoc @@ -1,6 +1,6 @@ = Stream Source Reference -:page-shortname: stream-sources -:page-permalink: stream-sources.html +:page-shortname: stream-source-reference +:page-permalink: stream-source-reference.html :page-tocclass: right :page-toclevels: 1 // Licensed to the Apache Software Foundation (ASF) under one @@ -20,6 +20,7 @@ // specific language governing permissions and limitations // under the License. +Put something here to see if it fixes things. == search @@ -36,7 +37,7 @@ This expression allows you to specify a request hander using the `qt` parameter. * `zkHost`: Only needs to be defined if the collection being searched is found in a different zkHost than the local stream handler. * `qt`: Specifies the query type, or request handler, to use. Set this to `/export` to work with large result sets. The default is `/select`. * `rows`: (Mandatory with the `/select` handler) The rows parameter specifies how many rows to return. This parameter is only needed with the `/select` handler (which is the default) since the `/export` handler always returns all rows. -* `partitionKeys`: Comma delimited list of keys to partition the search results by. To be used with the parallel function for parallelizing operations across worker nodes. See the <> function for details. +* `partitionKeys`: Comma delimited list of keys to partition the search results by. To be used with the parallel function for parallelizing operations across worker nodes. See the <> function for details. === search Syntax @@ -251,7 +252,7 @@ knn(collection1, == model -The `model` function retrieves and caches logistic regression text classification models that are stored in a SolrCloud collection. The `model` function is designed to work with models that are created by the <>, but can also be used to retrieve text classification models trained outside of Solr, as long as they conform to the specified format. After the model is retrieved it can be used by the <> to classify documents. +The `model` function retrieves and caches logistic regression text classification models that are stored in a SolrCloud collection. The `model` function is designed to work with models that are created by the <>, but can also be used to retrieve text classification models trained outside of Solr, as long as they conform to the specified format. After the model is retrieved it can be used by the <> to classify documents. A single model tuple is fetched and returned based on the *id* parameter. The model is retrieved by matching the *id* parameter with a model name in the index. If more then one iteration of the named model is stored in the index, the highest iteration is selected. @@ -384,7 +385,7 @@ stream decorator to perform parallel relational algebra. When used in parallel m * `fl`: (Mandatory) The list of fields to return. * `sort`: (Mandatory) The sort criteria. * `zkHost`: Only needs to be defined if the collection being searched is found in a different zkHost than the local stream handler. -* `partitionKeys`: Comma delimited list of keys to partition the search results by. To be used with the parallel function for parallelizing operations across worker nodes. See the <> function for details. +* `partitionKeys`: Comma delimited list of keys to partition the search results by. To be used with the parallel function for parallelizing operations across worker nodes. See the <> function for details. === shuffle Syntax diff --git a/solr/solr-ref-guide/src/streaming-expressions.adoc b/solr/solr-ref-guide/src/streaming-expressions.adoc index 6d1357369ab..95402ef6645 100644 --- a/solr/solr-ref-guide/src/streaming-expressions.adoc +++ b/solr/solr-ref-guide/src/streaming-expressions.adoc @@ -1,7 +1,7 @@ = Streaming Expressions :page-shortname: streaming-expressions :page-permalink: streaming-expressions.html -:page-children: stream-sources, stream-decorators, stream-evaluators, statistical-programming, graph-traversal +:page-children: stream-source-reference, stream-decorator-reference, stream-evaluator-reference, statistical-programming, graph-traversal // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information @@ -121,12 +121,12 @@ Because streaming expressions relies on the `/export` handler, many of the field Stream sources originate streams. The most commonly used one of these is `search`, which does a query. -A full reference to all available source expressions is available in <>. +A full reference to all available source expressions is available in <>. === About Stream Decorators Stream decorators wrap other stream functions or perform operations on a stream. -A full reference to all available decorator expressions is available in <>. +A full reference to all available decorator expressions is available in <>. === About Stream Evaluators @@ -141,4 +141,4 @@ In cases where you want to use raw values as part of an evaluation you will need If you wish to use a raw string as part of an evaluation, you will want to consider using the `raw(string)` evaluator. This will always return the raw value, no matter what is entered. -A full reference to all available evaluator expressions is available in <>. +A full reference to all available evaluator expressions is available in <>.