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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.15.16. prefix_rk_search — 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.15.17. query" href="query.html" />
<link rel="prev" title="7.15.15. number_classify" href="number_classify.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/functions/prefix_rk_search.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="query.html" title="7.15.17. query"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="number_classify.html" title="7.15.15. number_classify"
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="../function.html" accesskey="U"><span class="section-number">7.15. </span>Function</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.15.16. </span><code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="prefix-rk-search">
<h1><span class="section-number">7.15.16. </span><code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code><a class="headerlink" href="#prefix-rk-search" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.15.16.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code> selects records by
<a class="reference internal" href="../operations/prefix_rk_search.html"><span class="doc">Prefix RK search</span></a>.</p>
<p>You need to create <a class="reference internal" href="../tables.html#table-pat-key"><span class="std std-ref">TABLE_PAT_KEY</span></a> table for prefix RK search.</p>
<p>You can’t use <code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code> for sequential scan. It’s a
selector only procedure.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.15.16.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code> requires two arguments. They are <code class="docutils literal notranslate"><span class="pre">column</span></code> and
<code class="docutils literal notranslate"><span class="pre">query</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>prefix_rk_search(column, query)
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">column</span></code> must be <code class="docutils literal notranslate"><span class="pre">_key</span></code> for now.</p>
<p><code class="docutils literal notranslate"><span class="pre">query</span></code> must be string.</p>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.15.16.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here are a schema definition and sample data to show usage:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Readings
[
{"_key": "ニホン"},
{"_key": "ニッポン"},
{"_key": "ローマジ"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
</pre></div>
</div>
<p>Here is the simple usage of <code class="docutils literal notranslate"><span class="pre">prefix_rk_search()</span></code> function which
selects <code class="docutils literal notranslate"><span class="pre">ニホン</span></code> and <code class="docutils literal notranslate"><span class="pre">ニッポン</span></code> by <code class="docutils literal notranslate"><span class="pre">ni</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Readings --filter 'prefix_rk_search(_key, "ni")'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ]
# ],
# [
# 2,
# "ニッポン"
# ],
# [
# 1,
# "ニホン"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>You can implement <a class="reference internal" href="../suggest/completion.html"><span class="doc">Completion</span></a> like feature by
combining <a class="reference internal" href="sub_filter.html"><span class="doc">sub_filter</span></a>.</p>
<p>Create a table that has candidates of completion as records. Each
records have zero or more readings. They are stored into <code class="docutils literal notranslate"><span class="pre">Readings</span></code>
table. Don’t forget define an index column for <code class="docutils literal notranslate"><span class="pre">Items.readings</span></code> in
<code class="docutils literal notranslate"><span class="pre">Readings</span></code> table. The index column is needed for <a class="reference internal" href="sub_filter.html"><span class="doc">sub_filter</span></a>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Items TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Items readings COLUMN_VECTOR Readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Readings items_index COLUMN_INDEX Items readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Items
[
{"_key": "日本", "readings": ["ニホン", "ニッポン"]},
{"_key": "ローマ字", "readings": ["ローマジ"]},
{"_key": "漢字", "readings": ["カンジ"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
</pre></div>
</div>
<p>You can find <code class="docutils literal notranslate"><span class="pre">日本</span></code> record in <code class="docutils literal notranslate"><span class="pre">Items</span></code> table by <code class="docutils literal notranslate"><span class="pre">niho</span></code>. Because
prefix RK search with <code class="docutils literal notranslate"><span class="pre">niho</span></code> selects <code class="docutils literal notranslate"><span class="pre">ニホン</span></code> reading and <code class="docutils literal notranslate"><span class="pre">ニホン</span></code>
reading is one of readings of <code class="docutils literal notranslate"><span class="pre">日本</span></code> record:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Items \
--filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")")'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "readings",
# "Readings"
# ]
# ],
# [
# 1,
# "日本",
# [
# "ニホン",
# "ニッポン"
# ]
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>You need to combine <a class="reference internal" href="../grn_expr/script_syntax.html#script-syntax-prefix-search-operator"><span class="std std-ref">Prefix search operator</span></a> to
support no reading completion targets.</p>
<p>Add one no reading completion target:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Items
[
{"_key": "nihon", "readings": []}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
</pre></div>
</div>
<p>Combine <a class="reference internal" href="../grn_expr/script_syntax.html#script-syntax-prefix-search-operator"><span class="std std-ref">Prefix search operator</span></a> to
support no reading completion targets:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Items \
--filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")") || _key @^ "niho"'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "readings",
# "Readings"
# ]
# ],
# [
# 1,
# "日本",
# [
# "ニホン",
# "ニッポン"
# ]
# ],
# [
# 4,
# "nihon",
# []
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>Normally, you want to use case insensitive search for completion. Use
<code class="docutils literal notranslate"><span class="pre">--normalizer</span> <span class="pre">NormalizerAuto</span></code> and <code class="docutils literal notranslate"><span class="pre">label</span></code> column for the case:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create LooseItems TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create LooseItems label COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create LooseItems readings COLUMN_VECTOR Readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Readings loose_items_index COLUMN_INDEX LooseItems readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table LooseItems
[
{"_key": "日本", "label": "日本", "readings": ["ニホン", "ニッポン"]},
{"_key": "ローマ字", "label": "ローマ字", "readings": ["ローマジ"]},
{"_key": "漢字", "label": "漢字", "readings": ["カンジ"]},
{"_key": "Nihon", "label": "日本", "readings": []}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
</pre></div>
</div>
<p>Use <code class="docutils literal notranslate"><span class="pre">LooseItems.label</span></code> for display:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select LooseItems \
--filter 'sub_filter(readings, "prefix_rk_search(_key, \\"nIhO\\")") || _key @^ "nIhO"' \
--output_columns '_key,label'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "label",
# "ShortText"
# ]
# ],
# [
# "日本",
# "日本"
# ],
# [
# "nihon",
# "日本"
# ]
# ]
# ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.15.16.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>There are two required parameter, <code class="docutils literal notranslate"><span class="pre">column</span></code> and <code class="docutils literal notranslate"><span class="pre">query</span></code>.</p>
<div class="section" id="column">
<h3><span class="section-number">7.15.16.4.1. </span><code class="docutils literal notranslate"><span class="pre">column</span></code><a class="headerlink" href="#column" title="Permalink to this headline">¶</a></h3>
<p>Always specifies <code class="docutils literal notranslate"><span class="pre">_key</span></code> for now.</p>
</div>
<div class="section" id="query">
<h3><span class="section-number">7.15.16.4.2. </span><code class="docutils literal notranslate"><span class="pre">query</span></code><a class="headerlink" href="#query" title="Permalink to this headline">¶</a></h3>
<p>Specifies a query in romaji, katakana or hiragana as string.</p>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.15.16.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">prefix_rk_search</span></code> function returns matched records.</p>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.15.16.6. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="../operations/prefix_rk_search.html"><span class="doc">Prefix RK search</span></a></p></li>
<li><p><a class="reference internal" href="sub_filter.html"><span class="doc">sub_filter</span></a></p></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">7.15.16. <code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.15.16.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.15.16.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.15.16.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.15.16.4. Parameters</a><ul>
<li><a class="reference internal" href="#column">7.15.16.4.1. <code class="docutils literal notranslate"><span class="pre">column</span></code></a></li>
<li><a class="reference internal" href="#query">7.15.16.4.2. <code class="docutils literal notranslate"><span class="pre">query</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.15.16.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">7.15.16.6. See also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="number_classify.html"
title="previous chapter"><span class="section-number">7.15.15. </span><code class="docutils literal notranslate"><span class="pre">number_classify</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="query.html"
title="next chapter"><span class="section-number">7.15.17. </span><code class="docutils literal notranslate"><span class="pre">query</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="query.html" title="7.15.17. query"
>next</a> |</li>
<li class="right" >
<a href="number_classify.html" title="7.15.15. number_classify"
>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="../function.html" ><span class="section-number">7.15. </span>Function</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.15.16. </span><code class="docutils literal notranslate"><span class="pre">prefix_rk_search</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
