Browse Source

Docs: Add clarifying text about regexp and terms

For the casual reader, the reference to "term queries" may be glossed over, yielding an unexpected result when using `regexp` queries.
This attempts to make that distinction more prominent.

Closes #6698
Matthew L Daniel 11 years ago
parent
commit
53f2301eea
1 changed files with 4 additions and 1 deletions
  1. 4 1
      docs/reference/query-dsl/queries/regexp-query.asciidoc

+ 4 - 1
docs/reference/query-dsl/queries/regexp-query.asciidoc

@@ -3,6 +3,9 @@
 
 The `regexp` query allows you to use regular expression term queries.
 See <<regexp-syntax>> for details of the supported regular expression language.
+The "term queries" in that first sentence means that Elasticsearch will apply
+the regexp to the terms produced by the tokenizer for that field, and not
+to the original text of the field.
 
 *Note*: The performance of a `regexp` query heavily depends on the
 regular expression chosen. Matching everything like `.*` is very slow as
@@ -49,7 +52,7 @@ You can also use special flags
 
 Possible flags are `ALL`, `ANYSTRING`, `AUTOMATON`, `COMPLEMENT`,
 `EMPTY`, `INTERSECTION`, `INTERVAL`, or `NONE`. Please check the
-http://lucene.apache.org/core/4_3_0/core/index.html?org%2Fapache%2Flucene%2Futil%2Fautomaton%2FRegExp.html[Lucene
+http://lucene.apache.org/core/4_9_0/core/org/apache/lucene/util/automaton/RegExp.html[Lucene
 documentation] for their meaning