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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.3.37. logical_table_remove — 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.38. normalize" href="normalize.html" />
<link rel="prev" title="7.3.36. logical_shard_list" href="logical_shard_list.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/logical_table_remove.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="normalize.html" title="7.3.38. normalize"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="logical_shard_list.html" title="7.3.36. logical_shard_list"
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.37. </span><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="logical-table-remove">
<h1><span class="section-number">7.3.37. </span><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code><a class="headerlink" href="#logical-table-remove" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.37.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.5.</span></p>
</div>
<p><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> removes tables and their columns for the
specified logical table. If there are one or more indexes against key
of the tables and their columns, they are also removed.</p>
<p>If you specify the part of a shard, table of the shard isn’t
removed. <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> just deletes records in the table.</p>
<p>For example, there are the following records in a table:</p>
<blockquote>
<div><ul class="simple">
<li><p>Record1: <code class="docutils literal notranslate"><span class="pre">2016-03-18</span> <span class="pre">00:30:00</span></code></p></li>
<li><p>Record2: <code class="docutils literal notranslate"><span class="pre">2016-03-18</span> <span class="pre">01:00:00</span></code></p></li>
<li><p>Record3: <code class="docutils literal notranslate"><span class="pre">2016-03-18</span> <span class="pre">02:00:00</span></code></p></li>
</ul>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> deletes “Record1” and “Record2” when you
specify range as between <code class="docutils literal notranslate"><span class="pre">2016-03-18</span> <span class="pre">00:00:00</span></code> and <code class="docutils literal notranslate"><span class="pre">2016-03-18</span>
<span class="pre">01:30:00</span></code>. <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> doesn’t delete
“Record3”. <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> doesn’t remove the table.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.1: </span>You can also remove tables and columns that reference the target
table and tables related with the target shard by using
<code class="docutils literal notranslate"><span class="pre">dependent</span></code> parameter.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.9: </span>You can remove broken tables and columns as much as possible by
using <code class="docutils literal notranslate"><span class="pre">force</span></code> parameter.</p>
</div>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.37.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>This command takes many parameters.</p>
<p>The required parameters are <code class="docutils literal notranslate"><span class="pre">logical_table</span></code> and <code class="docutils literal notranslate"><span class="pre">shard_key</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove logical_table
shard_key
[min=null]
[min_border="include"]
[max=null]
[max_border="include"]
[dependent=no]
[force=no]
</pre></div>
</div>
</div>
<div class="section" id="usage">
<span id="logical-table-remove-usage"></span><h2><span class="section-number">7.3.37.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>You specify logical table name and shard key what you want to remove.</p>
<p>This section describes about the followings:</p>
<blockquote>
<div><ul class="simple">
<li><p>Basic usage</p></li>
<li><p>Removes parts of a logical table</p></li>
<li><p>Unremovable cases</p></li>
<li><p>Removes with related tables</p></li>
<li><p>Removes broken tables as much as possible</p></li>
<li><p>Decreases used resources</p></li>
</ul>
</div></blockquote>
<div class="section" id="basic-usage">
<span id="logical-table-remove-basic-usage"></span><h3><span class="section-number">7.3.37.3.1. </span>Basic usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h3>
<p>Register <code class="docutils literal notranslate"><span class="pre">sharding</span></code> plugin to use this command in advance.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register sharding
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>You can remove all tables for the logical table by specifying only
<code class="docutils literal notranslate"><span class="pre">logical_table</span></code> and <code class="docutils literal notranslate"><span class="pre">shard_key</span></code>.</p>
<p>Here are commands to create 2 shards:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Logs_20160318 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160318 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Logs_20160319 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160319 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>You can confirm existing shards by <a class="reference internal" href="logical_shard_list.html"><span class="doc">logical_shard_list</span></a>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_shard_list --logical_table Logs
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# {
# "name": "Logs_20160318"
# },
# {
# "name": "Logs_20160319"
# }
# ]
# ]
</pre></div>
</div>
<p>You can remove all shards:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>There are no shards after you remove all shards:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_shard_list --logical_table Logs
# [[0, 1337566253.89858, 0.000355720520019531], []]
</pre></div>
</div>
</div>
<div class="section" id="removes-parts-of-a-logical-table">
<span id="logical-table-remove-removes-parts"></span><h3><span class="section-number">7.3.37.3.2. </span>Removes parts of a logical table<a class="headerlink" href="#removes-parts-of-a-logical-table" title="Permalink to this headline">¶</a></h3>
<p>You can specify range of shards by the following parameters:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">min</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">min_border</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">max</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">max_border</span></code></p></li>
</ul>
</div></blockquote>
<p>See the following documents of <a class="reference internal" href="logical_select.html"><span class="doc">logical_select</span></a> for each
parameter:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="logical_select.html#logical-select-min"><span class="std std-ref">min</span></a></p></li>
<li><p><a class="reference internal" href="logical_select.html#logical-select-min-border"><span class="std std-ref">min_border</span></a></p></li>
<li><p><a class="reference internal" href="logical_select.html#logical-select-max"><span class="std std-ref">max</span></a></p></li>
<li><p><a class="reference internal" href="logical_select.html#logical-select-max-border"><span class="std std-ref">max_border</span></a></p></li>
</ul>
</div></blockquote>
<p>If the specified range doesn’t cover all records in a shard, table for
the shard isn’t removed. Target records in the table are only deleted.</p>
<p>If the specified range covers all records in a shard, table for the
shard is removed.</p>
<p>Here is a logical table to show the behavior. The logical table has two
shards:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Logs_20160318 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160318 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Logs_20160318
[
{"timestamp": "2016-03-18 00:30:00"},
{"timestamp": "2016-03-18 01:00:00"},
{"timestamp": "2016-03-18 02:00:00"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
table_create Logs_20160319 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160319 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Logs_20160319
[
{"timestamp": "2016-03-19 00:30:00"},
{"timestamp": "2016-03-19 01:00:00"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
</pre></div>
</div>
<p>There are the following records in <code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table:</p>
<blockquote>
<div><ul class="simple">
<li><p>Record1: <code class="docutils literal notranslate"><span class="pre">"2016-03-18</span> <span class="pre">00:30:00"</span></code></p></li>
<li><p>Record2: <code class="docutils literal notranslate"><span class="pre">"2016-03-18</span> <span class="pre">01:00:00"</span></code></p></li>
<li><p>Record3: <code class="docutils literal notranslate"><span class="pre">"2016-03-18</span> <span class="pre">02:00:00"</span></code></p></li>
</ul>
</div></blockquote>
<p>There are the following records in <code class="docutils literal notranslate"><span class="pre">Logs_20160319</span></code> table:</p>
<blockquote>
<div><ul class="simple">
<li><p>Record1: <code class="docutils literal notranslate"><span class="pre">"2016-03-19</span> <span class="pre">00:30:00"</span></code></p></li>
<li><p>Record2: <code class="docutils literal notranslate"><span class="pre">"2016-03-19</span> <span class="pre">01:00:00"</span></code></p></li>
</ul>
</div></blockquote>
<p>The following range doesn’t cover “Record1” in <code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table
but covers all records in <code class="docutils literal notranslate"><span class="pre">Logs_20160319</span></code> table:</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>Parameter</p></th>
<th class="head"><p>Value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">min</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">"2016-03-18</span> <span class="pre">01:00:00"</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">min_border</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">"include"</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">max</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">"2016-03-19</span> <span class="pre">01:30:00"</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">max_border</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">"include"</span></code></p></td>
</tr>
</tbody>
</table>
<p><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with the range deletes “Record2” and
“Record3” in <code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table but doesn’t remove
<code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table. Because there is “Record1” in
<code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table.</p>
<p><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with the range removes <code class="docutils literal notranslate"><span class="pre">Logs_20160319</span></code>
table because the range covers all records in <code class="docutils literal notranslate"><span class="pre">Logs_20160319</span></code> table.</p>
<p>Here is an example to use <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with the range:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp \
--min "2016-03-18 01:00:00" \
--min_border "include" \
--max "2016-03-19 01:30:00" \
--max_border "include"
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p><a class="reference internal" href="dump.html"><span class="doc">dump</span></a> shows that there is “Record1” in <code class="docutils literal notranslate"><span class="pre">Logs_20160318</span></code> table:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>dump
# plugin_register sharding
#
# table_create Logs_20160318 TABLE_NO_KEY
# column_create Logs_20160318 timestamp COLUMN_SCALAR Time
#
# load --table Logs_20160318
# [
# ["_id","timestamp"],
# [1,1458228600.0]
# ]
</pre></div>
</div>
</div>
<div class="section" id="unremovable-cases">
<span id="logical-table-remove-unremovable-cases"></span><h3><span class="section-number">7.3.37.3.3. </span>Unremovable cases<a class="headerlink" href="#unremovable-cases" title="Permalink to this headline">¶</a></h3>
<p>There are some unremovable cases. See
<a class="reference internal" href="table_remove.html#table-remove-unremovable-cases"><span class="std std-ref">Unremovable cases</span></a> for details. Because
<code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> uses the same checks.</p>
</div>
<div class="section" id="removes-with-related-tables">
<span id="logical-table-remove-removes-with-related-tables"></span><h3><span class="section-number">7.3.37.3.4. </span>Removes with related tables<a class="headerlink" href="#removes-with-related-tables" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.1.</span></p>
</div>
<p>If you understand what you’ll do, you can also remove tables and
columns that depend on the target shard with one
<code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> command by using <code class="docutils literal notranslate"><span class="pre">--dependent</span> <span class="pre">yes</span></code>
parameter.</p>
<p>Here are conditions for dependent. If table or column satisfies one of
the conditions, the table or column depends on the target shard:</p>
<blockquote>
<div><ul class="simple">
<li><p>Tables and columns that reference the target shard</p></li>
<li><p>Tables for the shard (= The table has the same <code class="docutils literal notranslate"><span class="pre">_YYYYMMDD</span></code>
postfix as the target shard and is referenced from the target
shard)</p></li>
</ul>
</div></blockquote>
<p>If there are one or more tables and columns that reference the target
shard, <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> is failed. It’s for avoiding dangling
references.</p>
<p><code class="docutils literal notranslate"><span class="pre">Bookmarks.log_20160320</span></code> column in the following is the column that
references the target shard:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Logs_20160320 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160320 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Bookmarks TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Bookmarks log_20160320 COLUMN_SCALAR Logs_20160320
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>You can’t remove <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> by <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> by
default:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp
# [
# [
# -2,
# 1337566253.89858,
# 0.000355720520019531,
# "operation not permitted: <[table][remove] a column that references the table exists: <Bookmarks.log_20160320> -> <Logs_20160320",
# [
# [
# "Groonga::Sharding::LogicalTableRemoveCommand.remove_table",
# "/home/horimoto/work/release/groonga/groonga.clean/plugins/sharding/logical_table_remove.rb",
# 199
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>You can remove <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> by <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with
<code class="docutils literal notranslate"><span class="pre">--dependent</span> <span class="pre">yes</span></code> parameter. <code class="docutils literal notranslate"><span class="pre">Bookmarks.log_20160320</span></code> is also
removed:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp \
--dependent yes
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p><a class="reference internal" href="object_exist.html"><span class="doc">object_exist</span></a> shows that <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> table and
<code class="docutils literal notranslate"><span class="pre">Bookmarks.log_20160320</span></code> column are removed:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>object_exist Logs_20160320
# [[0, 1337566253.89858, 0.000355720520019531], false]
object_exist Bookmarks.log_20160320
# [[0, 1337566253.89858, 0.000355720520019531], false]
</pre></div>
</div>
<p>If there is one or more tables for the target shard,
<code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with <code class="docutils literal notranslate"><span class="pre">--dependent</span> <span class="pre">yes</span></code> also removes
them. Tables that have the same <code class="docutils literal notranslate"><span class="pre">_YYYYMMDD</span></code> postfix as the target
shard are treated as tables for the target shard.</p>
<p>Here are two tables that have <code class="docutils literal notranslate"><span class="pre">_20160320</span></code>
postfix. <code class="docutils literal notranslate"><span class="pre">NotRelated_20160320</span></code> table isn’t used by <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code>
table. <code class="docutils literal notranslate"><span class="pre">Users_20160320</span></code> table is used by <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code>
table. <code class="docutils literal notranslate"><span class="pre">Servers</span></code> table exists and used by <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> table:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create NotRelated_20160320 TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Users_20160320 TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Servers TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Logs_20160320 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160320 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160320 user COLUMN_SCALAR Users_20160320
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160320 server COLUMN_SCALAR Servers
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> with <code class="docutils literal notranslate"><span class="pre">--dependent</span> <span class="pre">yes</span></code> parameter removes
only <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> table and <code class="docutils literal notranslate"><span class="pre">Users_20160320</span></code> table. Because
<code class="docutils literal notranslate"><span class="pre">Users_20160320</span></code> table has <code class="docutils literal notranslate"><span class="pre">_20160320</span></code> postfix and used by
<code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code>. <code class="docutils literal notranslate"><span class="pre">NotRelated_20160320</span></code> table and <code class="docutils literal notranslate"><span class="pre">Servers</span></code> table
aren’t removed. Because <code class="docutils literal notranslate"><span class="pre">NotRelated_20160320</span></code> table has
<code class="docutils literal notranslate"><span class="pre">_20160320</span></code> postfix but isn’t used by <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code>. <code class="docutils literal notranslate"><span class="pre">Servers</span></code>
table is used by <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> but doesn’t have <code class="docutils literal notranslate"><span class="pre">_20160320</span></code>
postfix:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp \
--dependent yes
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>You can confirm that <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> table and <code class="docutils literal notranslate"><span class="pre">Users_20160320</span></code>
table are removed but <code class="docutils literal notranslate"><span class="pre">NotRelated_20160320</span></code> table and <code class="docutils literal notranslate"><span class="pre">Servers</span></code>
table aren’t removed:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>object_exist Logs_20160320
# [[0, 1337566253.89858, 0.000355720520019531], false]
object_exist Users_20160320
# [[0, 1337566253.89858, 0.000355720520019531], false]
object_exist NotRelated_20160320
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_exist Servers
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
</div>
<div class="section" id="removes-broken-tables-as-much-as-possible">
<span id="logical-table-remove-removes-broken-tables-as-much-as-possible"></span><h3><span class="section-number">7.3.37.3.5. </span>Removes broken tables as much as possible<a class="headerlink" href="#removes-broken-tables-as-much-as-possible" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.9.</span></p>
</div>
<p>If the target tables are broken, you can’t remove them. But you can
remove them as much as possible by using <code class="docutils literal notranslate"><span class="pre">force</span></code> parameter.</p>
<p>If you specify <code class="docutils literal notranslate"><span class="pre">--force</span> <span class="pre">yes</span></code>, they are removed as much as
possible. You can also use <code class="docutils literal notranslate"><span class="pre">--dependent</span> <span class="pre">yes</span></code> with <code class="docutils literal notranslate"><span class="pre">--force</span> <span class="pre">yes</span></code>.</p>
<p>Here is a sample schema to show how <code class="docutils literal notranslate"><span class="pre">--force</span> <span class="pre">yes</span></code> behavior:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Logs_20160320 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160320 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Timestamps TABLE_PAT_KEY Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Timestamps logs_20160320_timestamp \
COLUMN_INDEX Logs_20160320 timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>You can’t remove <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> when
<code class="docutils literal notranslate"><span class="pre">Timestamps.logs_20160320_timestamp</span></code> is broken:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp
# [
# [
# -55,
# 1337566253.89858,
# 0.000355720520019531,
# "object corrupt: <[column][remove][index] hook has a dangling reference: <Logs_20160320.timestamp> -> <Timestamps.logs_20160320_",
# [
# [
# "Groonga::Sharding::LogicalTableRemoveCommand.remove_table",
# "/home/horimoto/work/release/groonga/groonga.clean/plugins/sharding/logical_table_remove.rb",
# 199
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>You can remove <code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code> and its columns by using <code class="docutils literal notranslate"><span class="pre">--force</span>
<span class="pre">yes</span></code> parameter even when <code class="docutils literal notranslate"><span class="pre">Timestamps.logs_20160320_timestamp</span></code> is
broken:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logical_table_remove \
--logical_table Logs \
--shard_key timestamp \
--force yes
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Logs_20160320</span></code>, its columns and
<code class="docutils literal notranslate"><span class="pre">Timestamps.logs_20160320_timestamp</span></code> are removed:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>object_exist Logs_20160320
# [[0, 1337566253.89858, 0.000355720520019531], false]
object_exist Logs_20160320.timestamp
# [[0, 1337566253.89858, 0.000355720520019531], false]
object_exist Timestamps.logs_20160320_timestamp
# [[0, 1337566253.89858, 0.000355720520019531], false]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--force</span> <span class="pre">yes</span></code> parameter is a dangerous parameter. Normally, you
don’t need to use it.</p>
</div>
<div class="section" id="decreases-used-resources">
<span id="logical-table-remove-decreases-used-resources"></span><h3><span class="section-number">7.3.37.3.6. </span>Decreases used resources<a class="headerlink" href="#decreases-used-resources" title="Permalink to this headline">¶</a></h3>
<p>You can decrease resources for this command. See
<a class="reference internal" href="table_remove.html#table-remove-decreases-used-resources"><span class="std std-ref">Decreases used resources</span></a> for details. Because
<code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code> uses the same logic as <a class="reference internal" href="table_remove.html"><span class="doc">table_remove</span></a>.</p>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.37.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">logical_table_remove</span></code>.</p>
<div class="section" id="required-parameters">
<h3><span class="section-number">7.3.37.4.1. </span>Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
<p>There are required parameters.</p>
<div class="section" id="logical-table">
<span id="logical-table-remove-logical-table"></span><h4><span class="section-number">7.3.37.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">logical_table</span></code><a class="headerlink" href="#logical-table" title="Permalink to this headline">¶</a></h4>
<p>Specifies logical table name. It means table name without
<code class="docutils literal notranslate"><span class="pre">_YYYYMMDD</span></code> postfix. If you use actual table such as
<code class="docutils literal notranslate"><span class="pre">Logs_20150203</span></code>, <code class="docutils literal notranslate"><span class="pre">Logs_20150203</span></code> and so on, logical table name is
<code class="docutils literal notranslate"><span class="pre">Logs</span></code>.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-logical-table"><span class="std std-ref">logical_table</span></a>.</p>
</div>
<div class="section" id="shard-key">
<span id="logical-table-remove-shard-key"></span><h4><span class="section-number">7.3.37.4.1.2. </span><code class="docutils literal notranslate"><span class="pre">shard_key</span></code><a class="headerlink" href="#shard-key" title="Permalink to this headline">¶</a></h4>
<p>Specifies column name which is treated as shared key.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-shard-key"><span class="std std-ref">shard_key</span></a>.</p>
</div>
</div>
<div class="section" id="optional-parameters">
<h3><span class="section-number">7.3.37.4.2. </span>Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
<p>There are optional parameters.</p>
<div class="section" id="min">
<span id="logical-table-remove-min"></span><h4><span class="section-number">7.3.37.4.2.1. </span><code class="docutils literal notranslate"><span class="pre">min</span></code><a class="headerlink" href="#min" title="Permalink to this headline">¶</a></h4>
<p>Specifies the minimum value of <code class="docutils literal notranslate"><span class="pre">shard_key</span></code> column.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-min"><span class="std std-ref">min</span></a>.</p>
</div>
<div class="section" id="min-border">
<span id="logical-table-remove-min-border"></span><h4><span class="section-number">7.3.37.4.2.2. </span><code class="docutils literal notranslate"><span class="pre">min_border</span></code><a class="headerlink" href="#min-border" title="Permalink to this headline">¶</a></h4>
<p>Specifies whether the minimum value is included or not. <code class="docutils literal notranslate"><span class="pre">include</span></code>
and <code class="docutils literal notranslate"><span class="pre">exclude</span></code> are available. The default is <code class="docutils literal notranslate"><span class="pre">include</span></code>.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-min-border"><span class="std std-ref">min_border</span></a>.</p>
</div>
<div class="section" id="max">
<span id="logical-table-remove-max"></span><h4><span class="section-number">7.3.37.4.2.3. </span><code class="docutils literal notranslate"><span class="pre">max</span></code><a class="headerlink" href="#max" title="Permalink to this headline">¶</a></h4>
<p>Specifies the maximum value of <code class="docutils literal notranslate"><span class="pre">shard_key</span></code> column.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-max"><span class="std std-ref">max</span></a>.</p>
</div>
<div class="section" id="max-border">
<span id="logical-table-remove-max-border"></span><h4><span class="section-number">7.3.37.4.2.4. </span><code class="docutils literal notranslate"><span class="pre">max_border</span></code><a class="headerlink" href="#max-border" title="Permalink to this headline">¶</a></h4>
<p>Specifies whether the maximum value is included or not. <code class="docutils literal notranslate"><span class="pre">include</span></code>
and <code class="docutils literal notranslate"><span class="pre">exclude</span></code> are available. The default is <code class="docutils literal notranslate"><span class="pre">include</span></code>.</p>
<p>See also <a class="reference internal" href="logical_select.html#logical-select-max-border"><span class="std std-ref">max_border</span></a>.</p>
</div>
<div class="section" id="dependent">
<span id="logical-table-remove-dependent"></span><h4><span class="section-number">7.3.37.4.2.5. </span><code class="docutils literal notranslate"><span class="pre">dependent</span></code><a class="headerlink" href="#dependent" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.1.</span></p>
</div>
<p>Specifies whether tables and columns that depend on the target shard
are also removed or not.</p>
<p>Here are conditions for dependent. If table or column satisfies one of
the conditions, the table or column depends on the target shard:</p>
<blockquote>
<div><ul class="simple">
<li><p>Tables and columns that reference the target shard</p></li>
<li><p>Tables for the shard (= The table has the same <code class="docutils literal notranslate"><span class="pre">_YYYYMMDD</span></code>
postfix as the target shard and is referenced from the target
shard)</p></li>
</ul>
</div></blockquote>
<p>If this value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>, tables and columns that depend on the target
shard are also removed. Otherwise, they aren’t removed. If there are
one or more tables that reference the target shard, an error is
returned. If there are tables for the shared, they are not touched.</p>
<p>You should use this parameter carefully. This is a danger parameter.</p>
<p>See <a class="reference internal" href="#logical-table-remove-removes-with-related-tables"><span class="std std-ref">Removes with related tables</span></a> how to use
this parameter.</p>
</div>
<div class="section" id="force">
<span id="logical-table-remove-force"></span><h4><span class="section-number">7.3.37.4.2.6. </span><code class="docutils literal notranslate"><span class="pre">force</span></code><a class="headerlink" href="#force" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.9.</span></p>
</div>
<p>Specifies whether you want to remove target tables and columns even if
some problems exist.</p>
<p>You should use this parameter carefully. This is a danger parameter.</p>
<p>See
<a class="reference internal" href="#logical-table-remove-removes-broken-tables-as-much-as-possible"><span class="std std-ref">Removes broken tables as much as possible</span></a>
how to use this parameter.</p>
</div>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.37.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>The command returns <code class="docutils literal notranslate"><span class="pre">true</span></code> as body on success such as:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[HEADER, true]
</pre></div>
</div>
<p>If the command fails, error details are in <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
<p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> for <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</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.37. <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.37.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.37.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.37.3. Usage</a><ul>
<li><a class="reference internal" href="#basic-usage">7.3.37.3.1. Basic usage</a></li>
<li><a class="reference internal" href="#removes-parts-of-a-logical-table">7.3.37.3.2. Removes parts of a logical table</a></li>
<li><a class="reference internal" href="#unremovable-cases">7.3.37.3.3. Unremovable cases</a></li>
<li><a class="reference internal" href="#removes-with-related-tables">7.3.37.3.4. Removes with related tables</a></li>
<li><a class="reference internal" href="#removes-broken-tables-as-much-as-possible">7.3.37.3.5. Removes broken tables as much as possible</a></li>
<li><a class="reference internal" href="#decreases-used-resources">7.3.37.3.6. Decreases used resources</a></li>
</ul>
</li>
<li><a class="reference internal" href="#parameters">7.3.37.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameters">7.3.37.4.1. Required parameters</a><ul>
<li><a class="reference internal" href="#logical-table">7.3.37.4.1.1. <code class="docutils literal notranslate"><span class="pre">logical_table</span></code></a></li>
<li><a class="reference internal" href="#shard-key">7.3.37.4.1.2. <code class="docutils literal notranslate"><span class="pre">shard_key</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#optional-parameters">7.3.37.4.2. Optional parameters</a><ul>
<li><a class="reference internal" href="#min">7.3.37.4.2.1. <code class="docutils literal notranslate"><span class="pre">min</span></code></a></li>
<li><a class="reference internal" href="#min-border">7.3.37.4.2.2. <code class="docutils literal notranslate"><span class="pre">min_border</span></code></a></li>
<li><a class="reference internal" href="#max">7.3.37.4.2.3. <code class="docutils literal notranslate"><span class="pre">max</span></code></a></li>
<li><a class="reference internal" href="#max-border">7.3.37.4.2.4. <code class="docutils literal notranslate"><span class="pre">max_border</span></code></a></li>
<li><a class="reference internal" href="#dependent">7.3.37.4.2.5. <code class="docutils literal notranslate"><span class="pre">dependent</span></code></a></li>
<li><a class="reference internal" href="#force">7.3.37.4.2.6. <code class="docutils literal notranslate"><span class="pre">force</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.37.5. Return value</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="logical_shard_list.html"
title="previous chapter"><span class="section-number">7.3.36. </span><code class="docutils literal notranslate"><span class="pre">logical_shard_list</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="normalize.html"
title="next chapter"><span class="section-number">7.3.38. </span><code class="docutils literal notranslate"><span class="pre">normalize</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="normalize.html" title="7.3.38. normalize"
>next</a> |</li>
<li class="right" >
<a href="logical_shard_list.html" title="7.3.36. logical_shard_list"
>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.37. </span><code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
