RubyGems - rroonga - Versions diffs - 4.0.1-x64-mingw32 → 4.0.2-x64-mingw32 - Mend

rroonga 4.0.1-x64-mingw32 → 4.0.2-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 (477) hide show

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-benchmark.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.3. groonga-benchmark &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.3. groonga-benchmark &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.1.4. groonga-httpd" href="groonga-httpd.html" />
     <link rel="prev" title="8.1.2. groonga command" href="groonga.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga.html" title="8.1.2. groonga command"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -202,7 +202,7 @@
 </div>
 <div class="section" id="id9">
 <h3>8.1.3.7.2. コマンドファイル<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
-<p>コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては <tt class="xref doc docutils literal"><span class="pre">/reference/commands</span></tt> を参照してください。</p>
+<p>コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては <a class="reference internal" href="../command.html"><em>Command</em></a> を参照してください。</p>
 </div>
 <div class="section" id="id10">
 <h3>8.1.3.7.3. サンプル<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
@@ -400,7 +400,7 @@ ency&quot;: 831495, &quot;self&quot;: 762519, &quot;qps&quot;: 1967.164097, &quo
         <li class="right" >
           <a href="groonga.html" title="8.1.2. groonga command"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-httpd.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.4. groonga-httpd &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.4. groonga-httpd &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.1.5. groonga HTTPサーバー" href="groonga-server-http.html" />
     <link rel="prev" title="8.1.3. groonga-benchmark" href="groonga-benchmark.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga-benchmark.html" title="8.1.3. groonga-benchmark"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -627,7 +627,7 @@ Expressions). For the list of standard HTTP modules, see
         <li class="right" >
           <a href="groonga-benchmark.html" title="8.1.3. groonga-benchmark"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-server-http.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.5. groonga HTTPサーバー &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.5. groonga HTTPサーバー &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.1.6. groonga-suggest-create-dataset" href="groonga-suggest-create-dataset.html" />
     <link rel="prev" title="8.1.4. groonga-httpd" href="groonga-httpd.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga-httpd.html" title="8.1.4. groonga-httpd"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -173,7 +173,7 @@
         <li class="right" >
           <a href="groonga-httpd.html" title="8.1.4. groonga-httpd"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-create-dataset.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.6. groonga-suggest-create-dataset &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.6. groonga-suggest-create-dataset &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.1.7. groonga-suggest-httpd" href="groonga-suggest-httpd.html" />
     <link rel="prev" title="8.1.5. groonga HTTPサーバー" href="groonga-server-http.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga-server-http.html" title="8.1.5. groonga HTTPサーバー"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -186,7 +186,7 @@
         <li class="right" >
           <a href="groonga-server-http.html" title="8.1.5. groonga HTTPサーバー"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-httpd.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.7. groonga-suggest-httpd &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.7. groonga-suggest-httpd &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.1.8. groonga-suggest-learner" href="groonga-suggest-learner.html" />
     <link rel="prev" title="8.1.6. groonga-suggest-create-dataset" href="groonga-suggest-create-dataset.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga-suggest-create-dataset.html" title="8.1.6. groonga-suggest-create-dataset"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -89,15 +89,38 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 <div class="section" id="set-up">
 <h3>8.1.7.3.1. Set up<a class="headerlink" href="#set-up" title="Permalink to this headline">¶</a></h3>
 <p>First you need to set up database for suggestion.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-create-dataset /tmp/groonga-databases/groonga-suggest-httpd query
+</pre></div>
+</div>
 </div>
 <div class="section" id="launch-groonga-suggest-httpd">
 <h3>8.1.7.3.2. Launch groonga-suggest-httpd<a class="headerlink" href="#launch-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3>
 <p>Execute groonga-suggest-httpd command:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-httpd /tmp/groonga-databases/groonga-suggest-httpd
+</pre></div>
+</div>
 <p>After executing above command, groonga-suggest-httpd accepts HTTP request on 8080 port.</p>
+<p>If you just want to save requests into log file, use <tt class="docutils literal"><span class="pre">-l</span></tt> option.</p>
+<p>Here is the example to save log files under <tt class="docutils literal"><span class="pre">logs</span></tt> directory with <tt class="docutils literal"><span class="pre">log</span></tt> prefix for each file.:</p>
+<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-httpd -l logs/log /tmp/groonga-databases/groonga-suggest-httpd
+</pre></div>
+</div>
+<p>Under <tt class="docutils literal"><span class="pre">logs</span></tt> directory, log files such as <tt class="docutils literal"><span class="pre">logYYYYmmddHHMMSS-00</span></tt> are created.</p>
 </div>
 <div class="section" id="request-to-groonga-suggest-httpd">
 <h3>8.1.7.3.3. Request to groonga-suggest-httpd<a class="headerlink" href="#request-to-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3>
-<p>TODO</p>
+<p>Here is the sample requests to learn <tt class="docutils literal"><span class="pre">groonga</span></tt> for <tt class="docutils literal"><span class="pre">query</span></tt> dataset:</p>
+<div class="highlight-none"><div class="highlight"><pre>% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=92619&amp;t=complete&amp;q=g&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=93850&amp;t=complete&amp;q=gr&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=94293&amp;t=complete&amp;q=gro&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=94734&amp;t=complete&amp;q=groo&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=95147&amp;t=complete&amp;q=grooon&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=95553&amp;t=complete&amp;q=groonga&#39;
+% curl &#39;http://localhost:8080/?i=127.0.0.1&amp;l=query&amp;s=95959&amp;t=submit&amp;q=groonga
+</pre></div>
+</div>
 </div>
 </div>
 <div class="section" id="options">
@@ -111,7 +134,9 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 <dl class="cmdoption">
 <dt id="cmdoption-t">
 <span id="cmdoption--n-threads"></span><tt class="descname">-t</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--n-threads</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-t" title="Permalink to this definition">¶</a></dt>
-<dd><p>Specify number of threads. The default value is 8.</p>
+<dd><p>Specify number of threads. The default value is 8.
+This option accepts 128 as the max value, but use the number of CPU cores for
+performance.</p>
 </dd></dl>
 <dl class="cmdoption">
@@ -152,7 +177,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 </div>
 <div class="section" id="command-line-parameters">
-<h2>8.1.7.5. Command line Parameters<a class="headerlink" href="#command-line-parameters" title="Permalink to this headline">¶</a></h2>
+<h2>8.1.7.5. Command line parameters<a class="headerlink" href="#command-line-parameters" title="Permalink to this headline">¶</a></h2>
 <p>There is one required parameter - <tt class="docutils literal"><span class="pre">database_path</span></tt>.</p>
 <div class="section" id="database-path">
 <h3>8.1.7.5.1. <tt class="docutils literal"><span class="pre">database_path</span></tt><a class="headerlink" href="#database-path" title="Permalink to this headline">¶</a></h3>
@@ -160,7 +185,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 </div>
 </div>
 <div class="section" id="get-parameters">
-<h2>8.1.7.6. GET Parameters<a class="headerlink" href="#get-parameters" title="Permalink to this headline">¶</a></h2>
+<h2>8.1.7.6. GET parameters<a class="headerlink" href="#get-parameters" title="Permalink to this headline">¶</a></h2>
 <p>groonga-suggest-httpd accepts following GET parameters.</p>
 <p>There are required parameters which depends on type of query.</p>
 <div class="section" id="required-parameters">
@@ -183,7 +208,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 <td>&nbsp;</td>
 </tr>
 <tr class="row-odd"><td>t</td>
-<td>The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by '|'. Note that 'submit' is invalid value when you specify multiple type of query.</td>
+<td>The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by <tt class="docutils literal"><span class="pre">|</span></tt>. Note that <tt class="docutils literal"><span class="pre">submit</span></tt> is invalid value when you specify multiple type of query.</td>
 <td>&nbsp;</td>
 </tr>
 </tbody>
@@ -206,15 +231,15 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 <tbody valign="top">
 <tr class="row-even"><td>s</td>
 <td>Elapsed time from 0:00 January 1, 1970</td>
-<td>Note that you need specify the value of 's' in milliseconds</td>
+<td>Note that you need specify the value of <tt class="docutils literal"><span class="pre">s</span></tt> in milliseconds</td>
 </tr>
 <tr class="row-odd"><td>i</td>
 <td>Unique ID to distinct user</td>
 <td>Use session ID or IP address for example</td>
 </tr>
 <tr class="row-even"><td>l</td>
-<td>Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by '|'</td>
-<td>Note that dataset name must be matched to following regular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'</td>
+<td>Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by <tt class="docutils literal"><span class="pre">|</span></tt></td>
+<td>Note that dataset name must be matched to following regular expression <tt class="docutils literal"><span class="pre">[A-Za-z</span> <span class="pre">][A-Za-z0-9</span> <span class="pre">]{0,15}</span></tt></td>
 </tr>
 </tbody>
 </table>
@@ -258,7 +283,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 <tbody valign="top">
 <tr class="row-even"><td>callback</td>
 <td>Specify the name of function if you prefer JSONP as response format</td>
-<td>The name of function must be matched to reqular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'</td>
+<td>The name of function must be matched to reqular expression <tt class="docutils literal"><span class="pre">[A-Za-z</span> <span class="pre">][A-Za-z0-9</span> <span class="pre">]{0,15}</span></tt></td>
 </tr>
 </tbody>
 </table>
@@ -277,13 +302,13 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 </div>
 <p><tt class="docutils literal"><span class="pre">TYPE</span></tt></p>
 <blockquote>
-<div>'complete', 'correct' or 'suggest'.</div></blockquote>
+<div>One of <tt class="docutils literal"><span class="pre">complete</span></tt>, <tt class="docutils literal"><span class="pre">correct</span></tt> and <tt class="docutils literal"><span class="pre">suggest</span></tt>.</div></blockquote>
 <p><tt class="docutils literal"><span class="pre">CANDIDATE_N</span></tt></p>
 <blockquote>
 <div>The string of candidate (UTF-8).</div></blockquote>
 <p><tt class="docutils literal"><span class="pre">SCORE_N</span></tt></p>
 <blockquote>
-<div>The number of score.</div></blockquote>
+<div>The score.</div></blockquote>
 </div>
 </div>
@@ -305,11 +330,11 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
 </ul>
 </li>
 <li><a class="reference internal" href="#options">8.1.7.4. Options</a></li>
-<li><a class="reference internal" href="#command-line-parameters">8.1.7.5. Command line Parameters</a><ul>
+<li><a class="reference internal" href="#command-line-parameters">8.1.7.5. Command line parameters</a><ul>
 <li><a class="reference internal" href="#database-path">8.1.7.5.1. <tt class="docutils literal"><span class="pre">database_path</span></tt></a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#get-parameters">8.1.7.6. GET Parameters</a><ul>
+<li><a class="reference internal" href="#get-parameters">8.1.7.6. GET parameters</a><ul>
 <li><a class="reference internal" href="#required-parameters">8.1.7.6.1. Required parameters</a></li>
 <li><a class="reference internal" href="#required-parameters-for-learning">8.1.7.6.2. Required parameters for learning</a></li>
 <li><a class="reference internal" href="#required-parameters-for-suggestion">8.1.7.6.3. Required parameters for suggestion</a></li>
@@ -363,7 +388,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali
         <li class="right" >
           <a href="groonga-suggest-create-dataset.html" title="8.1.6. groonga-suggest-create-dataset"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-learner.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.1.8. groonga-suggest-learner &mdash; Groonga v4.0.1 documentation</title>
+    <title>8.1.8. groonga-suggest-learner &mdash; Groonga v4.0.1-127-g9422d50 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:     '4.0.1',
+        VERSION:     '4.0.1-127-g9422d50',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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 v4.0.1 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v4.0.1-127-g9422d50 documentation" href="../../index.html" />
     <link rel="up" title="8.1. 実行ファイル" href="../executables.html" />
     <link rel="next" title="8.2. Output" href="../output.html" />
     <link rel="prev" title="8.1.7. groonga-suggest-httpd" href="groonga-suggest-httpd.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="groonga-suggest-httpd.html" title="8.1.7. groonga-suggest-httpd"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" accesskey="U">8.1. 実行ファイル</a> &raquo;</li>
       </ul>
@@ -75,7 +75,9 @@
 <h1>8.1.8. groonga-suggest-learner<a class="headerlink" href="#groonga-suggest-learner" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
 <h2>8.1.8.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<p>groonga-suggest-learner is a program to learn suggest result from data which derived from groonga-suggest-httpd.
+Usually, it is used with groonga-suggest-httpd, but It is allowed to launch standalone.
+In such a case, groonga-suggest-learner loads data from log directory.</p>
 </div>
 <div class="section" id="synopsis">
 <h2>8.1.8.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
@@ -85,28 +87,51 @@
 </div>
 <div class="section" id="usage">
 <h2>8.1.8.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<p>groonga-suggest-leaner supports the two way of learning data.
+One is learning data from groonga-suggest-httpd, the other is
+learning data from already existing log files.</p>
+<div class="section" id="learning-data-from-groonga-suggest-httpd">
+<h3>8.1.8.3.1. Learning data from groonga-suggest-httpd<a class="headerlink" href="#learning-data-from-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3>
+<p>Execute groonga-suggest-learner.:</p>
+<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-learner testdb/db
+</pre></div>
+</div>
+</div>
+<div class="section" id="learning-data-from-log-files">
+<h3>8.1.8.3.2. Learning data from log files<a class="headerlink" href="#learning-data-from-log-files" title="Permalink to this headline">¶</a></h3>
+<p>Execute groonga-suggest-learner with <tt class="docutils literal"><span class="pre">-l</span></tt> option.</p>
+<p>Here is the sample to load log data under <tt class="docutils literal"><span class="pre">logs</span></tt> directory:</p>
+<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-learner -l logs testdb/db
+</pre></div>
+</div>
+</div>
 </div>
 <div class="section" id="options">
 <h2>8.1.8.4. Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
 <dl class="cmdoption">
 <dt id="cmdoption-r">
-<span id="cmdoption--receive-endpoint"></span><tt class="descname">-r</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--receive-endpoint</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">-r</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition">¶</a></dt>
 <dd><p>Specify endpoint for receiver.</p>
 </dd></dl>
 <dl class="cmdoption">
 <dt id="cmdoption-s">
-<span id="cmdoption--send-endpoint"></span><tt class="descname">-s</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--send-endpoint</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">-s</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
 <dd><p>Specify endpoint for sender.</p>
 </dd></dl>
 <dl class="cmdoption">
 <dt id="cmdoption-d">
-<span id="cmdoption--daemon"></span><tt class="descname">-d</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--daemon</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">-d</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition">¶</a></dt>
 <dd><p>Specify this option to daemonize.</p>
 </dd></dl>
+<dl class="cmdoption">
+<dt id="cmdoption-l">
+<tt class="descname">-l</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-l" title="Permalink to this definition">¶</a></dt>
+<dd><p>Specify log directory.</p>
+</dd></dl>
 </div>
 <div class="section" id="parameters">
 <h2>8.1.8.5. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
@@ -116,6 +141,13 @@
 <p>Specifies the path to a groonga database.</p>
 </div>
 </div>
+<div class="section" id="related-tables">
+<h2>8.1.8.6. Related tables<a class="headerlink" href="#related-tables" title="Permalink to this headline">¶</a></h2>
+<p>Here is the list of table which learned data is stored. If you specify <tt class="docutils literal"><span class="pre">query</span></tt> as dataset name, following <tt class="docutils literal"><span class="pre">_DATASET</span></tt> suffix are replaced. Thus, <tt class="docutils literal"><span class="pre">event_query</span></tt> table is used.</p>
+<ul class="simple">
+<li>event_DATASET</li>
+</ul>
+</div>
 </div>
@@ -129,12 +161,17 @@
 <li><a class="reference internal" href="#">8.1.8. groonga-suggest-learner</a><ul>
 <li><a class="reference internal" href="#summary">8.1.8.1. Summary</a></li>
 <li><a class="reference internal" href="#synopsis">8.1.8.2. Synopsis</a></li>
-<li><a class="reference internal" href="#usage">8.1.8.3. Usage</a></li>
+<li><a class="reference internal" href="#usage">8.1.8.3. Usage</a><ul>
+<li><a class="reference internal" href="#learning-data-from-groonga-suggest-httpd">8.1.8.3.1. Learning data from groonga-suggest-httpd</a></li>
+<li><a class="reference internal" href="#learning-data-from-log-files">8.1.8.3.2. Learning data from log files</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#options">8.1.8.4. Options</a></li>
 <li><a class="reference internal" href="#parameters">8.1.8.5. Parameters</a><ul>
 <li><a class="reference internal" href="#database-path">8.1.8.5.1. <tt class="docutils literal"><span class="pre">database_path</span></tt></a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#related-tables">8.1.8.6. Related tables</a></li>
 </ul>
 </li>
 </ul>
@@ -181,7 +218,7 @@
         <li class="right" >
           <a href="groonga-suggest-httpd.html" title="8.1.7. groonga-suggest-httpd"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v4.0.1 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v4.0.1-127-g9422d50 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. Reference manual</a> &raquo;</li>
           <li><a href="../executables.html" >8.1. 実行ファイル</a> &raquo;</li>
       </ul>