File: tables.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 (353 lines) | stat: -rw-r--r-- 17,821 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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.5. Tables &#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.6. Column" href="column.html" />
    <link rel="prev" title="7.4. Data types" href="types.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/tables.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="column.html" title="7.6. Column"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="types.html" title="7.4. Data types"
             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.5. </span>Tables</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="tables">
<h1><span class="section-number">7.5. </span>Tables<a class="headerlink" href="#tables" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.5.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Table in Groonga manages relation between ID and key. Groonga provides
four table types. They are <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code>, <code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code>,
<code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code> and <code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code>.</p>
<p>All tables except <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> provides both fast ID search by key
and fast key search by ID. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> doesn’t support
key. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> only manages ID. So <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> doesn’t
provides ID search and key search.</p>
</div>
<div class="section" id="characteristics">
<h2><span class="section-number">7.5.2. </span>Characteristics<a class="headerlink" href="#characteristics" title="Permalink to this headline">¶</a></h2>
<p>Here is a chracteristic table of all tables in Groonga. (<code class="docutils literal notranslate"><span class="pre">TABLE_</span></code>
prefix is omitted in the table.)</p>
<table class="docutils align-default" id="id5">
<caption><span class="caption-text">Characteristics of all tables</span><a class="headerlink" href="#id5" title="Permalink to this table">¶</a></caption>
<colgroup>
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Item</p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">NO_KEY</span></code></p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">HASH_KEY</span></code></p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">PAT_KEY</span></code></p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">DAT_KEY</span></code></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Data structure</p></td>
<td><p>Array</p></td>
<td><p>Hash table</p></td>
<td><p>Patricia trie</p></td>
<td><p>Double array trie</p></td>
</tr>
<tr class="row-odd"><td><p>ID support</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-even"><td><p>Key support</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-odd"><td><p>Value support</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>x</p></td>
</tr>
<tr class="row-even"><td><p>Key -&gt; ID speed</p>
<ul class="simple">
<li><p>o: fast</p></li>
<li><p>x: slow</p></li>
</ul>
</td>
<td><p>-</p></td>
<td><p>oo</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-odd"><td><p>Update speed</p>
<ul class="simple">
<li><p>o: fast</p></li>
<li><p>x: slow</p></li>
</ul>
</td>
<td><p>ooo</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
<td><p>x</p></td>
</tr>
<tr class="row-even"><td><p>Size</p>
<ul class="simple">
<li><p>o: small</p></li>
<li><p>x: large</p></li>
</ul>
</td>
<td><p>ooo</p></td>
<td><p>o</p></td>
<td><p>oo</p></td>
<td><p>x</p></td>
</tr>
<tr class="row-odd"><td><p>Key update</p></td>
<td><p>-</p></td>
<td><p>x</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-even"><td><p>Common prefix search</p></td>
<td><p>-</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-odd"><td><p>Predictive search</p></td>
<td><p>-</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-even"><td><p>Range search</p></td>
<td><p>-</p></td>
<td><p>x</p></td>
<td><p>o</p></td>
<td><p>o</p></td>
</tr>
<tr class="row-odd"><td><p>The maximum one key size</p></td>
<td><p>-</p></td>
<td><p>4KiB</p></td>
<td><p>4KiB</p></td>
<td><p>4KiB</p></td>
</tr>
<tr class="row-even"><td><p>The maximum total size of keys</p></td>
<td><p>-</p></td>
<td><p>4GiB or 1TiB (by specifying <code class="docutils literal notranslate"><span class="pre">KEY_LARGE</span></code> flag to
<a class="reference internal" href="commands/table_create.html#table-create-flags"><span class="std std-ref">flags</span></a>)</p></td>
<td><p>4GiB</p></td>
<td><p>4GiB</p></td>
</tr>
<tr class="row-odd"><td><p>The maximum number of records</p></td>
<td><p>1,073,741,815 (2 <sup>30</sup> - 9)</p></td>
<td><p>536,870,912 (2 <sup>29</sup>)</p></td>
<td><p>1,073,741,823 (2 <sup>30</sup> - 1)</p></td>
<td><p>268,435,455 (2 <sup>28</sup> - 1)</p></td>
</tr>
</tbody>
</table>
<div class="section" id="table-no-key">
<span id="id1"></span><h3><span class="section-number">7.5.2.1. </span><code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code><a class="headerlink" href="#table-no-key" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> is very fast and very small but it doesn’t support
key. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> is a only table that doesn’t support key.</p>
<p>You cannot use <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> for lexicon for fulltext search
because lexicon stores tokens as key. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> is useful for
no key records such as log.</p>
</div>
<div class="section" id="table-hash-key">
<span id="id2"></span><h3><span class="section-number">7.5.2.2. </span><code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code><a class="headerlink" href="#table-hash-key" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code> is fast but it doesn’t support advanced search
functions such as common prefix search and predictive search.</p>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code> is useful for index for exact search such as tag
search.</p>
</div>
<div class="section" id="table-pat-key">
<span id="id3"></span><h3><span class="section-number">7.5.2.3. </span><code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code><a class="headerlink" href="#table-pat-key" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code> is small and supports advanced search functions.</p>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code> is useful for lexicon for fulltext search and
index for range search.</p>
</div>
<div class="section" id="table-dat-key">
<span id="id4"></span><h3><span class="section-number">7.5.2.4. </span><code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code><a class="headerlink" href="#table-dat-key" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code> is fast and supports key update but it is large. It
is not suitable for storing many records. <code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code> is a only
table that supports key update.</p>
<p><code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code> is used in Groonga database. Groonga database needs
to convert object name such as <code class="docutils literal notranslate"><span class="pre">ShortText</span></code>, <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> and
table names to object ID. And Groonga database needs to rename object
name. Those features are implemented by <code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code>. The number
of objects is small. So large data size demerit of <code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code>
can be ignored.</p>
</div>
</div>
<div class="section" id="record-id">
<h2><span class="section-number">7.5.3. </span>Record ID<a class="headerlink" href="#record-id" title="Permalink to this headline">¶</a></h2>
<p>Record ID is assigned automatically. You cannot assign record ID.</p>
<p>Record ID of deleted record may be reused.</p>
<p>Valid record ID range is between 1 and 1073741823. (1 and 1073741823
are valid IDs.)</p>
</div>
<div class="section" id="persistent-table-and-temporary-table">
<h2><span class="section-number">7.5.4. </span>Persistent table and temporary table<a class="headerlink" href="#persistent-table-and-temporary-table" title="Permalink to this headline">¶</a></h2>
<p>Table is persistent table or temporary table.</p>
<div class="section" id="persistent-table">
<h3><span class="section-number">7.5.4.1. </span>Persistent table<a class="headerlink" href="#persistent-table" title="Permalink to this headline">¶</a></h3>
<p>Persistent table is named and registered to database. Records in
persistent table aren’t deleted after closing table or
database.</p>
<p>Persistent table can be created by
<a class="reference internal" href="commands/table_create.html"><span class="doc">table_create</span></a> command.</p>
</div>
<div class="section" id="temporary-table">
<h3><span class="section-number">7.5.4.2. </span>Temporary table<a class="headerlink" href="#temporary-table" title="Permalink to this headline">¶</a></h3>
<p>Temporary table is anonymous. Records in temporary table are deleted
after closing table. Temporary table is used to store search result,
sort result, group (drilldown) result and so on. <code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code> is
used for search result and group result. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code> is used for
sort result.</p>
</div>
</div>
<div class="section" id="limitations">
<h2><span class="section-number">7.5.5. </span>Limitations<a class="headerlink" href="#limitations" title="Permalink to this headline">¶</a></h2>
<p>The max number of records is 268435455. You cannot add 268435456 or
more records in a table.</p>
<p>The max number of a key size is 4096byte. You cannot use 4097byte or
larger key. You can use column instead of key for 4097byte or larger
size data. <code class="docutils literal notranslate"><span class="pre">Text</span></code> and <code class="docutils literal notranslate"><span class="pre">LargeText</span></code> types supports 4097byte or
larger size data.</p>
<p>The max number of total key size is 4GiB. You need to split a table,
split a database (sharding) or reduce each key size to handle 4GiB or
more larger total key size.</p>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.5.6. </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.5. Tables</a><ul>
<li><a class="reference internal" href="#summary">7.5.1. Summary</a></li>
<li><a class="reference internal" href="#characteristics">7.5.2. Characteristics</a><ul>
<li><a class="reference internal" href="#table-no-key">7.5.2.1. <code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code></a></li>
<li><a class="reference internal" href="#table-hash-key">7.5.2.2. <code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code></a></li>
<li><a class="reference internal" href="#table-pat-key">7.5.2.3. <code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code></a></li>
<li><a class="reference internal" href="#table-dat-key">7.5.2.4. <code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#record-id">7.5.3. Record ID</a></li>
<li><a class="reference internal" href="#persistent-table-and-temporary-table">7.5.4. Persistent table and temporary table</a><ul>
<li><a class="reference internal" href="#persistent-table">7.5.4.1. Persistent table</a></li>
<li><a class="reference internal" href="#temporary-table">7.5.4.2. Temporary table</a></li>
</ul>
</li>
<li><a class="reference internal" href="#limitations">7.5.5. Limitations</a></li>
<li><a class="reference internal" href="#see-also">7.5.6. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="types.html"
                        title="previous chapter"><span class="section-number">7.4. </span>Data types</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="column.html"
                        title="next chapter"><span class="section-number">7.6. </span>Column</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="column.html" title="7.6. Column"
             >next</a> |</li>
        <li class="right" >
          <a href="types.html" title="7.4. Data types"
             >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.5. </span>Tables</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>