RubyGems - rroonga - Versions diffs - 3.1.0-x86-mingw32 → 3.1.1-x86-mingw32 - Mend

rroonga 3.1.0-x86-mingw32 → 3.1.1-x86-mingw32

Files changed (523) hide show

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

@@ -0,0 +1,331 @@
+<!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>8.11.1. between &mdash; Groonga v3.1.1 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:     '3.1.1',
+        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 v3.1.1 documentation" href="../../index.html" />
+    <link rel="up" title="8.11. Function" href="../function.html" />
+    <link rel="next" title="8.11.2. edit_distance" href="edit_distance.html" />
+    <link rel="prev" title="8.11. Function" href="../function.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/functions/between.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="edit_distance.html" title="8.11.2. edit_distance"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="../function.html" title="8.11. Function"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../../index.html">Groonga v3.1.1 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../function.html" accesskey="U">8.11. Function</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="between">
+<h1>8.11.1. between<a class="headerlink" href="#between" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.11.1.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">between</span></tt> is used for checking the specified value exists in the specific range.
+It is often used for combination with <a class="reference internal" href="../commands/select.html#select-filter"><em>filter</em></a> option in <a class="reference internal" href="../commands/select.html"><em>select</em></a>.</p>
+</div>
+<div class="section" id="syntax">
+<h2>8.11.1.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">between</span></tt> has five parameters:</p>
+<div class="highlight-none"><div class="highlight"><pre>between(column_or_value, min, min_border, max, max_border)
+</pre></div>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>8.11.1.3. 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.:</p>
+<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText
+column_create Users age COLUMN_SCALAR Int32
+table_create Ages TABLE_HASH_KEY Int32
+column_create Ages user_age COLUMN_INDEX Users age
+load --table Users
+[
+{&quot;_key&quot;: &quot;Alice&quot;,  &quot;age&quot;: 12},
+{&quot;_key&quot;: &quot;Bob&quot;,    &quot;age&quot;: 13},
+{&quot;_key&quot;: &quot;Calros&quot;, &quot;age&quot;: 15},
+{&quot;_key&quot;: &quot;Dave&quot;,   &quot;age&quot;: 16},
+{&quot;_key&quot;: &quot;Eric&quot;,   &quot;age&quot;: 20}
+{&quot;_key&quot;: &quot;Frank&quot;,  &quot;age&quot;: 21}
+]
+</pre></div>
+</div>
+<p>Here is the query to show the persons to match PG-13 rating (MPAA).</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Users --filter &#39;between(age, 13, &quot;include&quot;, 16, &quot;include&quot;)&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         3
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;_key&quot;,
+#           &quot;ShortText&quot;
+#         ],
+#         [
+#           &quot;age&quot;,
+#           &quot;Int32&quot;
+#         ]
+#       ],
+#       [
+#         2,
+#         &quot;Bob&quot;,
+#         13
+#       ],
+#       [
+#         3,
+#         &quot;Calros&quot;,
+#         15
+#       ],
+#       [
+#         4,
+#         &quot;Dave&quot;,
+#         16
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>It returns 13, 14, 15 and 16 years old users.</p>
+<p><tt class="docutils literal"><span class="pre">between</span></tt> function accepts not only a column of table, but also the value.</p>
+<p>If you specify the value as 1st parameter, it is checked whether the value is included or not. if it matches to the specified range, it returns the all records because <tt class="docutils literal"><span class="pre">between</span></tt> function returns true.</p>
+<p>If it doesn't match to the specified range, it returns no records because <tt class="docutils literal"><span class="pre">between</span></tt> function returns false.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Users --filter &#39;between(14, 13, &quot;include&quot;, 16, &quot;include&quot;)&#39;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         6
+#       ],
+#       [
+#         [
+#           &quot;_id&quot;,
+#           &quot;UInt32&quot;
+#         ],
+#         [
+#           &quot;_key&quot;,
+#           &quot;ShortText&quot;
+#         ],
+#         [
+#           &quot;age&quot;,
+#           &quot;Int32&quot;
+#         ]
+#       ],
+#       [
+#         1,
+#         &quot;Alice&quot;,
+#         12
+#       ],
+#       [
+#         2,
+#         &quot;Bob&quot;,
+#         13
+#       ],
+#       [
+#         3,
+#         &quot;Calros&quot;,
+#         15
+#       ],
+#       [
+#         4,
+#         &quot;Dave&quot;,
+#         16
+#       ],
+#       [
+#         5,
+#         &quot;Eric&quot;,
+#         20
+#       ],
+#       [
+#         6,
+#         &quot;Frank&quot;,
+#         21
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>In the above case, it returns all the records, because 14 exists in between 13 and 16.
+This behavior is used for checking the specified value exists or not in the table.</p>
+</div>
+<div class="section" id="parameters">
+<h2>8.11.1.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<p>There are five required parameters, <tt class="docutils literal"><span class="pre">column_or_value</span></tt>, and <tt class="docutils literal"><span class="pre">min</span></tt>, <tt class="docutils literal"><span class="pre">min_border</span></tt>, <tt class="docutils literal"><span class="pre">max</span></tt> and <tt class="docutils literal"><span class="pre">max_border</span></tt>.</p>
+<div class="section" id="column-or-value">
+<h3>8.11.1.4.1. <tt class="docutils literal"><span class="pre">column_or_value</span></tt><a class="headerlink" href="#column-or-value" title="Permalink to this headline">¶</a></h3>
+<p>It specifies a column of the table or the value.</p>
+</div>
+<div class="section" id="min">
+<h3>8.11.1.4.2. <tt class="docutils literal"><span class="pre">min</span></tt><a class="headerlink" href="#min" title="Permalink to this headline">¶</a></h3>
+<p>It specifies the minimal border value of the range.
+You can control the behavior that the value of <tt class="docutils literal"><span class="pre">max</span></tt> is included or excluded by <tt class="docutils literal"><span class="pre">max_border</span></tt> parameter.</p>
+</div>
+<div class="section" id="min-border">
+<h3>8.11.1.4.3. <tt class="docutils literal"><span class="pre">min_border</span></tt><a class="headerlink" href="#min-border" title="Permalink to this headline">¶</a></h3>
+<p>It specifies whether the specified range contains the value of <tt class="docutils literal"><span class="pre">min</span></tt> or not.
+The value of <tt class="docutils literal"><span class="pre">min_border</span></tt> are either &quot;include&quot; or &quot;exclude&quot;. If it is &quot;include&quot;, <tt class="docutils literal"><span class="pre">min</span></tt> value is included. If it is &quot;exclude&quot;, <tt class="docutils literal"><span class="pre">min</span></tt> value is not included.</p>
+</div>
+<div class="section" id="max">
+<h3>8.11.1.4.4. <tt class="docutils literal"><span class="pre">max</span></tt><a class="headerlink" href="#max" title="Permalink to this headline">¶</a></h3>
+<p>It specifies the maximum border value of the range.
+You can control the behavior that the value of <tt class="docutils literal"><span class="pre">max</span></tt> is included or excluded by <tt class="docutils literal"><span class="pre">max_border</span></tt> parameter.</p>
+</div>
+<div class="section" id="max-border">
+<h3>8.11.1.4.5. <tt class="docutils literal"><span class="pre">max_border</span></tt><a class="headerlink" href="#max-border" title="Permalink to this headline">¶</a></h3>
+<p>It specifies whether the specified range contains the value of <tt class="docutils literal"><span class="pre">max</span></tt> or not.
+The value of <tt class="docutils literal"><span class="pre">max_border</span></tt> are either &quot;include&quot; or &quot;exclude&quot;. If it is &quot;include&quot;, <tt class="docutils literal"><span class="pre">max</span></tt> value is included. If it is &quot;exclude&quot;, <tt class="docutils literal"><span class="pre">max</span></tt> value is not included.</p>
+</div>
+</div>
+<div class="section" id="return-value">
+<h2>8.11.1.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">between</span></tt> returns whether the value of column exists in specified the value of range or not. If record is matched to specified the value of range, it returns true. Otherwise, it returns false.</p>
+</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="#">8.11.1. between</a><ul>
+<li><a class="reference internal" href="#summary">8.11.1.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">8.11.1.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">8.11.1.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">8.11.1.4. Parameters</a><ul>
+<li><a class="reference internal" href="#column-or-value">8.11.1.4.1. <tt class="docutils literal"><span class="pre">column_or_value</span></tt></a></li>
+<li><a class="reference internal" href="#min">8.11.1.4.2. <tt class="docutils literal"><span class="pre">min</span></tt></a></li>
+<li><a class="reference internal" href="#min-border">8.11.1.4.3. <tt class="docutils literal"><span class="pre">min_border</span></tt></a></li>
+<li><a class="reference internal" href="#max">8.11.1.4.4. <tt class="docutils literal"><span class="pre">max</span></tt></a></li>
+<li><a class="reference internal" href="#max-border">8.11.1.4.5. <tt class="docutils literal"><span class="pre">max_border</span></tt></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#return-value">8.11.1.5. Return value</a></li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="../function.html"
+                        title="previous chapter">8.11. Function</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="edit_distance.html"
+                        title="next chapter">8.11.2. edit_distance</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/functions/between.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="edit_distance.html" title="8.11.2. edit_distance"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="../function.html" title="8.11. Function"
+             >previous</a> |</li>
+        <li><a href="../../index.html">Groonga v3.1.1 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../function.html" >8.11. Function</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2013, Brazil, Inc.
+    </div>
+  </body>
+</html>

data/vendor/local/share/doc/groonga/en/html/reference/functions/edit_distance.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.11.1. edit_distance &mdash; Groonga v3.1.0 documentation</title>
+    <title>8.11.2. edit_distance &mdash; Groonga v3.1.1 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '3.1.0',
+        VERSION:     '3.1.1',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,10 +25,10 @@
     <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 v3.1.0 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v3.1.1 documentation" href="../../index.html" />
     <link rel="up" title="8.11. Function" href="../function.html" />
-    <link rel="next" title="8.11.2. geo_distance" href="geo_distance.html" />
-    <link rel="prev" title="8.11. Function" href="../function.html" />
+    <link rel="next" title="8.11.3. geo_distance" href="geo_distance.html" />
+    <link rel="prev" title="8.11.1. between" href="between.html" />
   </head>
   <body>
 <div class="header">
@@ -55,12 +55,12 @@
           <a href="../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="geo_distance.html" title="8.11.2. geo_distance"
+          <a href="geo_distance.html" title="8.11.3. geo_distance"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="../function.html" title="8.11. Function"
+          <a href="between.html" title="8.11.1. between"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v3.1.0 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.1.1 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../function.html" accesskey="U">8.11. Function</a> &raquo;</li>
       </ul>
@@ -72,24 +72,24 @@
           <div class="body">
   <div class="section" id="edit-distance">
-<h1>8.11.1. edit_distance<a class="headerlink" href="#edit-distance" title="Permalink to this headline">¶</a></h1>
+<h1>8.11.2. edit_distance<a class="headerlink" href="#edit-distance" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="id1">
-<h2>8.11.1.1. 名前<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.1. 名前<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <p>edit_distance - 指定した2つの文字列の編集距離を計算する</p>
 </div>
 <div class="section" id="id2">
-<h2>8.11.1.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-none"><div class="highlight"><pre>edit_distance(string1, string2)
 </pre></div>
 </div>
 </div>
 <div class="section" id="id3">
-<h2>8.11.1.3. 説明<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.3. 説明<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
 <p>groonga組込関数の一つであるedit_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。</p>
 <p>edit_distance() 関数は、string1に指定した文字列とstring2に指定した文字列の間の編集距離を求めます。</p>
 </div>
 <div class="section" id="id4">
-<h2>8.11.1.4. 引数<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.4. 引数<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
 <p><tt class="docutils literal"><span class="pre">string1</span></tt></p>
 <blockquote>
 <div>文字列を指定します</div></blockquote>
@@ -98,11 +98,11 @@
 <div>もうひとつの文字列を指定します</div></blockquote>
 </div>
 <div class="section" id="id5">
-<h2>8.11.1.5. 返値<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.5. 返値<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
 <p>指定した2つ文字列の編集距離をUint32型の値として返します。</p>
 </div>
 <div class="section" id="id6">
-<h2>8.11.1.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
+<h2>8.11.2.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-none"><div class="highlight"><pre>edit_distance(title, &quot;hoge&quot;)
 1
 </pre></div>
@@ -118,23 +118,23 @@
         <div class="sphinxsidebarwrapper">
   <h3><a href="../../index.html">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">8.11.1. edit_distance</a><ul>
-<li><a class="reference internal" href="#id1">8.11.1.1. 名前</a></li>
-<li><a class="reference internal" href="#id2">8.11.1.2. 書式</a></li>
-<li><a class="reference internal" href="#id3">8.11.1.3. 説明</a></li>
-<li><a class="reference internal" href="#id4">8.11.1.4. 引数</a></li>
-<li><a class="reference internal" href="#id5">8.11.1.5. 返値</a></li>
-<li><a class="reference internal" href="#id6">8.11.1.6. 例</a></li>
+<li><a class="reference internal" href="#">8.11.2. edit_distance</a><ul>
+<li><a class="reference internal" href="#id1">8.11.2.1. 名前</a></li>
+<li><a class="reference internal" href="#id2">8.11.2.2. 書式</a></li>
+<li><a class="reference internal" href="#id3">8.11.2.3. 説明</a></li>
+<li><a class="reference internal" href="#id4">8.11.2.4. 引数</a></li>
+<li><a class="reference internal" href="#id5">8.11.2.5. 返値</a></li>
+<li><a class="reference internal" href="#id6">8.11.2.6. 例</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
-  <p class="topless"><a href="../function.html"
-                        title="previous chapter">8.11. Function</a></p>
+  <p class="topless"><a href="between.html"
+                        title="previous chapter">8.11.1. between</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="geo_distance.html"
-                        title="next chapter">8.11.2. geo_distance</a></p>
+                        title="next chapter">8.11.3. geo_distance</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="../../_sources/reference/functions/edit_distance.txt"
@@ -164,12 +164,12 @@
           <a href="../../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="geo_distance.html" title="8.11.2. geo_distance"
+          <a href="geo_distance.html" title="8.11.3. geo_distance"
              >next</a> |</li>
         <li class="right" >
-          <a href="../function.html" title="8.11. Function"
+          <a href="between.html" title="8.11.1. between"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v3.1.0 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.1.1 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../function.html" >8.11. Function</a> &raquo;</li>
       </ul>