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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.15.1. between — 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.2. cast_loose" href="cast_loose.html" />
<link rel="prev" title="7.15. Function" href="../function.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/between.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="cast_loose.html" title="7.15.2. cast_loose"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../function.html" title="7.15. Function"
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.1. </span><code class="docutils literal notranslate"><span class="pre">between</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="between">
<h1><span class="section-number">7.15.1. </span><code class="docutils literal notranslate"><span class="pre">between</span></code><a class="headerlink" href="#between" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.15.1.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">between</span></code> is used for checking the specified value exists in the specific range.
It is often used in combination with <a class="reference internal" href="../commands/select.html#select-filter"><span class="std std-ref">filter</span></a> option in <a class="reference internal" href="../commands/select.html"><span class="doc">select</span></a>.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.15.1.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">between</span></code> has three or five parameters:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>between(column_or_value, min, max)
between(column_or_value, min, min_border, max, max_border)
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.15.1.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 Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Ages TABLE_HASH_KEY Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Ages user_age COLUMN_INDEX Users age
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice", "age": 12},
{"_key": "Bob", "age": 13},
{"_key": "Calros", "age": 15},
{"_key": "Dave", "age": 16},
{"_key": "Eric", "age": 20},
{"_key": "Frank", "age": 21}
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]
</pre></div>
</div>
<p>Here is a query to show users who match PG-13 rating (MPAA).</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Users --filter 'between(age, 13, "include", 16, "include")'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 3
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "age",
# "Int32"
# ]
# ],
# [
# 2,
# "Bob",
# 13
# ],
# [
# 3,
# "Calros",
# 15
# ],
# [
# 4,
# "Dave",
# 16
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>It returns 13, 14, 15 and 16 years old users.</p>
<p><code class="docutils literal notranslate"><span class="pre">between</span></code> function accepts not only a column but also a value.</p>
<p>If you specify a value as the 1st parameter, it checks whether the value is included or not. If the value matches the specified range, the <code class="docutils literal notranslate"><span class="pre">select</span></code> returns all the records because the <code class="docutils literal notranslate"><span class="pre">between</span></code> function returns true.
If it doesn’t match the specified range, the <code class="docutils literal notranslate"><span class="pre">select</span></code> returns no records because the <code class="docutils literal notranslate"><span class="pre">between</span></code> function returns false.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Users --filter 'between(14, 13, "include", 16, "include")'
</pre></div>
</div>
<p>In the above case, it returns all the records because 14 exists in between 13 and 16.
This behavior is used for checking the specified value exists or not in the table.</p>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.15.1.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<div class="section" id="required-parameters">
<h3><span class="section-number">7.15.1.4.1. </span>Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
<p>There are three required parameters <code class="docutils literal notranslate"><span class="pre">column_or_value</span></code>, <code class="docutils literal notranslate"><span class="pre">min</span></code> and <code class="docutils literal notranslate"><span class="pre">max</span></code>.</p>
<div class="section" id="column-or-value">
<h4><span class="section-number">7.15.1.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">column_or_value</span></code><a class="headerlink" href="#column-or-value" title="Permalink to this headline">¶</a></h4>
<p>Specifies a column or value.</p>
</div>
<div class="section" id="min">
<h4><span class="section-number">7.15.1.4.1.2. </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 minimal border value of the range.
The range is inclusive by default but you can control the behavior that the value of <code class="docutils literal notranslate"><span class="pre">min</span></code> is included or excluded with <code class="docutils literal notranslate"><span class="pre">min_border</span></code> parameter.</p>
</div>
<div class="section" id="max">
<h4><span class="section-number">7.15.1.4.1.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 border value of the range.
The range is inclusive by default but you can control the behavior that the value of <code class="docutils literal notranslate"><span class="pre">max</span></code> is included or excluded with <code class="docutils literal notranslate"><span class="pre">max_border</span></code> parameter.</p>
</div>
</div>
<div class="section" id="optional-parameter">
<h3><span class="section-number">7.15.1.4.2. </span>Optional parameter<a class="headerlink" href="#optional-parameter" title="Permalink to this headline">¶</a></h3>
<p>There are two optional parameters <code class="docutils literal notranslate"><span class="pre">min_border</span></code> and <code class="docutils literal notranslate"><span class="pre">max_border</span></code>.</p>
<div class="section" id="min-border">
<h4><span class="section-number">7.15.1.4.2.1. </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 specified range contains the value of <code class="docutils literal notranslate"><span class="pre">min</span></code> or not.
The value of <code class="docutils literal notranslate"><span class="pre">min_border</span></code> must be either “include” or “exclude”. If it is “include”, <code class="docutils literal notranslate"><span class="pre">min</span></code> value is included. If it is “exclude”, <code class="docutils literal notranslate"><span class="pre">min</span></code> value is not included.</p>
</div>
<div class="section" id="max-border">
<h4><span class="section-number">7.15.1.4.2.2. </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 specified range contains the value of <code class="docutils literal notranslate"><span class="pre">max</span></code> or not.
The value of <code class="docutils literal notranslate"><span class="pre">max_border</span></code> must be either “include” or “exclude”. If it is “include”, <code class="docutils literal notranslate"><span class="pre">max</span></code> value is included. If it is “exclude”, <code class="docutils literal notranslate"><span class="pre">max</span></code> value is not included.</p>
</div>
<div class="section" id="return-value">
<h4><span class="section-number">7.15.1.4.2.3. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">between</span></code> returns whether the column value exists in the specified range or not. If a record matches the specified range, it returns true. Otherwise, it returns false.</p>
</div>
</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.15.1. <code class="docutils literal notranslate"><span class="pre">between</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.15.1.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.15.1.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.15.1.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.15.1.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameters">7.15.1.4.1. Required parameters</a><ul>
<li><a class="reference internal" href="#column-or-value">7.15.1.4.1.1. <code class="docutils literal notranslate"><span class="pre">column_or_value</span></code></a></li>
<li><a class="reference internal" href="#min">7.15.1.4.1.2. <code class="docutils literal notranslate"><span class="pre">min</span></code></a></li>
<li><a class="reference internal" href="#max">7.15.1.4.1.3. <code class="docutils literal notranslate"><span class="pre">max</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#optional-parameter">7.15.1.4.2. Optional parameter</a><ul>
<li><a class="reference internal" href="#min-border">7.15.1.4.2.1. <code class="docutils literal notranslate"><span class="pre">min_border</span></code></a></li>
<li><a class="reference internal" href="#max-border">7.15.1.4.2.2. <code class="docutils literal notranslate"><span class="pre">max_border</span></code></a></li>
<li><a class="reference internal" href="#return-value">7.15.1.4.2.3. Return value</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../function.html"
title="previous chapter"><span class="section-number">7.15. </span>Function</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="cast_loose.html"
title="next chapter"><span class="section-number">7.15.2. </span><code class="docutils literal notranslate"><span class="pre">cast_loose</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="cast_loose.html" title="7.15.2. cast_loose"
>next</a> |</li>
<li class="right" >
<a href="../function.html" title="7.15. Function"
>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.1. </span><code class="docutils literal notranslate"><span class="pre">between</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
