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 2017/05/05 14:44:05 UTC
[4/4] lucene-solr:jira/solr-10290: SOLR-10290: commit changed pages
since last Confluence export
SOLR-10290: commit changed pages since last Confluence export
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/4dca53bf
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/4dca53bf
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/4dca53bf
Branch: refs/heads/jira/solr-10290
Commit: 4dca53bf59e138b90db7b89c7cf9ca37fcadbe46
Parents: 72e0d34
Author: Cassandra Targett <ct...@apache.org>
Authored: Fri May 5 09:43:37 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Fri May 5 09:43:37 2017 -0500
----------------------------------------------------------------------
.../src/common-query-parameters.adoc | 4 +-
solr/solr-ref-guide/src/coreadmin-api.adoc | 8 +++
.../solr-ref-guide/src/filter-descriptions.adoc | 2 +-
solr/solr-ref-guide/src/function-queries.adoc | 21 ++++++-
solr/solr-ref-guide/src/other-parsers.adoc | 60 +++++++++++++++++++-
.../src/pagination-of-results.adoc | 8 +--
solr/solr-ref-guide/src/response-writers.adoc | 2 +-
.../src/rule-based-authorization-plugin.adoc | 2 +-
.../src/streaming-expressions.adoc | 9 +++
.../src/transforming-result-documents.adoc | 13 +++++
solr/solr-ref-guide/src/upgrading-solr.adoc | 2 +-
solr/solr-ref-guide/src/working-with-dates.adoc | 2 +-
12 files changed, 119 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/common-query-parameters.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/common-query-parameters.adoc b/solr/solr-ref-guide/src/common-query-parameters.adoc
index 0e1dd03..1f4476d 100644
--- a/solr/solr-ref-guide/src/common-query-parameters.adoc
+++ b/solr/solr-ref-guide/src/common-query-parameters.adoc
@@ -118,7 +118,7 @@ fq=+popularity:[10 TO *] +section:0
The `fl` parameter limits the information included in a query response to a specified list of fields. The fields need to either be `stored="true"` or `docValues="true"``.`
-The field list can be specified as a space-separated or comma-separated list of field names. The string "score" can be used to indicate that the score of each document for the particular query should be returned as a field. The wildcard character "`*`" selects all the fields in the document which are either `stored="true"` or `docValues="true"` and` useDocValuesAsStored="true"` (which is the default when docValues are enabled). You can also add psuedo-fields, functions and transformers to the field list request.
+The field list can be specified as a space-separated or comma-separated list of field names. The string "score" can be used to indicate that the score of each document for the particular query should be returned as a field. The wildcard character "`*`" selects all the fields in the document which are either `stored="true"` or `docValues="true"` and` useDocValuesAsStored="true"` (which is the default when docValues are enabled). You can also add pseudo-fields, functions and transformers to the field list request.
This table shows some basic examples of how to use `fl`:
@@ -137,7 +137,7 @@ This table shows some basic examples of how to use `fl`:
[[CommonQueryParameters-FunctionValues]]
=== Function Values
-<<function-queries.adoc#function-queries,Functions>> can be computed for each document in the result and returned as a psuedo-field:
+<<function-queries.adoc#function-queries,Functions>> can be computed for each document in the result and returned as a pseudo-field:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/coreadmin-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/coreadmin-api.adoc b/solr/solr-ref-guide/src/coreadmin-api.adoc
index 4c1821f..b3c99b2 100644
--- a/solr/solr-ref-guide/src/coreadmin-api.adoc
+++ b/solr/solr-ref-guide/src/coreadmin-api.adoc
@@ -52,6 +52,14 @@ When you are not running SolrCloud, if you have <<config-sets.adoc#config-sets,C
====
+.CREATE and the core.properties file
+[WARNING]
+====
+
+The core.properties file is built as part of the CREATE command. If you create a core.properties file yourself in a core directory and then try to use CREATE to add that core to Solr, you will get an error telling you that another core is already defined there. The core.properties file must NOT exist before calling the CoreAdmin API with the CREATE command.
+
+====
+
[[CoreAdminAPI-Input.1]]
=== *Input*
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/filter-descriptions.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/filter-descriptions.adoc b/solr/solr-ref-guide/src/filter-descriptions.adoc
index bd7840d..7106f0e 100644
--- a/solr/solr-ref-guide/src/filter-descriptions.adoc
+++ b/solr/solr-ref-guide/src/filter-descriptions.adoc
@@ -1438,7 +1438,7 @@ If you use this filter during indexing, you must follow it with a Flatten Graph
*Arguments:*
-`synonyms`: (required) The path of a file that contains a list of synonyms, one per line. In the (default) `solr` format - see the `format` argument below for alternatives - blank lines and lines that begin with "`#`" are ignored. This may be an absolute path, or path relative to the Solr config directory. There are two ways to specify synonym mappings:
+`synonyms`: (required) The path of a file that contains a list of synonyms, one per line. In the (default) `solr` format - see the `format` argument below for alternatives - blank lines and lines that begin with "`#`" are ignored. This may be a comma-separated list of absolute paths, or paths relative to the Solr config directory. There are two ways to specify synonym mappings:
* A comma-separated list of words. If the token matches any of the words, then all the words in the list are substituted, which will include the original token.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/function-queries.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/function-queries.adoc b/solr/solr-ref-guide/src/function-queries.adoc
index 3c6d8ab..b69b15f 100644
--- a/solr/solr-ref-guide/src/function-queries.adoc
+++ b/solr/solr-ref-guide/src/function-queries.adoc
@@ -25,7 +25,7 @@ q={!func}div(popularity,price)&fq={!frange l=1000}customer_ratings
----
sort=div(popularity,price) desc, score desc
----
-* Add the results of functions as psuedo-fields to documents in query results. For instance, for:
+* Add the results of functions as pseudo-fields to documents in query results. For instance, for:
+
[source,java]
----
@@ -159,7 +159,24 @@ Returns the ordinal of the indexed field value within the indexed list of terms
See also `rord` below.
|`ord(myIndexedField)` Example: If there were only three values ("apple","banana","pear") for a particular field X, then: `ord(X) `would be 1 for documents containing "apple", 2 for documnts containing "banana", etc...
-|pow |Raises the specified base to the specified power. `pow(x,y)` raises x to the power of y. |`pow(x,y)` `pow(x,log(y))` `pow(x,0.5):` the same as `sqrt`
+|payload a|
+Returns the float value computed from the decoded payloads of the term specified. The return value is computed using the `min`, `max`, or `average` of the decoded payloads. A special `first` function can be used instead of the others, to short-circuit term enumeration and return only the decoded payload of the first term. The field specified must have float or integer payload encoding capability (via `DelimitedPayloadTokenFilter` or `NumericPayloadTokenFilter`). If no payload is found for the term, the default value is returned.
+
+* `payload(field_name,term)`: default value is 0.0, `average` function is used.
+* `payload(field_name,term,default_value)`: default value can be a constant, field name, or another float returning function. `average` function used.
+* `payload(field_name,term,default_value,function)`: function values can be `min`, `max`, `average`, or `first`.
+
+ a|
+....
+payload(payloaded_field_dpf,term,0.0,first)
+....
+
+a|
+....
+pow
+....
+
+ |Raises the specified base to the specified power. `pow(x,y)` raises x to the power of y. |`pow(x,y)` `pow(x,log(y))` `pow(x,0.5):` the same as `sqrt`
|product |Returns the product of multiple values or functions, which are specified in a comma-separated list. `mul(...)` may also be used as an alias for this function. |`product(x,y,...)` `product(x,2)` `product(x,y)mul(x,y)`
|query |Returns the score for the given subquery, or the default value for documents not matching the query. Any type of subquery is supported through either parameter de-referencing `$otherparam` or direct specification of the query string in the <<local-parameters-in-queries.adoc#local-parameters-in-queries,Local Parameters>> through the `v` key. |`query(subquery, default)` `q=product` `(popularity,` ` query({!dismax v='solr rocks'})`: returns the product of the popularity and the score of the DisMax query. `q=product` `(popularity,` ` query($qq))&qq={!dismax}solr rocks`: equivalent to the previous query, using parameter de-referencing. `q=product` `(popularity,` ` query($qq,0.1))` `&qq={!dismax}` `solr rocks`: specifies a default score of 0.1 for documents that don't match the DisMax query.
|recip a|
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/other-parsers.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/other-parsers.adoc b/solr/solr-ref-guide/src/other-parsers.adoc
index d8e4a96..0e8cdda 100644
--- a/solr/solr-ref-guide/src/other-parsers.adoc
+++ b/solr/solr-ref-guide/src/other-parsers.adoc
@@ -26,8 +26,9 @@ Query parsers discussed in this section:
* <<OtherParsers-OldLuceneQueryParser,Old Lucene Query Parser>>
* <<OtherParsers-PrefixQueryParser,Prefix Query Parser>>
* <<OtherParsers-RawQueryParser,Raw Query Parser>>
-* <<OtherParsers-Re-RankingQueryParser,Re-Ranking Query Parser>>
+* <<OtherParsers-PayloadQueryParsers,Payload Query Parsers>>
+* <<OtherParsers-Re-RankingQueryParser,Re-Ranking Query Parser>>
* <<OtherParsers-SimpleQueryParser,Simple Query Parser>>
* <<OtherParsers-SpatialQueryParsers,Spatial Query Parsers>>
* <<OtherParsers-SurroundQueryParser,Surround Query Parser>>
@@ -611,6 +612,63 @@ Example:
{!lucenePlusSort} myfield:foo +bar -baz;price asc
----
+[[OtherParsers-PayloadQueryParsers]]
+== Payload Query Parsers
+
+These query parsers utilize payloads encoded on terms during indexing. The main query, for both of these parsers, is parsed straightforwardly from the field type's query analysis into a `SpanQuery`. The generated `SpanQuery` will be either a `SpanTermQuery` or an ordered, zero slop `SpanNearQuery`, depending on how many tokens are emitted. Payloads can be encoded on terms using either the `DelimitedPayloadTokenFilter` or the `NumericPayloadTokenFilter`. The payload using parsers are:
+
+* `PayloadScoreQParser`
+* `PayloadCheckQParser`
+
+[[OtherParsers-PayloadScoreParser]]
+=== Payload Score Parser
+
+`PayloadScoreQParser` incorporates each matching term's numeric (integer or float) payloads into the scores.
+
+This parser accepts the following parameters:
+
+[width="100%",cols="50%,50%",options="header",]
+|===
+|Parameter |Description
+|`f` |Field to use (required)
+|`func` |Payload function: min, max, average (required)
+|`includeSpanScore` |If true, multiples computed payload factor by the score of the original query. If false, the computed payload factor is the score. (default: false)
+|===
+
+Example:
+
+[source,java]
+----
+{!payload_score f=my_field_dpf v=some_term func=max}
+----
+
+[[OtherParsers-PayloadCheckParser]]
+=== Payload Check Parser
+
+`PayloadCheckQParser` only matches when the matching terms also have the specified payloads.
+
+This parser accepts the following parameters:
+
+// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+
+[width="100%",cols="50%,50%",options="header",]
+|===
+|Parameter |Description
+|`f` |Field to use (required)
+|payloads a|
+space-separated list of payloads that must match the query terms (required)
+
+Each specified payload will be encoded using the encoder determined from the field type and encoded accordingly for matching.
+
+`DelimitedPayloadTokenFilter` 'identity' encoded payloads also work here, as well as float and integer encoded ones.
+
+|===
+
+[source,java]
+----
+{!payload_check f=words_dps payloads="VERB NOUN"}searching stuff
+----
+
[[OtherParsers-PrefixQueryParser]]
== Prefix Query Parser
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/pagination-of-results.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/pagination-of-results.adoc b/solr/solr-ref-guide/src/pagination-of-results.adoc
index cf13629..731dfce 100644
--- a/solr/solr-ref-guide/src/pagination-of-results.adoc
+++ b/solr/solr-ref-guide/src/pagination-of-results.adoc
@@ -10,7 +10,7 @@ In most search application usage, the "top" matching results (sorted by score, o
[[PaginationofResults-BasicPaginationExamples]]
=== Basic Pagination Examples
-The easiest way to think about simple pagination, is to simply multiply the page number you want (treating the "first" page number as "0") by the number of rows per page; such as in the following psuedo-code:
+The easiest way to think about simple pagination, is to simply multiply the page number you want (treating the "first" page number as "0") by the number of rows per page; such as in the following pseudo-code:
[source,plain]
----
@@ -99,7 +99,7 @@ Cursor mark values are computed based on the sort values of each document in the
[[PaginationofResults-FetchAllDocs]]
==== Fetch All Docs
-The psuedo-code shown here shows the basic logic involved in fetching all documents matching a query using a cursor:
+The pseudo-code shown here shows the basic logic involved in fetching all documents matching a query using a cursor:
[source,plain]
----
@@ -117,7 +117,7 @@ while (not $done) {
}
----
-Using SolrJ, this psuedo-code would be:
+Using SolrJ, this pseudo-code would be:
[source,java]
----
@@ -248,7 +248,7 @@ In this situation, you will be guaranteed that each document is only returned on
[[PaginationofResults-_Tailing_aCursor]]
=== "Tailing" a Cursor
-Because Cursor requests are stateless, and the `cursorMark` values encapsulate the *absolute* sort values of the last document returned from a search, it's possible to "continue" fetching additional results from a cursor that has already reached its end -- if new documents are added (or existing documents are updated) to the end of the results. You can think of this as similar to using something like "`tail -f"` in Unix. The most common examples of how this can be useful is when you have a "timestamp" field recording when a document has been added/updated in your index. Client applications can continuously poll a cursor using a `sort=timestamp asc, id asc` for documents matching a query, and always be notified when a document is added or updated matching the request criteria. Another common example is when you have uniqueKey values that always increase as new documents are created, and you can continuously poll a cursor using `sort=id asc` to be notified about new documents. The psu
edo-code for tailing a cursor is only a slight modification from our early example for processing all docs matching a query:
+Because Cursor requests are stateless, and the cursorMark values encapsulate the absolute sort values of the last document returned from a search, it's possible to "continue" fetching additional results from a cursor that has already reached its end -- if new documents are added (or existing documents are updated) to the end of the results. You can think of this as similar to using something like "tail -f" in Unix. The most common examples of how this can be useful is when you have a "timestamp" field recording when a document has been added/updated in your index. Client applications can continuously poll a cursor using a sort=timestamp asc, id asc for documents matching a query, and always be notified when a document is added or updated matching the request criteria. Another common example is when you have uniqueKey values that always increase as new documents are created, and you can continuously poll a cursor using sort=id asc to be notified about new documents. The pseudo-code f
or tailing a cursor is only a slight modification from our early example for processing all docs matching a query:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/response-writers.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/response-writers.adoc b/solr/solr-ref-guide/src/response-writers.adoc
index 93ee107..6607d6c 100644
--- a/solr/solr-ref-guide/src/response-writers.adoc
+++ b/solr/solr-ref-guide/src/response-writers.adoc
@@ -252,7 +252,7 @@ rsp['response']['docs'].each { |doc| puts 'name field = ' + doc['name'\] }
The CSV response writer returns a list of documents in comma-separated values (CSV) format. Other information that would normally be included in a response, such as facet information, is excluded.
-The CSV response writer supports multi-valued fields, as well as<<transforming-result-documents.adoc#transforming-result-documents,psuedo-fields>>, and the output of this CSV format is compatible with Solr's https://wiki.apache.org/solr/UpdateCSV[CSV update format].
+The CSV response writer supports multi-valued fields, as well as<<transforming-result-documents.adoc#transforming-result-documents,pseudo-fields>>, and the output of this CSV format is compatible with Solr's https://wiki.apache.org/solr/UpdateCSV[CSV update format].
[[ResponseWriters-CSVParameters]]
=== CSV Parameters
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc b/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
index 06480cd..2366143 100644
--- a/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
+++ b/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
@@ -30,7 +30,7 @@ This example `security.json` shows how the <<basic-authentication-plugin.adoc#ba
"authorization":{
"class":"solr.RuleBasedAuthorizationPlugin",
"permissions":[{"name":"security-edit",
- "role":"admin"}]
+ "role":"admin"}],
"user-role":{"solr":"admin"}
}}
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/streaming-expressions.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/streaming-expressions.adoc b/solr/solr-ref-guide/src/streaming-expressions.adoc
index 7ea7d62..fed02af 100644
--- a/solr/solr-ref-guide/src/streaming-expressions.adoc
+++ b/solr/solr-ref-guide/src/streaming-expressions.adoc
@@ -475,6 +475,9 @@ stats(collection1,
count(*))
----
+[[StreamingExpressions-timeseries]]
+=== timeseries
+
[[StreamingExpressions-train]]
=== train
@@ -553,6 +556,9 @@ Stream decorators wrap other stream functions or perform operations on the strea
[[StreamingExpressions-cartesianProduct_6.6_]]
=== cartesianProduct (6.6)
+[[StreamingExpressions-cell]]
+=== cell
+
[[StreamingExpressions-classify]]
=== classify
@@ -1080,6 +1086,9 @@ merge(
on="fieldA asc")
----
+[[StreamingExpressions-list]]
+=== list
+
[[StreamingExpressions-null]]
=== null
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/transforming-result-documents.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/transforming-result-documents.adoc b/solr/solr-ref-guide/src/transforming-result-documents.adoc
index b1fdc9c..9af3ef6 100644
--- a/solr/solr-ref-guide/src/transforming-result-documents.adoc
+++ b/solr/solr-ref-guide/src/transforming-result-documents.adoc
@@ -256,6 +256,19 @@ Here is how it looks like in various formats:
SolrDocumentList subResults = (SolrDocumentList)doc.getFieldValue("children");
----
+[[TransformingResultDocuments-Subqueryresultfields]]
+==== Subquery result fields
+
+To appear in subquery document list, a field should be specified both fl parameters, in main one fl (despite the main result documents have no this field) and in subquery's one eg `foo.fl`. Of course, you can use wildcard in any or both of these parameters. For example, if field title should appear in categories subquery, it can be done via one of these ways.
+
+[source,java]
+----
+fl=...title,categories:[subquery]&categories.fl=title&categories.q=...
+fl=...title,categories:[subquery]&categories.fl=*&categories.q=...
+fl=...*,categories:[subquery]&categories.fl=*&categories.q=...
+fl=...*,categories:[subquery]&categories.fl=*&categories.q=...
+----
+
[[TransformingResultDocuments-SubqueryParametersShift]]
==== Subquery Parameters Shift
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/upgrading-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/upgrading-solr.adoc b/solr/solr-ref-guide/src/upgrading-solr.adoc
index 8c60878..27faa14 100644
--- a/solr/solr-ref-guide/src/upgrading-solr.adoc
+++ b/solr/solr-ref-guide/src/upgrading-solr.adoc
@@ -13,7 +13,7 @@ If you are already using Solr 6.5, Solr 6.6 should not present any major problem
== Upgrading from earlier 6.x versions
* If you use historical dates, specifically on or before the year 1582, you should re-index after upgrading to this version.
-* If you use the https://cwiki.apache.org/confluence/display/solr/Faceted+Search[JSON Facet API] (json.facet) with `method=stream`, you must now set `sort='index asc'` to get the streaming behavior; otherwise it won't stream. Reminder: "method" is a hint that doesn't change defaults of other parameters.
+* If you use the <<faceted-search.adoc#faceted-search,JSON Facet API>> (json.facet) with `method=stream`, you must now set `sort='index asc'` to get the streaming behavior; otherwise it won't stream. Reminder: "method" is a hint that doesn't change defaults of other parameters.
* If you use the JSON Facet API (json.facet) to facet on a numeric field and if you use `mincount=0` or if you set the prefix, then you will now get an error as these options are incompatible with numeric faceting.
* Solr's logging verbosity at the INFO level has been greatly reduced, and you may need to update the log configs to use the DEBUG level to see all the logging messages you used to see at INFO level before.
* We are no longer backing up `solr.log` and `solr_gc.log` files in date-stamped copies forever. If you relied on the `solr_log_<date>` or `solr_gc_log_<date>` being in the logs folder that will no longer be the case. See the section <<configuring-logging.adoc#configuring-logging,Configuring Logging>> for details on how log rotation works as of Solr 6.3.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/4dca53bf/solr/solr-ref-guide/src/working-with-dates.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/working-with-dates.adoc b/solr/solr-ref-guide/src/working-with-dates.adoc
index 7fe8244..09cac9c 100644
--- a/solr/solr-ref-guide/src/working-with-dates.adoc
+++ b/solr/solr-ref-guide/src/working-with-dates.adoc
@@ -37,7 +37,7 @@ As you can see, the date format includes colon characters separating the hours,
This is normally an invalid query: `datefield:1972-05-20T17:33:18.772Z`
-These are valid queries: `datefield:1972-05-20T17\:33\:18.772Z` `datefield:"1972-05-20T17:33:18.772Z"` `datefield:[1972-05-20T17:33:18.772 TO *]`
+These are valid queries: `datefield:1972-05-20T17\:33\:18.772Z` `datefield:"1972-05-20T17:33:18.772Z"` `datefield:[1972-05-20T17:33:18.772Z TO *]`
====