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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.15.11. in_records — 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.12. in_values" href="in_values.html" />
<link rel="prev" title="7.15.10. html_untag" href="html_untag.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/in_records.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="in_values.html" title="7.15.12. in_values"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="html_untag.html" title="7.15.10. html_untag"
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.11. </span><code class="docutils literal notranslate"><span class="pre">in_records</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="in-records">
<h1><span class="section-number">7.15.11. </span><code class="docutils literal notranslate"><span class="pre">in_records</span></code><a class="headerlink" href="#in-records" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.15.11.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 7.0.2.</span></p>
</div>
<p>You can use <code class="docutils literal notranslate"><span class="pre">in_records</span></code> for using an existing table as condition patterns. Each record in the existing table is treated as a condition pattern.</p>
<p>You may be able to reduce multiple queries to only one query by <code class="docutils literal notranslate"><span class="pre">in_records</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">in_records</span></code> is similar to <a class="reference internal" href="sub_filter.html"><span class="doc">sub_filter</span></a>. Here are differences of them:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sub_filter</span></code> requires a reference column to condition table but <code class="docutils literal notranslate"><span class="pre">in_records</span></code> doesn’t require.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sub_filter</span></code> requires an index column for the reference column but <code class="docutils literal notranslate"><span class="pre">in_records</span></code> doesn’t require.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sub_filter</span></code> can use all logical operations but <code class="docutils literal notranslate"><span class="pre">in_records</span></code> can use only AND logical operation in one pattern.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sub_filter</span></code> can use only the value of one reference column for condition but <code class="docutils literal notranslate"><span class="pre">in_records</span></code> can use one or more values for condition. You can use multiple columns, functions and so on for multiple values.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sub_filter</span></code> uses index search but <code class="docutils literal notranslate"><span class="pre">in_records</span></code> uses sequential search.</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="syntax">
<span id="in-records-syntax"></span><h2><span class="section-number">7.15.11.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">in_records</span></code> has four or more parameters:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>in_records(condition_table,
value1, mode1, condition_column_name1,
...,
valueN, modeN, condition_column_nameN)
</pre></div>
</div>
</div>
<div class="section" id="usage">
<span id="in-records-usage"></span><h2><span class="section-number">7.15.11.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here is a schema definition and sample data.</p>
<p>Sample schema:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Tags TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Conditions TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Conditions user_pattern COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Conditions tag COLUMN_SCALAR Tags
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Conditions max_length COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Memos TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos user COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos tag COLUMN_SCALAR Tags
# [[0, 1337566253.89858, 0.000355720520019531], true]
</pre></div>
</div>
<p>Sample data:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Memos
[
{"_key": "Groonga is fast", "user": "alice", "tag": "groonga"},
{"_key": "Mroonga is fast", "user": "alice", "tag": "mroonga"},
{"_key": "Groonga is very good!", "user": "alice", "tag": "groonga"},
{"_key": "Droonga is fast", "user": "david", "tag": "droonga"},
{"_key": "Groonga is a HTTP server", "user": "david", "tag": "groonga"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]
</pre></div>
</div>
<p>Sample conditions:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Conditions
[
{"_key": "lic + groonga", "user_pattern": "lic", "tag": "groonga", max_length: 20},
{"_key": "dav + droonga", "user_pattern": "dav", "tag": "droonga", max_length: 50}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
</pre></div>
</div>
<p>Here is a simple usage of <code class="docutils literal notranslate"><span class="pre">in_records</span></code> that searches by records in <code class="docutils literal notranslate"><span class="pre">Conditions</span></code> table. Each record is used as a condition:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register functions/string
# [[0, 1337566253.89858, 0.000355720520019531], true]
select \
--table Memos \
--filter 'in_records(Conditions, \
user, "@", "user_pattern", \
tag, "==", "tag", \
string_length(_key), "<=", "max_length")' \
--sort_by _id \
--output_columns _key,user,tag
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "user",
# "ShortText"
# ],
# [
# "tag",
# "Tags"
# ]
# ],
# [
# "Groonga is fast",
# "alice",
# "groonga"
# ],
# [
# "Droonga is fast",
# "david",
# "droonga"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">filter</span></code> tries the following three conditions for each record:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.user</span></code> matches (<code class="docutils literal notranslate"><span class="pre">@</span></code>) <code class="docutils literal notranslate"><span class="pre">Conditions.user_pattern</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.tag</span></code> equals (<code class="docutils literal notranslate"><span class="pre">==</span></code>) <code class="docutils literal notranslate"><span class="pre">Conditions.tag</span></code>.</p></li>
<li><p>The number of characters in <code class="docutils literal notranslate"><span class="pre">Memos._key</span></code> is less than or equals to <code class="docutils literal notranslate"><span class="pre">Conditions.max_length</span></code>.</p></li>
</ul>
</div></blockquote>
<p>If at least one record in <code class="docutils literal notranslate"><span class="pre">Conditions</span></code> table returns true for the all three conditions, the record in <code class="docutils literal notranslate"><span class="pre">Memos</span></code> is matched.</p>
<p>The first record in <code class="docutils literal notranslate"><span class="pre">Conditions</span></code> table use the following conditions:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.user</span></code> has <code class="docutils literal notranslate"><span class="pre">"lic"</span></code> substring.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.tag</span></code> is <code class="docutils literal notranslate"><span class="pre">"groonga"</span></code>.</p></li>
<li><p>The number of characters in <code class="docutils literal notranslate"><span class="pre">Memos._key</span></code> is less than or equals to <code class="docutils literal notranslate"><span class="pre">20</span></code>.</p></li>
</ul>
</div></blockquote>
<p>This condition matches the following records:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">{"_key":</span> <span class="pre">"Groonga</span> <span class="pre">is</span> <span class="pre">fast",</span> <span class="pre">"user":</span> <span class="pre">"alice",</span> <span class="pre">"tag":</span> <span class="pre">"groonga"}</span></code></p></li>
</ul>
</div></blockquote>
<p>The second record in <code class="docutils literal notranslate"><span class="pre">Conditions</span></code> table use the following conditions:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.user</span></code> has <code class="docutils literal notranslate"><span class="pre">"dav"</span></code> substring.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Memos.tag</span></code> is <code class="docutils literal notranslate"><span class="pre">"droonga"</span></code>.</p></li>
<li><p>The number of characters in <code class="docutils literal notranslate"><span class="pre">Memos._key</span></code> is less than or equals to <code class="docutils literal notranslate"><span class="pre">50</span></code>.</p></li>
</ul>
</div></blockquote>
<p>This condition matches the following records:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">{"_key":</span> <span class="pre">"Droonga</span> <span class="pre">is</span> <span class="pre">fast",</span> <span class="pre">"user":</span> <span class="pre">"david",</span> <span class="pre">"tag":</span> <span class="pre">"droonga"}</span></code></p></li>
</ul>
</div></blockquote>
<p>The result has the all above records.</p>
</div>
<div class="section" id="parameters">
<span id="in-records-parameters"></span><h2><span class="section-number">7.15.11.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">in_records</span></code> requires four or more parameters.</p>
<div class="section" id="required-parameters">
<span id="in-records-required-parameters"></span><h3><span class="section-number">7.15.11.4.1. </span>Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">condition_table</span></code> and tuples of <code class="docutils literal notranslate"><span class="pre">value</span></code>, <code class="docutils literal notranslate"><span class="pre">mode_name</span></code> and <code class="docutils literal notranslate"><span class="pre">condition_column_name</span></code> are required. You can specify multiple tuples of <code class="docutils literal notranslate"><span class="pre">value</span></code>, <code class="docutils literal notranslate"><span class="pre">mode_name</span></code> and <code class="docutils literal notranslate"><span class="pre">condition_column_name</span></code></p>
<div class="section" id="condition-table">
<span id="in-records-condition-table"></span><h4><span class="section-number">7.15.11.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">condition_table</span></code><a class="headerlink" href="#condition-table" title="Permalink to this headline">¶</a></h4>
<p>Specifies a table that has conditions as its records.</p>
</div>
</div>
<div class="section" id="value">
<span id="in-records-value"></span><h3><span class="section-number">7.15.11.4.2. </span><code class="docutils literal notranslate"><span class="pre">value</span></code><a class="headerlink" href="#value" title="Permalink to this headline">¶</a></h3>
<p>Specifies a value to be compared.</p>
</div>
<div class="section" id="mode-name">
<span id="in-records-mode-name"></span><h3><span class="section-number">7.15.11.4.3. </span><code class="docutils literal notranslate"><span class="pre">mode_name</span></code><a class="headerlink" href="#mode-name" title="Permalink to this headline">¶</a></h3>
<p>Specifies a mode name that specifies how to compare <a class="reference internal" href="#in-records-value"><span class="std std-ref">value</span></a> with a value of <a class="reference internal" href="#in-records-condition-column-name"><span class="std std-ref">condition_column_name</span></a>.</p>
<p>See <a class="reference internal" href="query.html#query-default-mode"><span class="std std-ref">default_mode</span></a> for available mode names. All mode names
except <code class="docutils literal notranslate"><span class="pre">"NEAR"</span></code>, <code class="docutils literal notranslate"><span class="pre">"SIMILAR"</span></code> and <code class="docutils literal notranslate"><span class="pre">"SUFFIX"</span></code> are supported.</p>
</div>
<div class="section" id="condition-column-name">
<span id="in-records-condition-column-name"></span><h3><span class="section-number">7.15.11.4.4. </span><code class="docutils literal notranslate"><span class="pre">condition_column_name</span></code><a class="headerlink" href="#condition-column-name" title="Permalink to this headline">¶</a></h3>
<p>Specifies a column name of <a class="reference internal" href="#in-records-condition-table"><span class="std std-ref">condition_table</span></a> to be used as condition.</p>
</div>
<div class="section" id="optional-parameter">
<span id="in-records-optional-parameters"></span><h3><span class="section-number">7.15.11.4.5. </span>Optional parameter<a class="headerlink" href="#optional-parameter" title="Permalink to this headline">¶</a></h3>
<p>There are no optional parameter.</p>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.15.11.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">in_records</span></code> returns whether the record is matched one of records of the specified condition table or not.</p>
<p>If the record is matched, it returns <code class="docutils literal notranslate"><span class="pre">true</span></code>. Otherwise, it returns <code class="docutils literal notranslate"><span class="pre">false</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.15.11. <code class="docutils literal notranslate"><span class="pre">in_records</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.15.11.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.15.11.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.15.11.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.15.11.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameters">7.15.11.4.1. Required parameters</a><ul>
<li><a class="reference internal" href="#condition-table">7.15.11.4.1.1. <code class="docutils literal notranslate"><span class="pre">condition_table</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#value">7.15.11.4.2. <code class="docutils literal notranslate"><span class="pre">value</span></code></a></li>
<li><a class="reference internal" href="#mode-name">7.15.11.4.3. <code class="docutils literal notranslate"><span class="pre">mode_name</span></code></a></li>
<li><a class="reference internal" href="#condition-column-name">7.15.11.4.4. <code class="docutils literal notranslate"><span class="pre">condition_column_name</span></code></a></li>
<li><a class="reference internal" href="#optional-parameter">7.15.11.4.5. Optional parameter</a></li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.15.11.5. Return value</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="html_untag.html"
title="previous chapter"><span class="section-number">7.15.10. </span><code class="docutils literal notranslate"><span class="pre">html_untag</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="in_values.html"
title="next chapter"><span class="section-number">7.15.12. </span><code class="docutils literal notranslate"><span class="pre">in_values</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="in_values.html" title="7.15.12. in_values"
>next</a> |</li>
<li class="right" >
<a href="html_untag.html" title="7.15.10. html_untag"
>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.11. </span><code class="docutils literal notranslate"><span class="pre">in_records</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
