RubyGems - rroonga - Versions diffs - 5.0.0-x64-mingw32 → 5.0.1-x64-mingw32 - Mend

rroonga 5.0.0-x64-mingw32 → 5.0.1-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (733) hide show

data/vendor/local/share/doc/groonga/en/html/reference/regular_expression.html ADDED Viewed

@@ -0,0 +1,931 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>7.13. Regular expression &mdash; Groonga v5.0.1-42-g4d10df1 documentation</title>
+    <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '5.0.1-42-g4d10df1',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="shortcut icon" href="../_static/favicon.ico"/>
+    <link rel="top" title="Groonga v5.0.1-42-g4d10df1 documentation" href="../index.html" />
+    <link rel="up" title="7. Reference manual" href="../reference.html" />
+    <link rel="next" title="7.14. Function" href="function.html" />
+    <link rel="prev" title="7.12.2. Script syntax" href="grn_expr/script_syntax.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">An open-source fulltext search engine and column store.</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../ja/html/reference/regular_expression.html"><img src="../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="function.html" title="7.14. Function"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="grn_expr/script_syntax.html" title="7.12.2. Script syntax"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">Groonga v5.0.1-42-g4d10df1 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" accesskey="U">7. Reference manual</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="regular-expression">
+<h1>7.13. Regular expression<a class="headerlink" href="#regular-expression" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="summary">
+<h2>7.13.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Regular expression support is an experimental feature.</p>
+</div>
+<div class="versionadded">
+<p><span class="versionmodified">New in version 5.0.1.</span></p>
+</div>
+<p>Groonga supports pattern match by regular expression. Regular
+expression is widely used format to describe a pattern. Regular
+expression is useful to represent complex pattern.</p>
+<p>In most cases, pattern match by regular expression is evaluated as
+sequential search. It'll be slow for many records and many texts.</p>
+<p>In some cases, pattern match by regular expression can be evaluated
+by index. It's very fast rather than sequential search. Patterns
+that can be evaluated by index are described later.</p>
+<p>There are many regular expression syntaxes. Groonga uses the same
+syntax in Ruby. Because Groonga uses the same regular expression
+engine as Ruby. The regular expression engine is <a class="reference external" href="https://github.com/k-takata/Onigmo/">Onigmo</a>. Characteristic difference
+with other regular expression syntax is <tt class="docutils literal"><span class="pre">^</span></tt> and <tt class="docutils literal"><span class="pre">$</span></tt>. The regular
+expression syntax in Ruby, <tt class="docutils literal"><span class="pre">^</span></tt> means the beginning of line and <tt class="docutils literal"><span class="pre">$</span></tt>
+means the end of line. <tt class="docutils literal"><span class="pre">^</span></tt> means the beginning of text and <tt class="docutils literal"><span class="pre">$</span></tt>
+means the end of text in other most regular expression syntaxes. The regular
+expression syntax in Ruby uses <tt class="docutils literal"><span class="pre">\A</span></tt> for the beginning of text and
+<tt class="docutils literal"><span class="pre">\z</span></tt> for the end of text.</p>
+<p>You can use regular expression in <a class="reference internal" href="commands/select.html#select-query"><em>query</em></a> and
+<a class="reference internal" href="commands/select.html#select-filter"><em>filter</em></a> options of <a class="reference internal" href="commands/select.html"><em>select</em></a>
+command.</p>
+</div>
+<div class="section" id="usage">
+<h2>7.13.2. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>Here are a schema definition and sample data to show usage. There is
+only one table, <tt class="docutils literal"><span class="pre">Logs</span></tt>. <tt class="docutils literal"><span class="pre">Logs</span></tt> table has only <tt class="docutils literal"><span class="pre">message</span></tt>
+column. Log messages are stored into the <tt class="docutils literal"><span class="pre">message</span></tt> column.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Logs message COLUMN_SCALAR Text
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+load --table Logs
+[
+{&quot;message&quot;: &quot;host1:[error]: No memory&quot;},
+{&quot;message&quot;: &quot;host1:[warning]: Remained disk space is less than 30%&quot;},
+{&quot;message&quot;: &quot;host1:[error]: Disk full&quot;},
+{&quot;message&quot;: &quot;host2:[error]: No memory&quot;},
+{&quot;message&quot;: &quot;host2:[info]: Shutdown&quot;}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 5]
+</pre></div>
+</div>
+<p>Here is an example that uses regular expression in
+<a class="reference internal" href="commands/select.html#select-query"><em>query</em></a>. You need to use
+<tt class="docutils literal"><span class="pre">${COLUMN}:~${REGULAR_EXPRESSION}</span></tt> syntax.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --query &#39;message:~&quot;[Dd]isk&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>Here is an example that uses regular expression in
+<a class="reference internal" href="commands/select.html#select-filter"><em>filter</em></a>. You need to use
+<tt class="docutils literal"><span class="pre">${COLUMN}</span> <span class="pre">&#64;~</span> <span class="pre">${REGULAR_EXPRESSION}</span></tt> syntax.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;[Dd]isk&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+</div>
+<div class="section" id="index">
+<h2>7.13.3. Index<a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h2>
+<p>Groonga can search records by regular expression with index. It's very
+fast rather than sequential search.</p>
+<p>But it doesn't support all regular expression patterns. It supports
+only the following regular expression patterns. The patterns will be
+increased in the future.</p>
+<blockquote>
+<div><ul class="simple">
+<li>Literal only pattern such as <tt class="docutils literal"><span class="pre">disk</span></tt></li>
+<li>The begging of text and literal only pattern such as <tt class="docutils literal"><span class="pre">\Adisk</span></tt></li>
+<li>The end of text and literal only pattern such as <tt class="docutils literal"><span class="pre">disk\z</span></tt></li>
+</ul>
+</div></blockquote>
+<p>You need to create an index for fast regular expression search. Here
+are requirements of index:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Lexicon must be <a class="reference internal" href="tables.html#table-pat-key"><em>TABLE_PAT_KEY</em></a> table.</li>
+<li>Lexicon must use <a class="reference internal" href="tokenizers.html#token-regexp"><em>TokenRegexp</em></a> tokenizer.</li>
+<li>Index column must has <tt class="docutils literal"><span class="pre">WITH_POSITION</span></tt> flag.</li>
+</ul>
+</div></blockquote>
+<p>Other configurations such as lexicon's normalizer are optional. You
+can choose what you like. If you want to use case-insensitive search,
+use <a class="reference internal" href="normalizers.html#normalizer-auto"><em>NormalizerAuto</em></a> normalizer.</p>
+<p>Here are recommended index definitions. In general, it's reasonable
+index definitions.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>table_create RegexpLexicon TABLE_PAT_KEY ShortText \
+  --default_tokenizer TokenRegexp \
+  --normalizer NormalizerAuto
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create RegexpLexicon logs_message_index \
+  COLUMN_INDEX|WITH_POSITION Logs message
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>Now, you can use index for regular expression search. The following
+regular expression can be evaluated by index because it uses only &quot;the
+beginning of text&quot; and &quot;literal&quot;.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --query message:~\\\\Ahost1
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         3
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         1,
+#         &quot;host1:[error]: No memory&quot;
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>Here is an example that uses <a class="reference internal" href="commands/select.html#select-filter"><em>filter</em></a> instead of
+<a class="reference internal" href="commands/select.html#select-query"><em>query</em></a>. It uses the same regular expression as the
+previous example.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;\\\\Ahost1:&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         3
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         1,
+#         &quot;host1:[error]: No memory&quot;
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">\</span></tt> escape will confuse you because there are some steps that
+require escape between you and Groonga. Here are steps that require
+<tt class="docutils literal"><span class="pre">\</span></tt> escape:</p>
+<blockquote>
+<div><ul>
+<li><p class="first">Shell only when you pass Groonga command from command line the
+following:</p>
+<div class="highlight-none"><div class="highlight"><pre>% groonga /tmp/db select Logs --filter &#39;&quot;message @~ \&quot;\\\\Ahost1:&quot;\&quot;&#39;
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">--filter</span> <span class="pre">'&quot;message</span> <span class="pre">&#64;~</span> <span class="pre">\&quot;\\\\Ahost1:\&quot;&quot;'</span></tt> is evaluated as the
+following two arguments by shell:</p>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">--filter</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">&quot;message</span> <span class="pre">&#64;~</span> <span class="pre">\&quot;\\\\Ahost1:\&quot;&quot;</span></tt></li>
+</ul>
+</div></blockquote>
+</li>
+<li><p class="first">Groonga command parser only when you pass Groonga command by
+command line style (<tt class="docutils literal"><span class="pre">COMMAND</span> <span class="pre">ARG1_VALUE</span> <span class="pre">ARG2_VALUE</span> <span class="pre">...</span></tt>) not
+HTTP path style
+(<tt class="docutils literal"><span class="pre">/d/COMMAND?ARG1_NAME=ARG1_VALUE&amp;ARG2_NAME=ARG3_VALUE</span></tt>).</p>
+<p><tt class="docutils literal"><span class="pre">&quot;message</span> <span class="pre">&#64;~</span> <span class="pre">\&quot;\\\\Ahost1:\&quot;&quot;</span></tt> is evaluated as the following
+value by Groonga command parser:</p>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">message</span> <span class="pre">&#64;~</span> <span class="pre">&quot;\\Ahost1:&quot;</span></tt></li>
+</ul>
+</div></blockquote>
+</li>
+<li><p class="first"><a class="reference internal" href="grn_expr.html"><em>grn_expr</em></a> parser. <tt class="docutils literal"><span class="pre">\</span></tt> escape is required in both
+<a class="reference internal" href="grn_expr/query_syntax.html"><em>Query syntax</em></a> and
+<a class="reference internal" href="grn_expr/script_syntax.html"><em>Script syntax</em></a>.</p>
+<p><tt class="docutils literal"><span class="pre">&quot;\\Ahost1:&quot;</span></tt> string literal in script syntax is evaluated as
+the following value:</p>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">\Ahost1</span></tt></li>
+</ul>
+</div></blockquote>
+<p>The value is evaluated as regular expression.</p>
+</li>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="syntax">
+<h2>7.13.4. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p>This section describes about only commonly used syntaxes. See <a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE">Onigmo
+syntax documentation</a> for other
+syntaxes and details.</p>
+<div class="section" id="escape">
+<span id="regular-expression-escape"></span><h3>7.13.4.1. Escape<a class="headerlink" href="#escape" title="Permalink to this headline">¶</a></h3>
+<p>In regular expression, there are the following special characters:</p>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">\</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">|</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">(</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">[</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">]</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">.</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">*</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">+</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">?</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">{</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">}</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">^</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">$</span></tt></li>
+</ul>
+</div></blockquote>
+<p>If you want to write pattern that matches these special character as
+is, you need to escape them.</p>
+<p>You can escape them by putting <tt class="docutils literal"><span class="pre">\</span></tt> before special character. Here
+are regular expressions that match special character itself:</p>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">\\</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\|</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\(</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\)</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\[</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\]</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\.</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\*</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\+</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\?</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\{</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\}</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\^</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">\$</span></tt></li>
+</ul>
+</div></blockquote>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;warning|info&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         5,
+#         &quot;host2:[info]: Shutdown&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>If your regular expression doesn't work as you expected, confirm that
+some special characters are used without escaping.</p>
+</div>
+<div class="section" id="choice">
+<span id="regular-expression-choice"></span><h3>7.13.4.2. Choice<a class="headerlink" href="#choice" title="Permalink to this headline">¶</a></h3>
+<p>Choice syntax is <tt class="docutils literal"><span class="pre">A|B</span></tt>. The regular expression matches when either
+<tt class="docutils literal"><span class="pre">A</span></tt> pattern or <tt class="docutils literal"><span class="pre">B</span></tt> pattern is matched.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;warning|info&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         5,
+#         &quot;host2:[info]: Shutdown&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p class="last">Regular expression that uses this syntax can't be evaluated by
+index.</p>
+</div>
+</div>
+<div class="section" id="group">
+<span id="regular-expression-group"></span><h3>7.13.4.3. Group<a class="headerlink" href="#group" title="Permalink to this headline">¶</a></h3>
+<p>Group syntax is <tt class="docutils literal"><span class="pre">(...)</span></tt>. Group provides the following features:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Back reference</li>
+<li>Scope reducing</li>
+</ul>
+</div></blockquote>
+<p>You can refer matched groups by <tt class="docutils literal"><span class="pre">\n</span></tt> (<tt class="docutils literal"><span class="pre">n</span></tt> is the group number)
+syntax. For example, <tt class="docutils literal"><span class="pre">e(r)\1o\1</span></tt> matches <tt class="docutils literal"><span class="pre">error</span></tt>. Because <tt class="docutils literal"><span class="pre">\1</span></tt>
+is replaced with match result (<tt class="docutils literal"><span class="pre">r</span></tt>) of the first group <tt class="docutils literal"><span class="pre">(r)</span></tt>.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;e(r)\\\\1o\\\\1&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         3
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         1,
+#         &quot;host1:[error]: No memory&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ],
+#       [
+#         4,
+#         &quot;host2:[error]: No memory&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can also use more powerful back reference features. See <a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE#L302">&quot;8. Back
+reference&quot; section in Onigmo documentation</a> for
+details.</p>
+<p>Group syntax reduces scope. For example, <tt class="docutils literal"><span class="pre">\[(warning|info)\]</span></tt>
+reduces choice syntax scope. The regular expression matches
+<tt class="docutils literal"><span class="pre">[warning]</span></tt> and <tt class="docutils literal"><span class="pre">[info]</span></tt>.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;\\\\[(warning|info)\\\\]&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         5,
+#         &quot;host2:[info]: Shutdown&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can also use more powerful group related features. See
+<a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE#L225">&quot;7. Extended groups&quot; section in Onigmo documentation</a> for
+details.</p>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p class="last">Regular expression that uses this syntax can't be evaluated by
+index.</p>
+</div>
+</div>
+<div class="section" id="character-class">
+<span id="regular-expression-character-class"></span><h3>7.13.4.4. Character class<a class="headerlink" href="#character-class" title="Permalink to this headline">¶</a></h3>
+<p>Character class syntax is <tt class="docutils literal"><span class="pre">[...]</span></tt>. Character class is useful to
+specify multiple characters to be matched.</p>
+<p>For example, <tt class="docutils literal"><span class="pre">[Dd]</span></tt> matches <tt class="docutils literal"><span class="pre">D</span></tt> or <tt class="docutils literal"><span class="pre">d</span></tt>.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;[Dd]isk&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can specify characters by range. For example, <tt class="docutils literal"><span class="pre">[0-9]</span></tt> matches
+one digit.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;[0-9][0-9]%&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         1
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can also use more powerful character class related features. See
+<a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE#L164">&quot;6. Character class&quot; section in Onigmo documentation</a> for
+details.</p>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p class="last">Regular expression that uses this syntax can't be evaluated by
+index.</p>
+</div>
+</div>
+<div class="section" id="anchor">
+<span id="regular-expression-anchor"></span><h3>7.13.4.5. Anchor<a class="headerlink" href="#anchor" title="Permalink to this headline">¶</a></h3>
+<p>There are the following commonly used anchor syntaxes. Some anchors
+can be evaluated by index.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Anchor</th>
+<th class="head">Description</th>
+<th class="head">Index ready</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">^</span></tt></td>
+<td>The beginning of line</td>
+<td>o</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">$</span></tt></td>
+<td>The end of line</td>
+<td>x</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">\A</span></tt></td>
+<td>The beginning of text</td>
+<td>o</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">\z</span></tt></td>
+<td>The end of text</td>
+<td>x</td>
+</tr>
+</tbody>
+</table>
+<p>Here is an example that uses <tt class="docutils literal"><span class="pre">\z</span></tt>.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;%\\\\z&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         1
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;host1:[warning]: Remained disk space is less than 30%&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can also use more anchors. See <a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE#L152">&quot;5. Anchors&quot; section in Onigmo
+documentation</a> for
+details.</p>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p class="last">Regular expression that uses this syntax except <tt class="docutils literal"><span class="pre">\A</span></tt> and <tt class="docutils literal"><span class="pre">\z</span></tt>
+can't be evaluated by index.</p>
+</div>
+</div>
+<div class="section" id="quantifier">
+<span id="regular-expression-quantifier"></span><h3>7.13.4.6. Quantifier<a class="headerlink" href="#quantifier" title="Permalink to this headline">¶</a></h3>
+<p>There are the following commonly used quantifier syntaxes.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Quantifier</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">?</span></tt></td>
+<td>0 or 1 time</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">*</span></tt></td>
+<td>0 or more times</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">+</span></tt></td>
+<td>1 or more times</td>
+</tr>
+</tbody>
+</table>
+<p>For example, <tt class="docutils literal"><span class="pre">er+or</span></tt> matches <tt class="docutils literal"><span class="pre">error</span></tt>, <tt class="docutils literal"><span class="pre">errror</span></tt> and so on.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs --filter &#39;message @~ &quot;er+or&quot;&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         3
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ]
+#       ],
+#       [
+#         1,
+#         &quot;host1:[error]: No memory&quot;
+#       ],
+#       [
+#         3,
+#         &quot;host1:[error]: Disk full&quot;
+#       ],
+#       [
+#         4,
+#         &quot;host2:[error]: No memory&quot;
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>You can also use more quantifiers. See <a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE#L119">&quot;4. Quantifier&quot; section in Onigmo
+documentation</a> for
+details.</p>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p class="last">Regular expression that uses this syntax can't be evaluated by
+index.</p>
+</div>
+</div>
+<div class="section" id="others">
+<h3>7.13.4.7. Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h3>
+<p>There are more syntaxes. If you're interested in them, see <a class="reference external" href="https://github.com/k-takata/Onigmo/blob/master/doc/RE">Onigmo
+documentation</a> for
+details. You may be interested in &quot;character type&quot; and &quot;character&quot;
+syntaxes.</p>
+</div>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">7.13. Regular expression</a><ul>
+<li><a class="reference internal" href="#summary">7.13.1. Summary</a></li>
+<li><a class="reference internal" href="#usage">7.13.2. Usage</a></li>
+<li><a class="reference internal" href="#index">7.13.3. Index</a></li>
+<li><a class="reference internal" href="#syntax">7.13.4. Syntax</a><ul>
+<li><a class="reference internal" href="#escape">7.13.4.1. Escape</a></li>
+<li><a class="reference internal" href="#choice">7.13.4.2. Choice</a></li>
+<li><a class="reference internal" href="#group">7.13.4.3. Group</a></li>
+<li><a class="reference internal" href="#character-class">7.13.4.4. Character class</a></li>
+<li><a class="reference internal" href="#anchor">7.13.4.5. Anchor</a></li>
+<li><a class="reference internal" href="#quantifier">7.13.4.6. Quantifier</a></li>
+<li><a class="reference internal" href="#others">7.13.4.7. Others</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="grn_expr/script_syntax.html"
+                        title="previous chapter">7.12.2. Script syntax</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="function.html"
+                        title="next chapter">7.14. Function</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/reference/regular_expression.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="function.html" title="7.14. Function"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="grn_expr/script_syntax.html" title="7.12.2. Script syntax"
+             >previous</a> |</li>
+        <li><a href="../index.html">Groonga v5.0.1-42-g4d10df1 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" >7. Reference manual</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2015, Brazil, Inc.
+    </div>
+  </body>
+</html>