File: index_column_diff.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (328 lines) | stat: -rw-r--r-- 15,684 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.3.23. index_column_diff &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="7.3.24. io_flush" href="io_flush.html" />
    <link rel="prev" title="7.3.22. dump" href="dump.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/index_column_diff.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="io_flush.html" title="7.3.24. io_flush"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="dump.html" title="7.3.22. dump"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U"><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.23. </span><code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code></a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="index-column-diff">
<h1><span class="section-number">7.3.23. </span><code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code><a class="headerlink" href="#index-column-diff" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.23.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 9.0.1.</span></p>
</div>
<p><code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code> command check where indexes are broken or not.</p>
<p>We can found already a broken index by this command.
Normally, we don’t found it unless Groonga refer, delete, or update it.
However, it is possible that Groonga crashes or returns wrong search
results by using it.
it make us want to found it in advance.
This command useful in this case.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This command may use many memory and execution time depending on the size of the target index.
Also, if we stop in the middle of execution of this command, the target index may break.
Therefore, we suggest that we don’t execute this command on active system, but execute
this command on standby system.</p>
</div>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.23.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>This command takes two parameters.
All parameters are required:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>index_column_diff table index_column
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.23.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here is an example to check a index column in the database:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Data TABLE_HASH_KEY ShortText
# [[0,1612416118.30525,0.003424882888793945],true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenNgram \
  --normalizer NormalizerNFKC130
# [[0,1612416136.049046,0.003507614135742188],true]
load --table Data
[
{&quot;_key&quot;: &quot;Hello World&quot;},
{&quot;_key&quot;: &quot;Hello Groonga&quot;}
]
# [[0,1612416155.418526,0.3676469326019287],2]
column_create \
  --table Terms \
  --name data_index \
  --flags COLUMN_INDEX|WITH_POSITION \
  --type Data \
  --source _key
# [[0,1612416424.515037,0.00576472282409668],true]
truncate Terms.data_index
# [[0,1612416439.925894,0.009646892547607422],true]
load --table Data
[
{&quot;_key&quot;: &quot;Good-by World&quot;},
{&quot;_key&quot;: &quot;Good-by Groonga&quot;}
]
# [[0,1612416450.429434,1.51789665222168],2]
index_column_diff Terms data_index
# [
#   [
#     0,
#     1612416577.921113,
#     0.006278038024902344
#   ],
#   [
#     {
#       &quot;token&quot;: {
#         &quot;id&quot;: 2,
#         &quot;value&quot;: &quot;hello&quot;
#       },
#       &quot;remains&quot;: [
#       ],
#       &quot;missings&quot;: [
#         {
#           &quot;record_id&quot;: 1,
#           &quot;position&quot;: 0
#         },
#         {
#           &quot;record_id&quot;: 2,
#           &quot;position&quot;: 0
#         }
#       ]
#     },
#     {
#       &quot;token&quot;: {
#         &quot;id&quot;: 3,
#         &quot;value&quot;: &quot;world&quot;
#       },
#       &quot;remains&quot;: [
#       ],
#       &quot;missings&quot;: [
#         {
#           &quot;record_id&quot;: 1,
#           &quot;position&quot;: 1
#         }
#       ]
#     },
#     {
#       &quot;token&quot;: {
#         &quot;id&quot;: 1,
#         &quot;value&quot;: &quot;groonga&quot;
#       },
#       &quot;remains&quot;: [
#       ],
#       &quot;missings&quot;: [
#         {
#           &quot;record_id&quot;: 2,
#           &quot;position&quot;: 1
#         }
#       ]
#     }
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.23.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>This section describes all parameters.</p>
<div class="section" id="table">
<h3><span class="section-number">7.3.23.4.1. </span><code class="docutils literal notranslate"><span class="pre">table</span></code><a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h3>
<p>Specifies the name of a table include check target of the index column.</p>
</div>
<div class="section" id="index-column">
<h3><span class="section-number">7.3.23.4.2. </span><code class="docutils literal notranslate"><span class="pre">index_column</span></code><a class="headerlink" href="#index-column" title="Permalink to this headline">¶</a></h3>
<p>Specifies the name of check target of the index column.</p>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.23.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">index_column_diff</span></code> command returns result of check indexes:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[HEADER, CHECK_RESULT]
</pre></div>
</div>
<p><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> about <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">CHECK_RESULT</span></code></p>
<p>This command returns the result of compression between the current
value of the index column and the result of tokenize when this command
execute as below:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>{
  &quot;token&quot;: {
    &quot;id&quot;: TOKEN_ID,
    &quot;value&quot;: TOKEN_VALUE
  },
  &quot;remains&quot;: [
    {
      &quot;record_id&quot;: RECORD_ID
    }
  ],
  &quot;missings&quot;: [
    {
      &quot;record_id&quot;: RECORD_ID,
      &quot;position&quot;: POSITION
    }
  ]
}
</pre></div>
</div>
<p>If there are something in <code class="docutils literal notranslate"><span class="pre">remains</span></code>, a token that Groonga
was supposed to delete is remaining in a index.</p>
<p>If there are something in <code class="docutils literal notranslate"><span class="pre">missing</span></code>, a token that Groonga
is supposing to remain in a index has been deleted from the index.</p>
<p><code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code> returns nothing as below When indexes haven’t broken:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>index_column_diff --table table --name index_column
[[0,0.0,0.0],[]]
</pre></div>
</div>
<div class="section" id="token-id">
<h3><span class="section-number">7.3.23.5.1. </span><code class="docutils literal notranslate"><span class="pre">TOKEN_ID</span></code><a class="headerlink" href="#token-id" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TOKEN_ID</span></code> is id of a broken token.</p>
</div>
<div class="section" id="token-value">
<h3><span class="section-number">7.3.23.5.2. </span><code class="docutils literal notranslate"><span class="pre">TOKEN_VALUE</span></code><a class="headerlink" href="#token-value" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">TOKEN_VALUE</span></code> is value of a broken token.</p>
</div>
<div class="section" id="record-id">
<h3><span class="section-number">7.3.23.5.3. </span><code class="docutils literal notranslate"><span class="pre">RECORD_ID</span></code><a class="headerlink" href="#record-id" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">RECORD_ID</span></code> is id of a record include a broken token.</p>
</div>
<div class="section" id="position">
<h3><span class="section-number">7.3.23.5.4. </span><code class="docutils literal notranslate"><span class="pre">POSITION</span></code><a class="headerlink" href="#position" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">POSITION</span></code> is appearing position of a broken token.</p>
</div>
</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.23. <code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.23.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.23.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.23.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.3.23.4. Parameters</a><ul>
<li><a class="reference internal" href="#table">7.3.23.4.1. <code class="docutils literal notranslate"><span class="pre">table</span></code></a></li>
<li><a class="reference internal" href="#index-column">7.3.23.4.2. <code class="docutils literal notranslate"><span class="pre">index_column</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.23.5. Return value</a><ul>
<li><a class="reference internal" href="#token-id">7.3.23.5.1. <code class="docutils literal notranslate"><span class="pre">TOKEN_ID</span></code></a></li>
<li><a class="reference internal" href="#token-value">7.3.23.5.2. <code class="docutils literal notranslate"><span class="pre">TOKEN_VALUE</span></code></a></li>
<li><a class="reference internal" href="#record-id">7.3.23.5.3. <code class="docutils literal notranslate"><span class="pre">RECORD_ID</span></code></a></li>
<li><a class="reference internal" href="#position">7.3.23.5.4. <code class="docutils literal notranslate"><span class="pre">POSITION</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="dump.html"
                        title="previous chapter"><span class="section-number">7.3.22. </span><code class="docutils literal notranslate"><span class="pre">dump</span></code></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="io_flush.html"
                        title="next chapter"><span class="section-number">7.3.24. </span><code class="docutils literal notranslate"><span class="pre">io_flush</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="io_flush.html" title="7.3.24. io_flush"
             >next</a> |</li>
        <li class="right" >
          <a href="dump.html" title="7.3.22. dump"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../command.html" ><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.23. </span><code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code></a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>