Here is a summary of available options on a field, broken down by use case. A true or false indicates that the option must be set to the given value for the use case to function correctly.
use case |
indexed |
stored |
multiValued |
omitNorms |
termVectors |
termPositions |
termOffsets |
search within field |
true |
|
|
|
|
|
|
retrieve contents |
|
true |
|
|
|
|
|
use as unique key |
true |
|
false |
|
|
|
|
sort on field |
true |
|
false |
true [1] |
|
|
|
use field boosts |
|
|
|
false |
|
|
|
document boosts affect searches within field |
|
|
|
false |
|
|
|
highlighting |
true[4] |
true |
|
|
[2] |
true [3] |
|
faceting |
true |
|
|
|
|
|
|
add multiple values, maintaining order |
|
|
true |
|
|
|
|
field length affects doc score |
|
|
|
false |
|
|
|
|
true[6] |
|
|
true[6] |
|
|
|
term frequency[5] |
|
|
|
|
true |
|
|
document frequency[5] |
|
|
|
|
true |
|
|
tf*idf[5] |
|
|
|
|
true |
|
|
term postitions[5] |
|
|
|
|
true |
true |
true |
term offsets[5] |
|
|
|
|
true |
true |
true |
Notes:
recommended but not necessary
will be used if present, but not necessary
if termVectors=true, then use them. If not present, highlighting will reanalyze the document
a tokenizer must be defined for the field, but it doesn't need to be indexed
For use with the TermVectorComponent
- Uses the term vector if present, otherwise the stored field. Reanalyzes the document if using the stored field.
For further considerations for faceting, see also SolrFacetingOverview. For more information on term frequency, positions, offsets etc. see TermVectorComponent.