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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.3.2. Output format — 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.3. Pretty print" href="pretty_print.html" />
<link rel="prev" title="7.3.1. Command version" href="command_version.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/command/output_format.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="pretty_print.html" title="7.3.3. Pretty print"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="command_version.html" title="7.3.1. Command version"
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.2. </span>Output format</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="output-format">
<h1><span class="section-number">7.3.2. </span>Output format<a class="headerlink" href="#output-format" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.2.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Commands output their result as JSON, MessagePack, XML or TSV format.</p>
<p>JSON and MessagePack output have the same structure. XML and TSV are
their original structure.</p>
<p>JSON or MessagePack is recommend format. XML is useful for visual
result check. TSV is just for special use. Normally you doesn’t need
to use TSV.</p>
</div>
<div class="section" id="json-and-messagepack">
<h2><span class="section-number">7.3.2.2. </span>JSON and MessagePack<a class="headerlink" href="#json-and-messagepack" title="Permalink to this headline">¶</a></h2>
<p>This secsion describes the structure of command result on JSON and
MessagePack format. JSON is used to show structure because MessagePack
is binary format. Binary format isn’t proper for documenataion.</p>
<p>JSON and MessagePack uses the following structure:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[HEADER, BODY]
</pre></div>
</div>
<p>For example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
[
0,
1337566253.89858,
0.000355720520019531
],
[
[
[
1
],
[
[
"_id",
"UInt32"
],
[
"_key",
"ShortText"
],
[
"content",
"Text"
],
[
"n_likes",
"UInt32"
]
],
[
2,
"Groonga",
"I started to use groonga. It's very fast!",
10
]
]
]
]
</pre></div>
</div>
<p>In the example, the following part is <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
0,
1337566253.89858,
0.000355720520019531
]
</pre></div>
</div>
<p>The following part is <code class="docutils literal notranslate"><span class="pre">BODY</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
[
[
1
],
[
[
"_id",
"UInt32"
],
[
"_key",
"ShortText"
],
[
"content",
"Text"
],
[
"n_likes",
"UInt32"
]
],
[
2,
"Groonga",
"I started to use groonga. It's very fast!",
10
]
]
]
</pre></div>
</div>
<div class="section" id="header">
<h3><span class="section-number">7.3.2.2.1. </span><code class="docutils literal notranslate"><span class="pre">HEADER</span></code><a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">HEADER</span></code> is an array. The content of <code class="docutils literal notranslate"><span class="pre">HEADER</span></code> has some patterns.</p>
<div class="section" id="success-case">
<h4><span class="section-number">7.3.2.2.1.1. </span>Success case<a class="headerlink" href="#success-case" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">HEADER</span></code> has three elements on success:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME]
</pre></div>
</div>
<p>The first element is always <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></code> is the number of seconds
since 1970-01-01 00:00:00 UTC when the command is started
processing. <code class="docutils literal notranslate"><span class="pre">ELAPSED_TIME</span></code> is the elapsed time for processing the
command in seconds. Both <code class="docutils literal notranslate"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></code> and
<code class="docutils literal notranslate"><span class="pre">ELAPSED_TIME</span></code> are float value. The precision of them are
nanosecond.</p>
</div>
<div class="section" id="error-case">
<h4><span class="section-number">7.3.2.2.1.2. </span>Error case<a class="headerlink" href="#error-case" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">HEADER</span></code> has four or five elements on error:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
RETURN_CODE,
UNIX_TIME_WHEN_COMMAND_IS_STARTED,
ELAPSED_TIME,
ERROR_MESSAGE,
ERROR_LOCATION
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">ERROR_LOCATION</span></code> may not be included in <code class="docutils literal notranslate"><span class="pre">HEADER</span></code> but other four
elements are always included.</p>
<p><code class="docutils literal notranslate"><span class="pre">RETURN_CODE</span></code> is non 0 value. See <a class="reference internal" href="return_code.html"><span class="doc">Return code</span></a> about available
return codes.</p>
<p><code class="docutils literal notranslate"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></code> and <code class="docutils literal notranslate"><span class="pre">ELAPSED_TIME</span></code> are the
same as success case.</p>
<p><code class="docutils literal notranslate"><span class="pre">ERROR_MESSAGE</span></code> is an error message in string.</p>
<p><code class="docutils literal notranslate"><span class="pre">ERROR_LOCATION</span></code> is optional. If error location is collected,
<code class="docutils literal notranslate"><span class="pre">ERROR_LOCATION</span></code> is included. <code class="docutils literal notranslate"><span class="pre">ERROR_LOCATION</span></code> is an
array. <code class="docutils literal notranslate"><span class="pre">ERROR_LOCATION</span></code> has one ore two elements:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
LOCATION_IN_GROONGA,
LOCATION_IN_INPUT
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">LOCATION_IN_GROONGA</span></code> is the source location that error is occurred
in groonga. It is useful for groonga developers but not useful for
users. <code class="docutils literal notranslate"><span class="pre">LOCATION_IN_GROONGA</span></code> is an array. <code class="docutils literal notranslate"><span class="pre">LOCATION_IN_GROONGA</span></code> has
three elements:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
FUNCTION_NAME,
SOURCE_FILE_NAME,
LINE_NUMBER
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">FUNCTION_NAME</span></code> is the name of function that error is occurred.</p>
<p><code class="docutils literal notranslate"><span class="pre">SOURCE_FILE_NAME</span></code> is the name of groonga’s source file that error is
occurred.</p>
<p><code class="docutils literal notranslate"><span class="pre">LINE_NUMBER</span></code> is the line number of <code class="docutils literal notranslate"><span class="pre">SOURCE_FILE_NAME</span></code> that error
is occurred.</p>
<p><code class="docutils literal notranslate"><span class="pre">LOCATION_IN_INPUT</span></code> is optional. <code class="docutils literal notranslate"><span class="pre">LOCATION_IN_INPUT</span></code> is included
when the location that error is occurred in input file is
collected. Input file can be specified by <code class="docutils literal notranslate"><span class="pre">--file</span></code> command line
option for <code class="docutils literal notranslate"><span class="pre">groonga</span></code> command. <code class="docutils literal notranslate"><span class="pre">LOCATION_IN_GROONGA</span></code> is an
array. <code class="docutils literal notranslate"><span class="pre">LOCATION_IN_GROONGA</span></code> has three elements:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
INPUT_FILE_NAME,
LINE_NUMBER,
LINE_CONTENT
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">INPUT_FILE_NAME</span></code> is the input file name that error is occurred.</p>
<p><code class="docutils literal notranslate"><span class="pre">LINE_NUMBER</span></code> is the line number of <code class="docutils literal notranslate"><span class="pre">INPUT_FILE_NAME</span></code> that error
is occurred.</p>
<p><code class="docutils literal notranslate"><span class="pre">LINE_CONTENT</span></code> is the content at <code class="docutils literal notranslate"><span class="pre">LINE_NUMBER</span></code> in
<code class="docutils literal notranslate"><span class="pre">INPUT_FILE_NAME</span></code>.</p>
</div>
</div>
<div class="section" id="body">
<h3><span class="section-number">7.3.2.2.2. </span><code class="docutils literal notranslate"><span class="pre">BODY</span></code><a class="headerlink" href="#body" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">BODY</span></code> content depends on the executed command. It may be omitted.</p>
<p><code class="docutils literal notranslate"><span class="pre">BODY</span></code> may be an error message on error case.</p>
</div>
</div>
<div class="section" id="xml">
<h2><span class="section-number">7.3.2.3. </span>XML<a class="headerlink" href="#xml" title="Permalink to this headline">¶</a></h2>
<p>TODO</p>
</div>
<div class="section" id="tsv">
<h2><span class="section-number">7.3.2.4. </span>TSV<a class="headerlink" href="#tsv" title="Permalink to this headline">¶</a></h2>
<p>TODO</p>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.3.2.5. </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="return_code.html"><span class="doc">Return code</span></a> describes about return code.</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.2. Output format</a><ul>
<li><a class="reference internal" href="#summary">7.3.2.1. Summary</a></li>
<li><a class="reference internal" href="#json-and-messagepack">7.3.2.2. JSON and MessagePack</a><ul>
<li><a class="reference internal" href="#header">7.3.2.2.1. <code class="docutils literal notranslate"><span class="pre">HEADER</span></code></a><ul>
<li><a class="reference internal" href="#success-case">7.3.2.2.1.1. Success case</a></li>
<li><a class="reference internal" href="#error-case">7.3.2.2.1.2. Error case</a></li>
</ul>
</li>
<li><a class="reference internal" href="#body">7.3.2.2.2. <code class="docutils literal notranslate"><span class="pre">BODY</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#xml">7.3.2.3. XML</a></li>
<li><a class="reference internal" href="#tsv">7.3.2.4. TSV</a></li>
<li><a class="reference internal" href="#see-also">7.3.2.5. See also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="command_version.html"
title="previous chapter"><span class="section-number">7.3.1. </span>Command version</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pretty_print.html"
title="next chapter"><span class="section-number">7.3.3. </span>Pretty print</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="pretty_print.html" title="7.3.3. Pretty print"
>next</a> |</li>
<li class="right" >
<a href="command_version.html" title="7.3.1. Command version"
>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.2. </span>Output format</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
