File: groonga-suggest-learner.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (227 lines) | stat: -rw-r--r-- 13,755 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.1.9. groonga-suggest-learner &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="7.2. Output" href="../output.html" />
    <link rel="prev" title="7.1.8. groonga-suggest-httpd" href="groonga-suggest-httpd.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/executables/groonga-suggest-learner.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <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="../output.html" title="7.2. Output"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="groonga-suggest-httpd.html" title="7.1.8. groonga-suggest-httpd"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../executables.html" accesskey="U"><span class="section-number">7.1. </span>Executables</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.1.9. </span>groonga-suggest-learner</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="groonga-suggest-learner">
<h1><span class="section-number">7.1.9. </span>groonga-suggest-learner<a class="headerlink" href="#groonga-suggest-learner" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.1.9.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<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><span class="section-number">7.1.9.2. </span>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga-suggest-learner [options] database_path
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.1.9.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<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><span class="section-number">7.1.9.3.1. </span>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 notranslate"><div class="highlight"><pre><span></span>groonga-suggest-learner testdb/db
</pre></div>
</div>
</div>
<div class="section" id="learning-data-from-log-files">
<h3><span class="section-number">7.1.9.3.2. </span>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 <code class="docutils literal notranslate"><span class="pre">-l</span></code> option.</p>
<p>Here is the sample to load log data under <code class="docutils literal notranslate"><span class="pre">logs</span></code> directory:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga-suggest-learner -l logs testdb/db
</pre></div>
</div>
</div>
</div>
<div class="section" id="options">
<h2><span class="section-number">7.1.9.4. </span>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-r">
<span id="cmdoption-groonga-suggest-learner-receive-endpoint"></span><code class="sig-name descname">-r</code><code class="sig-prename descclassname"> &lt;endpoint&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--receive-endpoint</code><code class="sig-prename descclassname"> &lt;endpoint&gt;</code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-r" title="Permalink to this definition">¶</a></dt>
<dd><p>Uses <code class="docutils literal notranslate"><span class="pre">&lt;endpoint&gt;</span></code> as the receiver endpoint.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-s">
<span id="cmdoption-groonga-suggest-learner-send-endpoint"></span><code class="sig-name descname">-s</code><code class="sig-prename descclassname"> &lt;endpoint&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--send-endpoint</code><code class="sig-prename descclassname"> &lt;endpoint&gt;</code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-s" title="Permalink to this definition">¶</a></dt>
<dd><p>Uses <code class="docutils literal notranslate"><span class="pre">&lt;endpoint&gt;</span></code> as the sender endpoint.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-d">
<span id="cmdoption-groonga-suggest-learner-daemon"></span><code class="sig-name descname">-d</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--daemon</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-d" title="Permalink to this definition">¶</a></dt>
<dd><p>Runs as a daemon.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-l">
<span id="cmdoption-groonga-suggest-learner-log-base-path"></span><code class="sig-name descname">-l</code><code class="sig-prename descclassname"> &lt;directory&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--log-base-path</code><code class="sig-prename descclassname"> &lt;directory&gt;</code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-l" title="Permalink to this definition">¶</a></dt>
<dd><p>Reads logs from <code class="docutils literal notranslate"><span class="pre">&lt;directory&gt;</span></code>.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-log-path">
<code class="sig-name descname">--log-path</code><code class="sig-prename descclassname"> &lt;path&gt;</code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-log-path" title="Permalink to this definition">¶</a></dt>
<dd><p>Outputs log to <code class="docutils literal notranslate"><span class="pre">&lt;path&gt;</span></code>.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-groonga-suggest-learner-log-level">
<code class="sig-name descname">--log-level</code><code class="sig-prename descclassname"> &lt;level&gt;</code><a class="headerlink" href="#cmdoption-groonga-suggest-learner-log-level" title="Permalink to this definition">¶</a></dt>
<dd><p>Uses <code class="docutils literal notranslate"><span class="pre">&lt;level&gt;</span></code> for log level. <code class="docutils literal notranslate"><span class="pre">&lt;level&gt;</span></code> must be between 1 and 9.
Larger level outputs more logs.</p>
</dd></dl>

</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.1.9.5. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>There is only one required parameter.</p>
<div class="section" id="database-path">
<h3><span class="section-number">7.1.9.5.1. </span><code class="docutils literal notranslate"><span class="pre">database_path</span></code><a class="headerlink" href="#database-path" title="Permalink to this headline">¶</a></h3>
<p>Specifies the path to a groonga database.</p>
</div>
</div>
<div class="section" id="related-tables">
<h2><span class="section-number">7.1.9.6. </span>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 <code class="docutils literal notranslate"><span class="pre">query</span></code> as dataset name, following <code class="docutils literal notranslate"><span class="pre">_DATASET</span></code> suffix are replaced. Thus, <code class="docutils literal notranslate"><span class="pre">event_query</span></code> table is used.</p>
<ul class="simple">
<li><p>event_DATASET</p></li>
</ul>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">7.1.9. groonga-suggest-learner</a><ul>
<li><a class="reference internal" href="#summary">7.1.9.1. Summary</a></li>
<li><a class="reference internal" href="#synopsis">7.1.9.2. Synopsis</a></li>
<li><a class="reference internal" href="#usage">7.1.9.3. Usage</a><ul>
<li><a class="reference internal" href="#learning-data-from-groonga-suggest-httpd">7.1.9.3.1. Learning data from groonga-suggest-httpd</a></li>
<li><a class="reference internal" href="#learning-data-from-log-files">7.1.9.3.2. Learning data from log files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#options">7.1.9.4. Options</a></li>
<li><a class="reference internal" href="#parameters">7.1.9.5. Parameters</a><ul>
<li><a class="reference internal" href="#database-path">7.1.9.5.1. <code class="docutils literal notranslate"><span class="pre">database_path</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#related-tables">7.1.9.6. Related tables</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="groonga-suggest-httpd.html"
                        title="previous chapter"><span class="section-number">7.1.8. </span><code class="docutils literal notranslate"><span class="pre">groonga-suggest-httpd</span></code></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../output.html"
                        title="next chapter"><span class="section-number">7.2. </span>Output</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <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="../output.html" title="7.2. Output"
             >next</a> |</li>
        <li class="right" >
          <a href="groonga-suggest-httpd.html" title="7.1.8. groonga-suggest-httpd"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../executables.html" ><span class="section-number">7.1. </span>Executables</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.1.9. </span>groonga-suggest-learner</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>