You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2007/02/27 19:39:47 UTC

[Solr Wiki] Update of "SchemaXml" by MikeKlaas

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by MikeKlaas:
http://wiki.apache.org/solr/SchemaXml

The comment on the change is:
Fleshed out field option documentation

------------------------------------------------------------------------------
     * `indexed=true|false`
     * `stored=true|false`
     * `multiValued=true|false`
-    * `omitNorms=true|false`
+    * `omitNorms=true|false`   
     * `positionIncrementGap=N`
  
  `TextField`s can also support Analyzers with highly configurable [:AnalyzersTokenizersTokenFilters:Tokenizers and Token Filters].
  
  /!\ :TODO: /!\ do omitNorms and positionIncrementGap have any meaning for non !TextFields?
+ 
+ Field types that store text (`TextField`, `StrField`) support compression of stored contents:
+ 
+    * `compressed=true|false`
+    * `compressThreshold=<integer>`
+ 
+ `compressThreshold` is the minimum length required for text compression to be invoked.  This applies only if `compressed=true`; a common pattern is to set `compressThreshold` on the field type definition, and turn compression on and off in the individual field definitions.
  
  == Fields ==
  
@@ -36, +43 @@

     * `indexed=true|false`
     * `stored=true|false`
     * `compressed=true|false`
+    * `compressThreshold=<integer>`
     * `multiValued=true|false`
     * `omitNorms=true|false`
  
- See also FieldOptionsByUseCase
+ See also FieldOptionsByUseCase.
  
  One of the powerful features of Lucene is that you don't have to pre-define every field when you first create your index.  Even though Solr provides strong datatyping for fields, it still preserves that flexibility using "Dynamic Fields".  Using `<dynamicField>` declarations, you can create field rules that Solr will use to understand what datatype should be used whenever it is given a field name that is not explicitly defined, but matches a prefix or suffix used in a dynamicField.  
  
@@ -49, +57 @@

      <dynamicField name="*_i"  type="integer"  indexed="true"  stored="true"/>
  }}}
  
+ === Expert field options ===
+ 
+ The storage of Lucene term vectors can be triggered using the following field options:
+    * `termVectors=true|false`
+    * `storePositions=true|false`
+    * `storeOffsets=true|false`
+ 
+ These options can be used to accelerate highlighting and other anciliary functionality, but impose a substantial cost in terms of index size.  They are ''not'' necessary for typical uses of Solr (phrase queries, etc., do not require these settings to be present).
  
  == Miscellaneous Settings ==