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

SOLR-9596: Ref guide: document SimpleTextCodecFactory

This commit is contained in:
Steve Rowe 2017-05-31 11:26:28 -04:00
parent 2d6edc69b3
commit 55e37cdd3d
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
solr/solr-ref-guide/src/codec-factory.adoc
View File

@ -20,7 +20,16 @@
A `codecFactory` can be specified in `solrconfig.xml` to determine which Lucene {lucene-javadocs}/core/org/apache/lucene/codecs/Codec.html[`Codec`] is used when writing the index to disk.
If not specified, Lucene's default codec is implicitly used, but a {solr-javadocs}/solr-core/org/apache/solr/core/SchemaCodecFactory.html[`solr.SchemaCodecFactory`] is also available which supports 2 key features:
If not specified, Lucene's default codec is implicitly used.
There are two alternatives to Lucene's default codec:
. {solr-javadocs}/solr-core/org/apache/solr/core/SchemaCodecFactory.html[`solr.SchemaCodecFactory`]
. {solr-javadocs}/solr-core/org/apache/solr/core/SimpleTextCodecFactory.html[`solr.SimpleTextCodecFactory`]
=== solr.SchemaCodecFactory
`solr.SchemaCodecFactory` supports 2 key features:
* Schema based per-fieldtype configuration for `docValuesFormat` and `postingsFormat` - see the <<field-type-definitions-and-properties.adoc#field-type-properties,Field Type Properties>> section for more details.
* A `compressionMode` option:
@ -35,3 +44,16 @@ Example:
<str name="compressionMode">BEST_COMPRESSION</str>
</codecFactory>
----
=== solr.SimpleTextCodecFactory
This factory for Lucene's `SimpleTextCodec` produces a plain text human-readable index format.
CAUTION: *FOR RECREATIONAL USE ONLY*. This codec should never be used in production. `SimpleTextCodec` is relatively slow and takes up a large amount of disk space. Its use should be limited to educational and debugging purposes.
Example:
[source,xml]
----
<codecFactory class="solr.SimpleTextCodecFactory"/>
----