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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.3.22. dump — 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.23. index_column_diff" href="index_column_diff.html" />
<link rel="prev" title="7.3.21. delete" href="delete.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/dump.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="index_column_diff.html" title="7.3.23. index_column_diff"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="delete.html" title="7.3.21. delete"
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.22. </span><code class="docutils literal notranslate"><span class="pre">dump</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="dump">
<h1><span class="section-number">7.3.22. </span><code class="docutils literal notranslate"><span class="pre">dump</span></code><a class="headerlink" href="#dump" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.22.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>dump - Output a schema and data of a database.</p>
<p>We explain about dump that one of built-in command of Groonga.
Built-in commands of Groonga execute by sending a request to groonga server via argument of groonga execution file, standard input, and socket.</p>
<p>The dump command outputs schemas and data of a database as a format that can read from after.</p>
<p>The dump command mainly uses from a command line. Because a dump result is big.
The dump command mainly uses for the backup of databases.</p>
<p>Groonga can directly understand the format of the dump command. Therefore, we can copy databases as below.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>% groonga original/db dump > dump.grn
% mkdir backup
% groonga -n backup/db < dump.grn
</pre></div>
</div>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.22.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>dump [tables=null]
[dump_plugins=yes]
[dump_schema=yes]
[dump_records=yes]
[dump_indexes=yes]
[dump_configs=yes]
[sort_hash_table=no]
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.22.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here is the sample schema and data to check dump behaviour:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register token_filters/stop_word
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
load --table Bookmarks
[
{"_key":"Groonga", "title":"Introduction to Groonga"},
{"_key":"PGroonga", "title":"Introduction to PGroonga"},
{"_key":"Mroonga", "title":"Introduction to Mroonga"}
]
load --table Sites
[
{"_id": 1, "url":"http://groonga.org"},
{"_id": 2, "url":"http://mroonga.org"}
]
</pre></div>
</div>
<p>Dump all data in database:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump
plugin_register token_filters/stop_word
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
load --table Sites
[
["_id","url"],
[1,"http://groonga.org"],
[2,"http://mroonga.org"]
]
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["PGroonga","Introduction to PGroonga"],
["Mroonga","Introduction to Mroonga"]
]
create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
</pre></div>
</div>
<p>Dump schema and specific table data:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump Bookmarks
plugin_register token_filters/stop_word
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["PGroonga","Introduction to PGroonga"],
["Mroonga","Introduction to Mroonga"]
]
column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
</pre></div>
</div>
<p>Dump plugin only:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump --dump_schema no --dump_records no --dump_indexes no
plugin_register token_filters/stop_word
</pre></div>
</div>
<p>Dump records only:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump --dump_schema no --dump_plugins no --dump_indexes no
load --table Sites
[
["_id","url"],
[1,"http://groonga.org"],
[2,"http://mroonga.org"]
]
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["PGroonga","Introduction to PGroonga"],
["Mroonga","Introduction to Mroonga"]
]
</pre></div>
</div>
<p>Dump schema only:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump --dump_records no --dump_plugins no --dump_indexes no
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
</pre></div>
</div>
<p>Dump sorted hash table data:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>> dump Bookmarks --sort_hash_table yes
plugin_register token_filters/stop_word
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["Mroonga","Introduction to Mroonga"],
["PGroonga","Introduction to PGroonga"]
]
column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.22.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>There are optional parameters.</p>
<div class="section" id="optional-parameters">
<h3><span class="section-number">7.3.22.4.1. </span>Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
<div class="section" id="tables">
<h4><span class="section-number">7.3.22.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">tables</span></code><a class="headerlink" href="#tables" title="Permalink to this headline">¶</a></h4>
<p>出力対象のテーブルを「,」（カンマ）区切りで指定します。存在しないテーブルを指定した場合は無視されます。</p>
</div>
<div class="section" id="dump-plugins">
<h4><span class="section-number">7.3.22.4.1.2. </span><code class="docutils literal notranslate"><span class="pre">dump_plugins</span></code><a class="headerlink" href="#dump-plugins" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.3.</span></p>
</div>
<p>You can customize the output whether it contains registered plugins or not.
To exclude registered plugins from the output, specify <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
</div>
<div class="section" id="dump-schema">
<h4><span class="section-number">7.3.22.4.1.3. </span><code class="docutils literal notranslate"><span class="pre">dump_schema</span></code><a class="headerlink" href="#dump-schema" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.3.</span></p>
</div>
<p>You can customize the output whether it contains database schema or not.
To exclude database schema from the output, specify <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
</div>
<div class="section" id="dump-records">
<h4><span class="section-number">7.3.22.4.1.4. </span><code class="docutils literal notranslate"><span class="pre">dump_records</span></code><a class="headerlink" href="#dump-records" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.3.</span></p>
</div>
<p>You can customize the output whether it contains records or not.
To exclude records from the output, specify <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
</div>
<div class="section" id="dump-indexes">
<h4><span class="section-number">7.3.22.4.1.5. </span><code class="docutils literal notranslate"><span class="pre">dump_indexes</span></code><a class="headerlink" href="#dump-indexes" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.3.</span></p>
</div>
<p>You can customize the output whether it contains indexes or not.
To exclude indexes from the output, specify <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
</div>
<div class="section" id="sort-hash-table">
<h4><span class="section-number">7.3.22.4.1.6. </span><code class="docutils literal notranslate"><span class="pre">sort_hash_table</span></code><a class="headerlink" href="#sort-hash-table" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.5.</span></p>
</div>
<p>You can ascending sort by <code class="docutils literal notranslate"><span class="pre">_key</span></code> the output of hash table when it contains hash table.
To sort the output of hash table, specify <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
</div>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.22.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>データベースのスキーマとデータをGroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。</p>
</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.22. <code class="docutils literal notranslate"><span class="pre">dump</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.22.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.22.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.22.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.3.22.4. Parameters</a><ul>
<li><a class="reference internal" href="#optional-parameters">7.3.22.4.1. Optional parameters</a><ul>
<li><a class="reference internal" href="#tables">7.3.22.4.1.1. <code class="docutils literal notranslate"><span class="pre">tables</span></code></a></li>
<li><a class="reference internal" href="#dump-plugins">7.3.22.4.1.2. <code class="docutils literal notranslate"><span class="pre">dump_plugins</span></code></a></li>
<li><a class="reference internal" href="#dump-schema">7.3.22.4.1.3. <code class="docutils literal notranslate"><span class="pre">dump_schema</span></code></a></li>
<li><a class="reference internal" href="#dump-records">7.3.22.4.1.4. <code class="docutils literal notranslate"><span class="pre">dump_records</span></code></a></li>
<li><a class="reference internal" href="#dump-indexes">7.3.22.4.1.5. <code class="docutils literal notranslate"><span class="pre">dump_indexes</span></code></a></li>
<li><a class="reference internal" href="#sort-hash-table">7.3.22.4.1.6. <code class="docutils literal notranslate"><span class="pre">sort_hash_table</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.22.5. Return value</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="delete.html"
title="previous chapter"><span class="section-number">7.3.21. </span><code class="docutils literal notranslate"><span class="pre">delete</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="index_column_diff.html"
title="next chapter"><span class="section-number">7.3.23. </span><code class="docutils literal notranslate"><span class="pre">index_column_diff</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="index_column_diff.html" title="7.3.23. index_column_diff"
>next</a> |</li>
<li class="right" >
<a href="delete.html" title="7.3.21. delete"
>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.22. </span><code class="docutils literal notranslate"><span class="pre">dump</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
