Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SOLR-7530: clarifying the doc

This commit is contained in:
Mikhail Khludnev 2019-06-19 10:45:01 +03:00
parent 8a35088947
commit 48a1cb0bdc
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
solr/solr-ref-guide/src/the-terms-component.adoc
View File

@ -61,6 +61,8 @@ Example: `terms.fl=title`
Fetches the document frequency for a comma delimited list of terms. Terms are always returned in index order. If `terms.ttf` is set to true, also returns their total term frequency. If multiple `terms.fl` are defined, these statistics will be returned for each term in each requested field. Fetches the document frequency for a comma delimited list of terms. Terms are always returned in index order. If `terms.ttf` is set to true, also returns their total term frequency. If multiple `terms.fl` are defined, these statistics will be returned for each term in each requested field.
+ +
Example: `terms.list=termA,termB,termC` Example: `terms.list=termA,termB,termC`
+
NOTE: When `terms.list` is specified, then terms are always sorted by `index`. Except `terms.ttf`, none of other terms parameters are supported when `terms.list` is specified.
`terms.limit`:: `terms.limit`::
Specifies the maximum number of terms to return. The default is `10`. If the limit is set to a number less than 0, then no maximum limit is enforced. Although this is not required, either this parameter or `terms.upper` must be defined. Specifies the maximum number of terms to return. The default is `10`. If the limit is set to a number less than 0, then no maximum limit is enforced. Although this is not required, either this parameter or `terms.upper` must be defined.
@ -126,7 +128,9 @@ Example: `terms.sort=index`
`terms.ttf`:: `terms.ttf`::
If set to true, returns both `df` (docFreq) and `ttf` (totalTermFreq) statistics for each requested term in `terms.list`. In this case, the response format is: If set to true, returns both `df` (docFreq) and `ttf` (totalTermFreq) statistics for each requested term in `terms.list`. In this case, the response format is:
+
XML:
[source,xml] [source,xml]
---- ----
<lst name="terms"> <lst name="terms">
@ -139,6 +143,23 @@ If set to true, returns both `df` (docFreq) and `ttf` (totalTermFreq) statistics
</lst> </lst>
---- ----
JSON:
[source,json]
----
{
"terms": {
"field": [
"termA",
{
"df": 22,
"ttf": 73
}
]
}
}
----
`terms.upper`:: `terms.upper`::
Specifies the term to stop at. Although this parameter is not required, either this parameter or `terms.limit` must be defined. Specifies the term to stop at. Although this parameter is not required, either this parameter or `terms.limit` must be defined.
+ +