summaryrefslogtreecommitdiff
path: root/docs/reference/index-modules/analysis.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/index-modules/analysis.asciidoc')
-rw-r--r--docs/reference/index-modules/analysis.asciidoc18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/reference/index-modules/analysis.asciidoc b/docs/reference/index-modules/analysis.asciidoc
new file mode 100644
index 0000000..1cf33e8
--- /dev/null
+++ b/docs/reference/index-modules/analysis.asciidoc
@@ -0,0 +1,18 @@
+[[index-modules-analysis]]
+== Analysis
+
+The index analysis module acts as a configurable registry of Analyzers
+that can be used in order to both break indexed (analyzed) fields when a
+document is indexed and process query strings. It maps to the Lucene
+`Analyzer`.
+
+Analyzers are (generally) composed of a single `Tokenizer` and zero or
+more `TokenFilters`. A set of `CharFilters` can be associated with an
+analyzer to process the characters prior to other analysis steps. The
+analysis module allows one to register `TokenFilters`, `Tokenizers` and
+`Analyzers` under logical names that can then be referenced either in
+mapping definitions or in certain APIs. The Analysis module
+automatically registers (*if not explicitly defined*) built in
+analyzers, token filters, and tokenizers.
+
+See <<analysis>> for configuration details. \ No newline at end of file