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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.3.12. column_list — 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.3.13. column_remove" href="column_remove.html" />
<link rel="prev" title="7.3.11. column_create" href="column_create.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/commands/column_list.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_remove.html" title="7.3.13. column_remove"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="column_create.html" title="7.3.11. column_create"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../command.html" accesskey="U"><span class="section-number">7.3. </span>Command</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.12. </span><code class="docutils literal notranslate"><span class="pre">column_list</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="column-list">
<h1><span class="section-number">7.3.12. </span><code class="docutils literal notranslate"><span class="pre">column_list</span></code><a class="headerlink" href="#column-list" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.12.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">column_list</span></code> command lists columns in a table.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.12.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>This command takes only one required parameter:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column_list table
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.12.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here is a simple example of <code class="docutils literal notranslate"><span class="pre">column_list</span></code> command.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR UInt8
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users tags COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_list Users
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# "id",
# "UInt32"
# ],
# [
# "name",
# "ShortText"
# ],
# [
# "path",
# "ShortText"
# ],
# [
# "type",
# "ShortText"
# ],
# [
# "flags",
# "ShortText"
# ],
# [
# "domain",
# "ShortText"
# ],
# [
# "range",
# "ShortText"
# ],
# [
# "source",
# "ShortText"
# ]
# ],
# [
# 256,
# "_key",
# "",
# "",
# "COLUMN_SCALAR",
# "Users",
# "ShortText",
# []
# ],
# [
# 257,
# "age",
# "/tmp/groonga-databases/commands_column_list.0000101",
# "fix",
# "COLUMN_SCALAR|PERSISTENT",
# "Users",
# "UInt8",
# []
# ],
# [
# 258,
# "tags",
# "/tmp/groonga-databases/commands_column_list.0000102",
# "var",
# "COLUMN_VECTOR|PERSISTENT",
# "Users",
# "ShortText",
# []
# ]
# ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.12.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>This section describes parameters of <code class="docutils literal notranslate"><span class="pre">column_list</span></code>.</p>
<div class="section" id="required-parameters">
<h3><span class="section-number">7.3.12.4.1. </span>Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
<p>All parameters are required.</p>
<div class="section" id="table">
<h4><span class="section-number">7.3.12.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">table</span></code><a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h4>
<p>Specifies the name of table to be listed columns.</p>
</div>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.12.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">column_list</span></code> returns the list of column information in the table:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
HEADER,
[
COLUMN_LIST_HEADER,
COLUMN_INFORMATION1,
COLUMN_INFORMATION2,
...
]
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">HEADER</span></code></p>
<blockquote>
<div><p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> about <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">COLUMN_LIST_HEADER</span></code></p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">COLUMN_LIST_HEADER</span></code> describes about content of each
<code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">COLUMN_LIST_HEADER</span></code> is the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
["id", "UInt32"],
["name", "ShortText"],
["path", "ShortText"],
["type", "ShortText"],
["flags", "ShortText"],
["domain", "ShortText"],
["range", "ShortText"],
["source", "ShortText"]
]
</pre></div>
</div>
<p>It means the following:</p>
<blockquote>
<div><ul class="simple">
<li><p>The first content in <code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code> is <code class="docutils literal notranslate"><span class="pre">id</span></code> value and
the value type is <code class="docutils literal notranslate"><span class="pre">UInt32</span></code>.</p></li>
<li><p>The second content in <code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code> is <code class="docutils literal notranslate"><span class="pre">name</span></code> value and
the value type is <code class="docutils literal notranslate"><span class="pre">ShortText</span></code>.</p></li>
<li><p>The third content ….</p></li>
</ul>
</div></blockquote>
<p>See the following <code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code> description for details.</p>
<p>This field provides meta-data of column information. So this field
will be useful for programs rather than humans.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code></p>
<blockquote>
<div><p>Each <code class="docutils literal notranslate"><span class="pre">COLUMN_INFORMATION</span></code> is the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
ID,
NAME,
PATH,
TYPE,
FLAGS,
DOMAIN,
RANGE,
SOURCES
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">ID</span></code></p>
<blockquote>
<div><p>The column ID in the Groonga database. Normally, you don’t care
about it.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">NAME</span></code></p>
<blockquote>
<div><p>The column name.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">PATH</span></code></p>
<blockquote>
<div><p>The path for storing column data.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">TYPE</span></code></p>
<blockquote>
<div><p>The type of the column. It is one of the followings:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Value</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fix</span></code></p></td>
<td><p>The column is a fixed size column. Scalar column that its
type is fixed size type is fixed size column.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">var</span></code></p></td>
<td><p>The column is a variable size column. Vector column or
scalar column that its type is variable size type are
variable size column.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">index</span></code></p></td>
<td><p>The column is an index column.</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">FLAGS</span></code></p>
<blockquote>
<div><p>The flags of the column. Each flag is separated by <code class="docutils literal notranslate"><span class="pre">|</span></code> like
<code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR|WITH_WEIGHT</span></code>. <code class="docutils literal notranslate"><span class="pre">FLAGS</span></code> must include one of
<code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code>, <code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code> or <code class="docutils literal notranslate"><span class="pre">COLUMN_INDEX</span></code>. Other
flags are optional.</p>
<p>Here is the available flags:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Flag</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code></p></td>
<td><p>The column is a scalar column.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code></p></td>
<td><p>The column is a vector column.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLUMN_INDEX</span></code></p></td>
<td><p>The column is an index column.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">WITH_WEIGHT</span></code></p></td>
<td><p>The column can have weight. <code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code> and <code class="docutils literal notranslate"><span class="pre">COLUMN_INDEX</span></code>
may have it. <code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code> doesn’t have it.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">WITH_SECTION</span></code></p></td>
<td><p>The column can have section information. <code class="docutils literal notranslate"><span class="pre">COLUMN_INDEX</span></code>
may have it. <code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code> and <code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code> don’t
have it.</p>
<p>Multiple column index has it.</p>
</td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">WITH_POSITION</span></code></p></td>
<td><p>The column can have position information. <code class="docutils literal notranslate"><span class="pre">COLUMN_INDEX</span></code>
may have it. <code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code> and <code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code> don’t
have it.</p>
<p>Full text search index must has it.</p>
</td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PERSISTENT</span></code></p></td>
<td><p>The column is a persistent column. It means that the column
isn’t a <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a>.</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">DOMAIN</span></code></p>
<blockquote>
<div><p>The name of table that has the column.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">RANGE</span></code></p>
<blockquote>
<div><p>The value type name of the column. It is a type name or a table
name.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">SOURCES</span></code></p>
<blockquote>
<div><p>An array of the source column names of the index. If the index
column is multiple column index, the array has two or more
source column names.</p>
<p>It is always an empty array for <code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code> and
<code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code>.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.3.12.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="column_create.html"><span class="doc">column_create</span></a></p></li>
<li><p><a class="reference internal" href="../column.html"><span class="doc">Column</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.3.12. <code class="docutils literal notranslate"><span class="pre">column_list</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.12.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.12.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.12.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.3.12.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameters">7.3.12.4.1. Required parameters</a><ul>
<li><a class="reference internal" href="#table">7.3.12.4.1.1. <code class="docutils literal notranslate"><span class="pre">table</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.12.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">7.3.12.6. See also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="column_create.html"
title="previous chapter"><span class="section-number">7.3.11. </span><code class="docutils literal notranslate"><span class="pre">column_create</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="column_remove.html"
title="next chapter"><span class="section-number">7.3.13. </span><code class="docutils literal notranslate"><span class="pre">column_remove</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="column_remove.html" title="7.3.13. column_remove"
>next</a> |</li>
<li class="right" >
<a href="column_create.html" title="7.3.11. column_create"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../command.html" ><span class="section-number">7.3. </span>Command</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.12. </span><code class="docutils literal notranslate"><span class="pre">column_list</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
