You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sa...@apache.org on 2017/05/31 15:27:47 UTC
[2/2] lucene-solr:master: SOLR-9596: Ref guide: document
SimpleTextCodecFactory
SOLR-9596: Ref guide: document SimpleTextCodecFactory
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/55e37cdd
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/55e37cdd
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/55e37cdd
Branch: refs/heads/master
Commit: 55e37cdd3deb3d2934690aa10b02a0aaef7780ff
Parents: 2d6edc6
Author: Steve Rowe <sa...@gmail.com>
Authored: Wed May 31 11:26:28 2017 -0400
Committer: Steve Rowe <sa...@gmail.com>
Committed: Wed May 31 11:27:03 2017 -0400
----------------------------------------------------------------------
solr/solr-ref-guide/src/codec-factory.adoc | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/55e37cdd/solr/solr-ref-guide/src/codec-factory.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/codec-factory.adoc b/solr/solr-ref-guide/src/codec-factory.adoc
index bb5f0e0..88bc083 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 <<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"/>
+----