LUCENE-3982: add regex documentation to CHANGES.txt/qp syntax

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1343779 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2012-05-29 15:33:21 +00:00
parent 872f71e0d9
commit 1f5a8b17be
2 changed files with 14 additions and 2 deletions

View File

@ -522,7 +522,10 @@ API Changes
New features
* LUCENE-2604: Added RegexpQuery support to QueryParser. Regular expressions
are directly supported by the standard queryparser.
are directly supported by the standard queryparser via
fieldName:/expression/ OR /expression against default field/
Users who wish to search for literal "/" characters are advised to
backslash-escape or quote those characters as needed.
(Simon Willnauer, Robert Muir)
* LUCENE-1606, LUCENE-2089: Adds AutomatonQuery, a MultiTermQuery that

View File

@ -51,6 +51,9 @@ enabling substantial customization to how a query is created.
<a href="#Wildcard_Searches">Wildcard Searches</a>
</li>
<li>
<a href="#Regexp_Searches">Regular expression Searches</a>
</li>
<li>
<a href="#Fuzzy_Searches">Fuzzy Searches</a>
</li>
<li>
@ -189,6 +192,12 @@ enabling substantial customization to how a query is created.
<p>You can also use the wildcard searches in the middle of a term.</p>
<pre class="code">te*t</pre>
<p>Note: You cannot use a * or ? symbol as the first character of a search.</p>
<a name="Regexp_Searches"></a>
<h3 class="boxed">Regular Expression Searches</h3>
<p>Lucene supports regular expression searches matching a pattern between forward slashes "/". The syntax may change across releases, but the current supported
syntax is documented in the {@link org.apache.lucene.util.automaton.RegExp RegExp} class. For example to find documents containing "moat" or "boat":
</p>
<pre class="code">/[mb]oat/</pre>
<a name="N1009B"></a><a name="Fuzzy_Searches"></a>
<h3 class="boxed">Fuzzy Searches</h3>
<p>Lucene supports fuzzy searches based on Damerau-Levenshtein Distance. To do a fuzzy search use the tilde, "~", symbol at the end of a Single word Term. For example to search for a term similar in spelling to "roam" use the fuzzy search: </p>
@ -294,7 +303,7 @@ enabling substantial customization to how a query is created.
<h2 class="boxed">Escaping Special Characters</h2>
<div class="section">
<p>Lucene supports escaping special characters that are part of the query syntax. The current list special characters are</p>
<p>+ - &amp;&amp; || ! ( ) { } [ ] ^ " ~ * ? : \</p>
<p>+ - &amp;&amp; || ! ( ) { } [ ] ^ " ~ * ? : \ /</p>
<p>To escape these character use the \ before the character. For example to search for (1+1):2 use the query:</p>
<pre class="code">\(1\+1\)\:2</pre>
</div>