From 55e37cdd3deb3d2934690aa10b02a0aaef7780ff Mon Sep 17 00:00:00 2001 From: Steve Rowe Date: Wed, 31 May 2017 11:26:28 -0400 Subject: [PATCH] SOLR-9596: Ref guide: document SimpleTextCodecFactory --- solr/solr-ref-guide/src/codec-factory.adoc | 24 +++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/solr/solr-ref-guide/src/codec-factory.adoc b/solr/solr-ref-guide/src/codec-factory.adoc index bb5f0e09986..88bc0831946 100644 --- a/solr/solr-ref-guide/src/codec-factory.adoc +++ b/solr/solr-ref-guide/src/codec-factory.adoc @@ -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 <> section for more details. * A `compressionMode` option: @@ -35,3 +44,16 @@ Example: BEST_COMPRESSION ---- + +=== 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] +---- + +----