File: normalizers.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 (241 lines) | stat: -rw-r--r-- 11,749 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
228
229
230
231
232
233
234
235
236
237
238
239
240
241


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.7. Normalizers &#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.7.2.1. NormalizerAuto" href="normalizers/normalizer_auto.html" />
    <link rel="prev" title="7.6.4. Index column" href="columns/index.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/normalizers.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="normalizers/normalizer_auto.html" title="7.7.2.1. NormalizerAuto"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="columns/index.html" title="7.6.4. Index column"
             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" accesskey="U"><span class="section-number">7. </span>Reference manual</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.7. </span>Normalizers</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="normalizers">
<h1><span class="section-number">7.7. </span>Normalizers<a class="headerlink" href="#normalizers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.7.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Groonga has normalizer module that normalizes text. It is used when
tokenizing text and storing table key. For example, <code class="docutils literal notranslate"><span class="pre">A</span></code> and <code class="docutils literal notranslate"><span class="pre">a</span></code>
are processed as the same character after normalization.</p>
<p>Normalizer module can be added as a plugin. You can customize text
normalization by registering your normalizer plugins to Groonga.</p>
<p>A normalizer module is attached to a table. A table can have zero or
one normalizer module. You can attach a normalizer module to a table
by <a class="reference internal" href="commands/table_create.html#table-create-normalizer"><span class="std std-ref">normalizer</span></a> option in
<a class="reference internal" href="commands/table_create.html"><span class="doc">table_create</span></a>.</p>
<p>Here is an example <code class="docutils literal notranslate"><span class="pre">table_create</span></code> that uses <code class="docutils literal notranslate"><span class="pre">NormalizerAuto</span></code>
normalizer module:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Dictionary TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Groonga 2.0.9 or earlier doesn’t have <code class="docutils literal notranslate"><span class="pre">--normalizer</span></code> option in
<code class="docutils literal notranslate"><span class="pre">table_create</span></code>. <code class="docutils literal notranslate"><span class="pre">KEY_NORMALIZE</span></code> flag was used instead.</p>
<p>You can open an old database by Groonga 2.1.0 or later. An old
database means that the database is created by Groonga 2.0.9 or
earlier. But you cannot open the opened old database by Groonga
2.0.9 or earlier. Once you open the old database by Groonga 2.1.0
or later, <code class="docutils literal notranslate"><span class="pre">KEY_NORMALIZE</span></code> flag information in the old database is
converted to normalizer information. So Groonga 2.0.9 or earlier
cannot find <code class="docutils literal notranslate"><span class="pre">KEY_NORMALIZE</span></code> flag information in the opened old
database.</p>
</div>
<p>Keys of a table that has a normalizer module are normalized:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Dictionary
[
{&quot;_key&quot;: &quot;Apple&quot;},
{&quot;_key&quot;: &quot;black&quot;},
{&quot;_key&quot;: &quot;COLOR&quot;}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Dictionary
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;apple&quot;
#       ],
#       [
#         2,
#         &quot;black&quot;
#       ],
#       [
#         3,
#         &quot;color&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">NormalizerAuto</span></code> normalizer normalizes a text as a downcased text.
For example, <code class="docutils literal notranslate"><span class="pre">&quot;Apple&quot;</span></code> is normalized to <code class="docutils literal notranslate"><span class="pre">&quot;apple&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;black&quot;</span></code> is
normalized to <code class="docutils literal notranslate"><span class="pre">&quot;black&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;COLOR&quot;</span></code> is normalized to
<code class="docutils literal notranslate"><span class="pre">&quot;color&quot;</span></code>.</p>
<p>If a table is a lexicon for fulltext search, tokenized tokens are
normalized. Because tokens are stored as table keys. Table keys are
normalized as described above.</p>
</div>
<div class="section" id="built-in-normalizers">
<h2><span class="section-number">7.7.2. </span>Built-in normalizers<a class="headerlink" href="#built-in-normalizers" title="Permalink to this headline">¶</a></h2>
<p>Here is a list of built-in normalizers:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="normalizers/normalizer_auto.html">7.7.2.1. <code class="docutils literal notranslate"><span class="pre">NormalizerAuto</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="normalizers/normalizer_nfkc100.html">7.7.2.2. <code class="docutils literal notranslate"><span class="pre">NormalizerNFKC100</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="normalizers/normalizer_nfkc51.html">7.7.2.3. <code class="docutils literal notranslate"><span class="pre">NormalizerNFKC51</span></code></a></li>
</ul>
</div>
</div>
<div class="section" id="additional-normalizers">
<h2><span class="section-number">7.7.3. </span>Additional normalizers<a class="headerlink" href="#additional-normalizers" title="Permalink to this headline">¶</a></h2>
<p>There are additional normalizers:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="https://github.com/groonga/groonga-normalizer-mysql">groonga-normalizer-mysql</a></p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.7.4. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="commands/table_create.html"><span class="doc">table_create</span></a></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.7. Normalizers</a><ul>
<li><a class="reference internal" href="#summary">7.7.1. Summary</a></li>
<li><a class="reference internal" href="#built-in-normalizers">7.7.2. Built-in normalizers</a></li>
<li><a class="reference internal" href="#additional-normalizers">7.7.3. Additional normalizers</a></li>
<li><a class="reference internal" href="#see-also">7.7.4. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="columns/index.html"
                        title="previous chapter"><span class="section-number">7.6.4. </span>Index column</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="normalizers/normalizer_auto.html"
                        title="next chapter"><span class="section-number">7.7.2.1. </span><code class="docutils literal notranslate"><span class="pre">NormalizerAuto</span></code></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="normalizers/normalizer_auto.html" title="7.7.2.1. NormalizerAuto"
             >next</a> |</li>
        <li class="right" >
          <a href="columns/index.html" title="7.6.4. Index column"
             >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-this"><a href=""><span class="section-number">7.7. </span>Normalizers</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>