built.io 0.1 → 0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/doc/Built.html +518 -0
- data/doc/Built/Application.html +449 -0
- data/doc/Built/BuiltAPIError.html +460 -0
- data/doc/Built/BuiltError.html +138 -0
- data/doc/Built/Class.html +685 -0
- data/doc/Built/Client.html +397 -0
- data/doc/Built/Object.html +1128 -0
- data/doc/Built/Query.html +2788 -0
- data/doc/Built/QueryResponse.html +386 -0
- data/doc/Built/Timestamps.html +282 -0
- data/doc/Built/Util.html +211 -0
- data/doc/_index.html +228 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.README.html +131 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +131 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +178 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +419 -0
- data/doc/top-level-namespace.html +151 -0
- metadata +26 -1
|
@@ -0,0 +1,2788 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Built::Query
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.2
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../';
|
|
20
|
+
framesUrl = "../frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../_index.html">Index (Q)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../Built.html" title="Built (module)">Built</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Query</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: Built::Query
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Built::Query</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/built/query.rb</dd>
|
|
98
|
+
|
|
99
|
+
</dl>
|
|
100
|
+
<div class="clear"></div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Perform a query on objects of a class</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
118
|
+
<ul class="summary">
|
|
119
|
+
|
|
120
|
+
<li class="public ">
|
|
121
|
+
<span class="summary_signature">
|
|
122
|
+
|
|
123
|
+
<a href="#params-instance_method" title="#params (instance method)">- (Object) <strong>params</strong> </a>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<span class="summary_desc"><div class='inline'>
|
|
141
|
+
<p>Returns the value of attribute params.</p>
|
|
142
|
+
</div></span>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</ul>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<h2>
|
|
154
|
+
Instance Method Summary
|
|
155
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
156
|
+
</h2>
|
|
157
|
+
|
|
158
|
+
<ul class="summary">
|
|
159
|
+
|
|
160
|
+
<li class="public ">
|
|
161
|
+
<span class="summary_signature">
|
|
162
|
+
|
|
163
|
+
<a href="#ascending-instance_method" title="#ascending (instance method)">- (Query) <strong>ascending</strong>(key) </a>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
</span>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="summary_desc"><div class='inline'>
|
|
178
|
+
<p>Sort results in ascending order for the given key.</p>
|
|
179
|
+
</div></span>
|
|
180
|
+
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<li class="public ">
|
|
185
|
+
<span class="summary_signature">
|
|
186
|
+
|
|
187
|
+
<a href="#contained_in-instance_method" title="#contained_in (instance method)">- (Query) <strong>contained_in</strong>(key, array) </a>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class="summary_desc"><div class='inline'>
|
|
202
|
+
<p>To check that the value for a key is contained in a given array.</p>
|
|
203
|
+
</div></span>
|
|
204
|
+
|
|
205
|
+
</li>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<li class="public ">
|
|
209
|
+
<span class="summary_signature">
|
|
210
|
+
|
|
211
|
+
<a href="#count-instance_method" title="#count (instance method)">- (Query) <strong>count</strong> </a>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<span class="summary_desc"><div class='inline'>
|
|
226
|
+
<p>Return the count of objects instead of the result of the query.</p>
|
|
227
|
+
</div></span>
|
|
228
|
+
|
|
229
|
+
</li>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
<li class="public ">
|
|
233
|
+
<span class="summary_signature">
|
|
234
|
+
|
|
235
|
+
<a href="#descending-instance_method" title="#descending (instance method)">- (Query) <strong>descending</strong>(key) </a>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</span>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class="summary_desc"><div class='inline'>
|
|
250
|
+
<p>Sort results in descending order for the given key.</p>
|
|
251
|
+
</div></span>
|
|
252
|
+
|
|
253
|
+
</li>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<li class="public ">
|
|
257
|
+
<span class="summary_signature">
|
|
258
|
+
|
|
259
|
+
<a href="#exec-instance_method" title="#exec (instance method)">- (QueryResponse) <strong>exec</strong> </a>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<span class="summary_desc"><div class='inline'>
|
|
274
|
+
<p>Execute the query.</p>
|
|
275
|
+
</div></span>
|
|
276
|
+
|
|
277
|
+
</li>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<li class="public ">
|
|
281
|
+
<span class="summary_signature">
|
|
282
|
+
|
|
283
|
+
<a href="#exists-instance_method" title="#exists (instance method)">- (Query) <strong>exists</strong>(key) </a>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<span class="summary_desc"><div class='inline'>
|
|
298
|
+
<p>To check that the given key exists.</p>
|
|
299
|
+
</div></span>
|
|
300
|
+
|
|
301
|
+
</li>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<li class="public ">
|
|
305
|
+
<span class="summary_signature">
|
|
306
|
+
|
|
307
|
+
<a href="#greater_than-instance_method" title="#greater_than (instance method)">- (Query) <strong>greater_than</strong>(key, value) </a>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</span>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="summary_desc"><div class='inline'>
|
|
322
|
+
<p>To check that the key has a value greater than the one specified.</p>
|
|
323
|
+
</div></span>
|
|
324
|
+
|
|
325
|
+
</li>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<li class="public ">
|
|
329
|
+
<span class="summary_signature">
|
|
330
|
+
|
|
331
|
+
<a href="#greater_than_equal-instance_method" title="#greater_than_equal (instance method)">- (Query) <strong>greater_than_equal</strong>(key, value) </a>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
<span class="summary_desc"><div class='inline'>
|
|
346
|
+
<p>To check that the key has a value greater than OR equaling the one
|
|
347
|
+
specified.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#in_query-instance_method" title="#in_query (instance method)">- (Object) <strong>in_query</strong>(key, query) </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'>
|
|
371
|
+
<p>Reference query a field.</p>
|
|
372
|
+
</div></span>
|
|
373
|
+
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#include-instance_method" title="#include (instance method)">- (Query) <strong>include</strong>(key) </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>Include reference fields in the response (joins).</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#include_count-instance_method" title="#include_count (instance method)">- (Query) <strong>include_count</strong> </a>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
|
419
|
+
<p>Include the count of objects matching the query in the result.</p>
|
|
420
|
+
</div></span>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#include_drafts-instance_method" title="#include_drafts (instance method)">- (Query) <strong>include_drafts</strong> </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>Include draft objects that haven't been published yet.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<li class="public ">
|
|
450
|
+
<span class="summary_signature">
|
|
451
|
+
|
|
452
|
+
<a href="#include_owner-instance_method" title="#include_owner (instance method)">- (Query) <strong>include_owner</strong> </a>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</span>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>Include the owner of the object in the parameter _owner.</p>
|
|
468
|
+
</div></span>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<li class="public ">
|
|
474
|
+
<span class="summary_signature">
|
|
475
|
+
|
|
476
|
+
<a href="#include_schema-instance_method" title="#include_schema (instance method)">- (Query) <strong>include_schema</strong> </a>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
<span class="summary_desc"><div class='inline'>
|
|
491
|
+
<p>Include the schema of the class in the result.</p>
|
|
492
|
+
</div></span>
|
|
493
|
+
|
|
494
|
+
</li>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<li class="public ">
|
|
498
|
+
<span class="summary_signature">
|
|
499
|
+
|
|
500
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Query) <strong>initialize</strong>(class_uid = nil) </a>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<span class="note title constructor">constructor</span>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<span class="summary_desc"><div class='inline'>
|
|
517
|
+
<p>Create a new query.</p>
|
|
518
|
+
</div></span>
|
|
519
|
+
|
|
520
|
+
</li>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
<li class="public ">
|
|
524
|
+
<span class="summary_signature">
|
|
525
|
+
|
|
526
|
+
<a href="#less_than-instance_method" title="#less_than (instance method)">- (Query) <strong>less_than</strong>(key, value) </a>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</span>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<span class="summary_desc"><div class='inline'>
|
|
541
|
+
<p>To check that the key has a value less than the one specified.</p>
|
|
542
|
+
</div></span>
|
|
543
|
+
|
|
544
|
+
</li>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<li class="public ">
|
|
548
|
+
<span class="summary_signature">
|
|
549
|
+
|
|
550
|
+
<a href="#less_than_equal-instance_method" title="#less_than_equal (instance method)">- (Query) <strong>less_than_equal</strong>(key, value) </a>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
</span>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
<span class="summary_desc"><div class='inline'>
|
|
565
|
+
<p>To check that the key has a value less than OR equaling the one specified.</p>
|
|
566
|
+
</div></span>
|
|
567
|
+
|
|
568
|
+
</li>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<li class="public ">
|
|
572
|
+
<span class="summary_signature">
|
|
573
|
+
|
|
574
|
+
<a href="#limit-instance_method" title="#limit (instance method)">- (Query) <strong>limit</strong>(number) </a>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
</span>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<span class="summary_desc"><div class='inline'>
|
|
589
|
+
<p>Limit the number of results to a given number.</p>
|
|
590
|
+
</div></span>
|
|
591
|
+
|
|
592
|
+
</li>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<li class="public ">
|
|
596
|
+
<span class="summary_signature">
|
|
597
|
+
|
|
598
|
+
<a href="#not_contained_in-instance_method" title="#not_contained_in (instance method)">- (Query) <strong>not_contained_in</strong>(key, array) </a>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</span>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<span class="summary_desc"><div class='inline'>
|
|
613
|
+
<p>To check that the value for a key is NOT contained in a given array.</p>
|
|
614
|
+
</div></span>
|
|
615
|
+
|
|
616
|
+
</li>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
<li class="public ">
|
|
620
|
+
<span class="summary_signature">
|
|
621
|
+
|
|
622
|
+
<a href="#not_equal-instance_method" title="#not_equal (instance method)">- (Query) <strong>not_equal</strong>(key, value) </a>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
</span>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
<span class="summary_desc"><div class='inline'>
|
|
637
|
+
<p>To check that the key has a value not equaling the one specified.</p>
|
|
638
|
+
</div></span>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
<li class="public ">
|
|
644
|
+
<span class="summary_signature">
|
|
645
|
+
|
|
646
|
+
<a href="#not_exists-instance_method" title="#not_exists (instance method)">- (Query) <strong>not_exists</strong>(key) </a>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
</span>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
<span class="summary_desc"><div class='inline'>
|
|
661
|
+
<p>To check that the given key does not exist.</p>
|
|
662
|
+
</div></span>
|
|
663
|
+
|
|
664
|
+
</li>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<li class="public ">
|
|
668
|
+
<span class="summary_signature">
|
|
669
|
+
|
|
670
|
+
<a href="#not_in_query-instance_method" title="#not_in_query (instance method)">- (Object) <strong>not_in_query</strong>(key, query) </a>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
</span>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<span class="summary_desc"><div class='inline'>
|
|
685
|
+
<p>Reference query a field negatively.</p>
|
|
686
|
+
</div></span>
|
|
687
|
+
|
|
688
|
+
</li>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
<li class="public ">
|
|
692
|
+
<span class="summary_signature">
|
|
693
|
+
|
|
694
|
+
<a href="#skip-instance_method" title="#skip (instance method)">- (Query) <strong>skip</strong>(number) </a>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
</span>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
<span class="summary_desc"><div class='inline'>
|
|
709
|
+
<p>Skip a give number of results.</p>
|
|
710
|
+
</div></span>
|
|
711
|
+
|
|
712
|
+
</li>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<li class="public ">
|
|
716
|
+
<span class="summary_signature">
|
|
717
|
+
|
|
718
|
+
<a href="#where-instance_method" title="#where (instance method)">- (Query) <strong>where</strong>(key, value) </a>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
</span>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<span class="summary_desc"><div class='inline'>
|
|
733
|
+
<p>Where given key matches value.</p>
|
|
734
|
+
</div></span>
|
|
735
|
+
|
|
736
|
+
</li>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
</ul>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<div id="constructor_details" class="method_details_list">
|
|
743
|
+
<h2>Constructor Details</h2>
|
|
744
|
+
|
|
745
|
+
<div class="method_details first">
|
|
746
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
747
|
+
|
|
748
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>initialize</strong>(class_uid = nil)
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
</h3><div class="docstring">
|
|
755
|
+
<div class="discussion">
|
|
756
|
+
|
|
757
|
+
<p>Create a new query</p>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</div>
|
|
761
|
+
</div>
|
|
762
|
+
<div class="tags">
|
|
763
|
+
|
|
764
|
+
<div class="examples">
|
|
765
|
+
<p class="tag_title">Examples:</p>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
<pre class="example code"><code><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'>Query</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>people</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
769
|
+
|
|
770
|
+
<span class='id identifier rubyid_query'>query</span><span class='period'>
|
|
771
|
+
</span><span class='id identifier rubyid_ .containedIn'> .containedIn</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>name</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>James</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>
|
|
772
|
+
</span><span class='id identifier rubyid_ .greaterThan'> .greaterThan</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>age</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>30</span><span class='rparen'>)</span><span class='period'>
|
|
773
|
+
</span><span class='id identifier rubyid_ .include_count'> .include_count</span>
|
|
774
|
+
|
|
775
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_exec'>exec</span>
|
|
776
|
+
|
|
777
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_objects'>objects</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
778
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span></code></pre>
|
|
779
|
+
|
|
780
|
+
</div>
|
|
781
|
+
<p class="tag_title">Parameters:</p>
|
|
782
|
+
<ul class="param">
|
|
783
|
+
|
|
784
|
+
<li>
|
|
785
|
+
|
|
786
|
+
<span class='name'>class_uid</span>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
—
|
|
796
|
+
<div class='inline'>
|
|
797
|
+
<p>The uid of the class for querying</p>
|
|
798
|
+
</div>
|
|
799
|
+
|
|
800
|
+
</li>
|
|
801
|
+
|
|
802
|
+
</ul>
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
</div><table class="source_code">
|
|
806
|
+
<tr>
|
|
807
|
+
<td>
|
|
808
|
+
<pre class="lines">
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
20
|
|
812
|
+
21
|
|
813
|
+
22
|
|
814
|
+
23
|
|
815
|
+
24
|
|
816
|
+
25</pre>
|
|
817
|
+
</td>
|
|
818
|
+
<td>
|
|
819
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 20</span>
|
|
820
|
+
|
|
821
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_class_uid'>class_uid</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
822
|
+
<span class='ivar'>@class_uid</span> <span class='op'>=</span> <span class='id identifier rubyid_class_uid'>class_uid</span>
|
|
823
|
+
<span class='ivar'>@params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
824
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
825
|
+
<span class='rbrace'>}</span>
|
|
826
|
+
<span class='kw'>end</span></pre>
|
|
827
|
+
</td>
|
|
828
|
+
</tr>
|
|
829
|
+
</table>
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
<div id="instance_attr_details" class="attr_details">
|
|
835
|
+
<h2>Instance Attribute Details</h2>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
<span id="params=-instance_method"></span>
|
|
839
|
+
<div class="method_details first">
|
|
840
|
+
<h3 class="signature first" id="params-instance_method">
|
|
841
|
+
|
|
842
|
+
- (<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>params</strong>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</h3><div class="docstring">
|
|
849
|
+
<div class="discussion">
|
|
850
|
+
|
|
851
|
+
<p>Returns the value of attribute params</p>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
</div>
|
|
855
|
+
</div>
|
|
856
|
+
<div class="tags">
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
</div><table class="source_code">
|
|
860
|
+
<tr>
|
|
861
|
+
<td>
|
|
862
|
+
<pre class="lines">
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
4
|
|
866
|
+
5
|
|
867
|
+
6</pre>
|
|
868
|
+
</td>
|
|
869
|
+
<td>
|
|
870
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 4</span>
|
|
871
|
+
|
|
872
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
|
|
873
|
+
<span class='ivar'>@params</span>
|
|
874
|
+
<span class='kw'>end</span></pre>
|
|
875
|
+
</td>
|
|
876
|
+
</tr>
|
|
877
|
+
</table>
|
|
878
|
+
</div>
|
|
879
|
+
|
|
880
|
+
</div>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
<div id="instance_method_details" class="method_details_list">
|
|
884
|
+
<h2>Instance Method Details</h2>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<div class="method_details first">
|
|
888
|
+
<h3 class="signature first" id="ascending-instance_method">
|
|
889
|
+
|
|
890
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>ascending</strong>(key)
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
</h3><div class="docstring">
|
|
897
|
+
<div class="discussion">
|
|
898
|
+
|
|
899
|
+
<p>Sort results in ascending order for the given key</p>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
</div>
|
|
903
|
+
</div>
|
|
904
|
+
<div class="tags">
|
|
905
|
+
<p class="tag_title">Parameters:</p>
|
|
906
|
+
<ul class="param">
|
|
907
|
+
|
|
908
|
+
<li>
|
|
909
|
+
|
|
910
|
+
<span class='name'>key</span>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
—
|
|
918
|
+
<div class='inline'>
|
|
919
|
+
<p>The key by which to sort</p>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</li>
|
|
923
|
+
|
|
924
|
+
</ul>
|
|
925
|
+
|
|
926
|
+
<p class="tag_title">Returns:</p>
|
|
927
|
+
<ul class="return">
|
|
928
|
+
|
|
929
|
+
<li>
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
—
|
|
937
|
+
<div class='inline'>
|
|
938
|
+
<p>self</p>
|
|
939
|
+
</div>
|
|
940
|
+
|
|
941
|
+
</li>
|
|
942
|
+
|
|
943
|
+
</ul>
|
|
944
|
+
|
|
945
|
+
</div><table class="source_code">
|
|
946
|
+
<tr>
|
|
947
|
+
<td>
|
|
948
|
+
<pre class="lines">
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
90
|
|
952
|
+
91
|
|
953
|
+
92
|
|
954
|
+
93
|
|
955
|
+
94</pre>
|
|
956
|
+
</td>
|
|
957
|
+
<td>
|
|
958
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 90</span>
|
|
959
|
+
|
|
960
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ascending'>ascending</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
961
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>asc</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span>
|
|
962
|
+
|
|
963
|
+
<span class='kw'>self</span>
|
|
964
|
+
<span class='kw'>end</span></pre>
|
|
965
|
+
</td>
|
|
966
|
+
</tr>
|
|
967
|
+
</table>
|
|
968
|
+
</div>
|
|
969
|
+
|
|
970
|
+
<div class="method_details ">
|
|
971
|
+
<h3 class="signature " id="contained_in-instance_method">
|
|
972
|
+
|
|
973
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>contained_in</strong>(key, array)
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
</h3><div class="docstring">
|
|
980
|
+
<div class="discussion">
|
|
981
|
+
|
|
982
|
+
<p>To check that the value for a key is contained in a given array</p>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
</div>
|
|
986
|
+
</div>
|
|
987
|
+
<div class="tags">
|
|
988
|
+
<p class="tag_title">Parameters:</p>
|
|
989
|
+
<ul class="param">
|
|
990
|
+
|
|
991
|
+
<li>
|
|
992
|
+
|
|
993
|
+
<span class='name'>key</span>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
—
|
|
1001
|
+
<div class='inline'>
|
|
1002
|
+
<p>The key to check</p>
|
|
1003
|
+
</div>
|
|
1004
|
+
|
|
1005
|
+
</li>
|
|
1006
|
+
|
|
1007
|
+
<li>
|
|
1008
|
+
|
|
1009
|
+
<span class='name'>array</span>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
—
|
|
1017
|
+
<div class='inline'>
|
|
1018
|
+
<p>An array of values</p>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
</li>
|
|
1022
|
+
|
|
1023
|
+
</ul>
|
|
1024
|
+
|
|
1025
|
+
<p class="tag_title">Returns:</p>
|
|
1026
|
+
<ul class="return">
|
|
1027
|
+
|
|
1028
|
+
<li>
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
—
|
|
1036
|
+
<div class='inline'>
|
|
1037
|
+
<p>self</p>
|
|
1038
|
+
</div>
|
|
1039
|
+
|
|
1040
|
+
</li>
|
|
1041
|
+
|
|
1042
|
+
</ul>
|
|
1043
|
+
|
|
1044
|
+
</div><table class="source_code">
|
|
1045
|
+
<tr>
|
|
1046
|
+
<td>
|
|
1047
|
+
<pre class="lines">
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
109
|
|
1051
|
+
110
|
|
1052
|
+
111
|
|
1053
|
+
112
|
|
1054
|
+
113</pre>
|
|
1055
|
+
</td>
|
|
1056
|
+
<td>
|
|
1057
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 109</span>
|
|
1058
|
+
|
|
1059
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_contained_in'>contained_in</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='rparen'>)</span>
|
|
1060
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$in</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_array'>array</span><span class='rbrace'>}</span>
|
|
1061
|
+
|
|
1062
|
+
<span class='kw'>self</span>
|
|
1063
|
+
<span class='kw'>end</span></pre>
|
|
1064
|
+
</td>
|
|
1065
|
+
</tr>
|
|
1066
|
+
</table>
|
|
1067
|
+
</div>
|
|
1068
|
+
|
|
1069
|
+
<div class="method_details ">
|
|
1070
|
+
<h3 class="signature " id="count-instance_method">
|
|
1071
|
+
|
|
1072
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>count</strong>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</h3><div class="docstring">
|
|
1079
|
+
<div class="discussion">
|
|
1080
|
+
|
|
1081
|
+
<p>Return the count of objects instead of the result of the query</p>
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
</div>
|
|
1085
|
+
</div>
|
|
1086
|
+
<div class="tags">
|
|
1087
|
+
|
|
1088
|
+
<p class="tag_title">Returns:</p>
|
|
1089
|
+
<ul class="return">
|
|
1090
|
+
|
|
1091
|
+
<li>
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
—
|
|
1099
|
+
<div class='inline'>
|
|
1100
|
+
<p>self</p>
|
|
1101
|
+
</div>
|
|
1102
|
+
|
|
1103
|
+
</li>
|
|
1104
|
+
|
|
1105
|
+
</ul>
|
|
1106
|
+
|
|
1107
|
+
</div><table class="source_code">
|
|
1108
|
+
<tr>
|
|
1109
|
+
<td>
|
|
1110
|
+
<pre class="lines">
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
181
|
|
1114
|
+
182
|
|
1115
|
+
183
|
|
1116
|
+
184
|
|
1117
|
+
185</pre>
|
|
1118
|
+
</td>
|
|
1119
|
+
<td>
|
|
1120
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 181</span>
|
|
1121
|
+
|
|
1122
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
|
|
1123
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>count</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1124
|
+
|
|
1125
|
+
<span class='kw'>self</span>
|
|
1126
|
+
<span class='kw'>end</span></pre>
|
|
1127
|
+
</td>
|
|
1128
|
+
</tr>
|
|
1129
|
+
</table>
|
|
1130
|
+
</div>
|
|
1131
|
+
|
|
1132
|
+
<div class="method_details ">
|
|
1133
|
+
<h3 class="signature " id="descending-instance_method">
|
|
1134
|
+
|
|
1135
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>descending</strong>(key)
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
</h3><div class="docstring">
|
|
1142
|
+
<div class="discussion">
|
|
1143
|
+
|
|
1144
|
+
<p>Sort results in descending order for the given key</p>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
</div>
|
|
1148
|
+
</div>
|
|
1149
|
+
<div class="tags">
|
|
1150
|
+
<p class="tag_title">Parameters:</p>
|
|
1151
|
+
<ul class="param">
|
|
1152
|
+
|
|
1153
|
+
<li>
|
|
1154
|
+
|
|
1155
|
+
<span class='name'>key</span>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
—
|
|
1163
|
+
<div class='inline'>
|
|
1164
|
+
<p>The key by which to sort</p>
|
|
1165
|
+
</div>
|
|
1166
|
+
|
|
1167
|
+
</li>
|
|
1168
|
+
|
|
1169
|
+
</ul>
|
|
1170
|
+
|
|
1171
|
+
<p class="tag_title">Returns:</p>
|
|
1172
|
+
<ul class="return">
|
|
1173
|
+
|
|
1174
|
+
<li>
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
—
|
|
1182
|
+
<div class='inline'>
|
|
1183
|
+
<p>self</p>
|
|
1184
|
+
</div>
|
|
1185
|
+
|
|
1186
|
+
</li>
|
|
1187
|
+
|
|
1188
|
+
</ul>
|
|
1189
|
+
|
|
1190
|
+
</div><table class="source_code">
|
|
1191
|
+
<tr>
|
|
1192
|
+
<td>
|
|
1193
|
+
<pre class="lines">
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
99
|
|
1197
|
+
100
|
|
1198
|
+
101
|
|
1199
|
+
102
|
|
1200
|
+
103</pre>
|
|
1201
|
+
</td>
|
|
1202
|
+
<td>
|
|
1203
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 99</span>
|
|
1204
|
+
|
|
1205
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_descending'>descending</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
1206
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>desc</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span>
|
|
1207
|
+
|
|
1208
|
+
<span class='kw'>self</span>
|
|
1209
|
+
<span class='kw'>end</span></pre>
|
|
1210
|
+
</td>
|
|
1211
|
+
</tr>
|
|
1212
|
+
</table>
|
|
1213
|
+
</div>
|
|
1214
|
+
|
|
1215
|
+
<div class="method_details ">
|
|
1216
|
+
<h3 class="signature " id="exec-instance_method">
|
|
1217
|
+
|
|
1218
|
+
- (<tt><span class='object_link'><a href="QueryResponse.html" title="Built::QueryResponse (class)">QueryResponse</a></span></tt>) <strong>exec</strong>
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
</h3><div class="docstring">
|
|
1225
|
+
<div class="discussion">
|
|
1226
|
+
|
|
1227
|
+
<p>Execute the query</p>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
</div>
|
|
1231
|
+
</div>
|
|
1232
|
+
<div class="tags">
|
|
1233
|
+
|
|
1234
|
+
<p class="tag_title">Returns:</p>
|
|
1235
|
+
<ul class="return">
|
|
1236
|
+
|
|
1237
|
+
<li>
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
<span class='type'>(<tt><span class='object_link'><a href="QueryResponse.html" title="Built::QueryResponse (class)">QueryResponse</a></span></tt>)</span>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
—
|
|
1245
|
+
<div class='inline'>
|
|
1246
|
+
<p>response A hash containing the response</p>
|
|
1247
|
+
</div>
|
|
1248
|
+
|
|
1249
|
+
</li>
|
|
1250
|
+
|
|
1251
|
+
</ul>
|
|
1252
|
+
|
|
1253
|
+
</div><table class="source_code">
|
|
1254
|
+
<tr>
|
|
1255
|
+
<td>
|
|
1256
|
+
<pre class="lines">
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
231
|
|
1260
|
+
232
|
|
1261
|
+
233
|
|
1262
|
+
234
|
|
1263
|
+
235
|
|
1264
|
+
236
|
|
1265
|
+
237
|
|
1266
|
+
238
|
|
1267
|
+
239
|
|
1268
|
+
240
|
|
1269
|
+
241
|
|
1270
|
+
242</pre>
|
|
1271
|
+
</td>
|
|
1272
|
+
<td>
|
|
1273
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 231</span>
|
|
1274
|
+
|
|
1275
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exec'>exec</span>
|
|
1276
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@class_uid</span>
|
|
1277
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>querying.class_uid</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1278
|
+
<span class='kw'>end</span>
|
|
1279
|
+
|
|
1280
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>Built</span><span class='op'>::</span><span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_uri'>uri</span><span class='lparen'>(</span><span class='ivar'>@class_uid</span><span class='rparen'>)</span>
|
|
1281
|
+
|
|
1282
|
+
<span class='const'>QueryResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
|
|
1283
|
+
<span class='const'>Built</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='ivar'>@params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span><span class='comma'>,</span>
|
|
1284
|
+
<span class='ivar'>@class_uid</span>
|
|
1285
|
+
<span class='rparen'>)</span>
|
|
1286
|
+
<span class='kw'>end</span></pre>
|
|
1287
|
+
</td>
|
|
1288
|
+
</tr>
|
|
1289
|
+
</table>
|
|
1290
|
+
</div>
|
|
1291
|
+
|
|
1292
|
+
<div class="method_details ">
|
|
1293
|
+
<h3 class="signature " id="exists-instance_method">
|
|
1294
|
+
|
|
1295
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>exists</strong>(key)
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
</h3><div class="docstring">
|
|
1302
|
+
<div class="discussion">
|
|
1303
|
+
|
|
1304
|
+
<p>To check that the given key exists</p>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
</div>
|
|
1308
|
+
</div>
|
|
1309
|
+
<div class="tags">
|
|
1310
|
+
<p class="tag_title">Parameters:</p>
|
|
1311
|
+
<ul class="param">
|
|
1312
|
+
|
|
1313
|
+
<li>
|
|
1314
|
+
|
|
1315
|
+
<span class='name'>key</span>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
</li>
|
|
1323
|
+
|
|
1324
|
+
</ul>
|
|
1325
|
+
|
|
1326
|
+
<p class="tag_title">Returns:</p>
|
|
1327
|
+
<ul class="return">
|
|
1328
|
+
|
|
1329
|
+
<li>
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
—
|
|
1337
|
+
<div class='inline'>
|
|
1338
|
+
<p>self</p>
|
|
1339
|
+
</div>
|
|
1340
|
+
|
|
1341
|
+
</li>
|
|
1342
|
+
|
|
1343
|
+
</ul>
|
|
1344
|
+
|
|
1345
|
+
</div><table class="source_code">
|
|
1346
|
+
<tr>
|
|
1347
|
+
<td>
|
|
1348
|
+
<pre class="lines">
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
128
|
|
1352
|
+
129
|
|
1353
|
+
130
|
|
1354
|
+
131
|
|
1355
|
+
132</pre>
|
|
1356
|
+
</td>
|
|
1357
|
+
<td>
|
|
1358
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 128</span>
|
|
1359
|
+
|
|
1360
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exists'>exists</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
1361
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$exists</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>true</span><span class='rbrace'>}</span>
|
|
1362
|
+
|
|
1363
|
+
<span class='kw'>self</span>
|
|
1364
|
+
<span class='kw'>end</span></pre>
|
|
1365
|
+
</td>
|
|
1366
|
+
</tr>
|
|
1367
|
+
</table>
|
|
1368
|
+
</div>
|
|
1369
|
+
|
|
1370
|
+
<div class="method_details ">
|
|
1371
|
+
<h3 class="signature " id="greater_than-instance_method">
|
|
1372
|
+
|
|
1373
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>greater_than</strong>(key, value)
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
</h3><div class="docstring">
|
|
1380
|
+
<div class="discussion">
|
|
1381
|
+
|
|
1382
|
+
<p>To check that the key has a value greater than the one specified</p>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
</div>
|
|
1386
|
+
</div>
|
|
1387
|
+
<div class="tags">
|
|
1388
|
+
<p class="tag_title">Parameters:</p>
|
|
1389
|
+
<ul class="param">
|
|
1390
|
+
|
|
1391
|
+
<li>
|
|
1392
|
+
|
|
1393
|
+
<span class='name'>key</span>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
—
|
|
1401
|
+
<div class='inline'>
|
|
1402
|
+
<p>The key</p>
|
|
1403
|
+
</div>
|
|
1404
|
+
|
|
1405
|
+
</li>
|
|
1406
|
+
|
|
1407
|
+
<li>
|
|
1408
|
+
|
|
1409
|
+
<span class='name'>value</span>
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
—
|
|
1417
|
+
<div class='inline'>
|
|
1418
|
+
<p>The value</p>
|
|
1419
|
+
</div>
|
|
1420
|
+
|
|
1421
|
+
</li>
|
|
1422
|
+
|
|
1423
|
+
</ul>
|
|
1424
|
+
|
|
1425
|
+
<p class="tag_title">Returns:</p>
|
|
1426
|
+
<ul class="return">
|
|
1427
|
+
|
|
1428
|
+
<li>
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
—
|
|
1436
|
+
<div class='inline'>
|
|
1437
|
+
<p>self</p>
|
|
1438
|
+
</div>
|
|
1439
|
+
|
|
1440
|
+
</li>
|
|
1441
|
+
|
|
1442
|
+
</ul>
|
|
1443
|
+
|
|
1444
|
+
</div><table class="source_code">
|
|
1445
|
+
<tr>
|
|
1446
|
+
<td>
|
|
1447
|
+
<pre class="lines">
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
41
|
|
1451
|
+
42
|
|
1452
|
+
43
|
|
1453
|
+
44
|
|
1454
|
+
45</pre>
|
|
1455
|
+
</td>
|
|
1456
|
+
<td>
|
|
1457
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 41</span>
|
|
1458
|
+
|
|
1459
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_greater_than'>greater_than</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
1460
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$gt</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span>
|
|
1461
|
+
|
|
1462
|
+
<span class='kw'>self</span>
|
|
1463
|
+
<span class='kw'>end</span></pre>
|
|
1464
|
+
</td>
|
|
1465
|
+
</tr>
|
|
1466
|
+
</table>
|
|
1467
|
+
</div>
|
|
1468
|
+
|
|
1469
|
+
<div class="method_details ">
|
|
1470
|
+
<h3 class="signature " id="greater_than_equal-instance_method">
|
|
1471
|
+
|
|
1472
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>greater_than_equal</strong>(key, value)
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
</h3><div class="docstring">
|
|
1479
|
+
<div class="discussion">
|
|
1480
|
+
|
|
1481
|
+
<p>To check that the key has a value greater than OR equaling the one
|
|
1482
|
+
specified</p>
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
</div>
|
|
1486
|
+
</div>
|
|
1487
|
+
<div class="tags">
|
|
1488
|
+
<p class="tag_title">Parameters:</p>
|
|
1489
|
+
<ul class="param">
|
|
1490
|
+
|
|
1491
|
+
<li>
|
|
1492
|
+
|
|
1493
|
+
<span class='name'>key</span>
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
—
|
|
1501
|
+
<div class='inline'>
|
|
1502
|
+
<p>The key</p>
|
|
1503
|
+
</div>
|
|
1504
|
+
|
|
1505
|
+
</li>
|
|
1506
|
+
|
|
1507
|
+
<li>
|
|
1508
|
+
|
|
1509
|
+
<span class='name'>value</span>
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
—
|
|
1517
|
+
<div class='inline'>
|
|
1518
|
+
<p>The value</p>
|
|
1519
|
+
</div>
|
|
1520
|
+
|
|
1521
|
+
</li>
|
|
1522
|
+
|
|
1523
|
+
</ul>
|
|
1524
|
+
|
|
1525
|
+
<p class="tag_title">Returns:</p>
|
|
1526
|
+
<ul class="return">
|
|
1527
|
+
|
|
1528
|
+
<li>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
—
|
|
1536
|
+
<div class='inline'>
|
|
1537
|
+
<p>self</p>
|
|
1538
|
+
</div>
|
|
1539
|
+
|
|
1540
|
+
</li>
|
|
1541
|
+
|
|
1542
|
+
</ul>
|
|
1543
|
+
|
|
1544
|
+
</div><table class="source_code">
|
|
1545
|
+
<tr>
|
|
1546
|
+
<td>
|
|
1547
|
+
<pre class="lines">
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
51
|
|
1551
|
+
52
|
|
1552
|
+
53
|
|
1553
|
+
54
|
|
1554
|
+
55</pre>
|
|
1555
|
+
</td>
|
|
1556
|
+
<td>
|
|
1557
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 51</span>
|
|
1558
|
+
|
|
1559
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_greater_than_equal'>greater_than_equal</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
1560
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$gte</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span>
|
|
1561
|
+
|
|
1562
|
+
<span class='kw'>self</span>
|
|
1563
|
+
<span class='kw'>end</span></pre>
|
|
1564
|
+
</td>
|
|
1565
|
+
</tr>
|
|
1566
|
+
</table>
|
|
1567
|
+
</div>
|
|
1568
|
+
|
|
1569
|
+
<div class="method_details ">
|
|
1570
|
+
<h3 class="signature " id="in_query-instance_method">
|
|
1571
|
+
|
|
1572
|
+
- (<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>in_query</strong>(key, query)
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
</h3><div class="docstring">
|
|
1579
|
+
<div class="discussion">
|
|
1580
|
+
|
|
1581
|
+
<p>Reference query a field</p>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
</div>
|
|
1585
|
+
</div>
|
|
1586
|
+
<div class="tags">
|
|
1587
|
+
<p class="tag_title">Parameters:</p>
|
|
1588
|
+
<ul class="param">
|
|
1589
|
+
|
|
1590
|
+
<li>
|
|
1591
|
+
|
|
1592
|
+
<span class='name'>key</span>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
</li>
|
|
1600
|
+
|
|
1601
|
+
<li>
|
|
1602
|
+
|
|
1603
|
+
<span class='name'>query</span>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
</li>
|
|
1611
|
+
|
|
1612
|
+
</ul>
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
</div><table class="source_code">
|
|
1616
|
+
<tr>
|
|
1617
|
+
<td>
|
|
1618
|
+
<pre class="lines">
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
146
|
|
1622
|
+
147
|
|
1623
|
+
148
|
|
1624
|
+
149
|
|
1625
|
+
150</pre>
|
|
1626
|
+
</td>
|
|
1627
|
+
<td>
|
|
1628
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 146</span>
|
|
1629
|
+
|
|
1630
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_in_query'>in_query</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
|
1631
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$in_query</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span>
|
|
1632
|
+
|
|
1633
|
+
<span class='kw'>self</span>
|
|
1634
|
+
<span class='kw'>end</span></pre>
|
|
1635
|
+
</td>
|
|
1636
|
+
</tr>
|
|
1637
|
+
</table>
|
|
1638
|
+
</div>
|
|
1639
|
+
|
|
1640
|
+
<div class="method_details ">
|
|
1641
|
+
<h3 class="signature " id="include-instance_method">
|
|
1642
|
+
|
|
1643
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>include</strong>(key)
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
</h3><div class="docstring">
|
|
1650
|
+
<div class="discussion">
|
|
1651
|
+
|
|
1652
|
+
<p>Include reference fields in the response (joins)</p>
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
</div>
|
|
1656
|
+
</div>
|
|
1657
|
+
<div class="tags">
|
|
1658
|
+
<p class="tag_title">Parameters:</p>
|
|
1659
|
+
<ul class="param">
|
|
1660
|
+
|
|
1661
|
+
<li>
|
|
1662
|
+
|
|
1663
|
+
<span class='name'>key</span>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
—
|
|
1671
|
+
<div class='inline'>
|
|
1672
|
+
<p>The reference field to include</p>
|
|
1673
|
+
</div>
|
|
1674
|
+
|
|
1675
|
+
</li>
|
|
1676
|
+
|
|
1677
|
+
</ul>
|
|
1678
|
+
|
|
1679
|
+
<p class="tag_title">Returns:</p>
|
|
1680
|
+
<ul class="return">
|
|
1681
|
+
|
|
1682
|
+
<li>
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
—
|
|
1690
|
+
<div class='inline'>
|
|
1691
|
+
<p>self</p>
|
|
1692
|
+
</div>
|
|
1693
|
+
|
|
1694
|
+
</li>
|
|
1695
|
+
|
|
1696
|
+
</ul>
|
|
1697
|
+
|
|
1698
|
+
</div><table class="source_code">
|
|
1699
|
+
<tr>
|
|
1700
|
+
<td>
|
|
1701
|
+
<pre class="lines">
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
198
|
|
1705
|
+
199
|
|
1706
|
+
200
|
|
1707
|
+
201
|
|
1708
|
+
202
|
|
1709
|
+
203</pre>
|
|
1710
|
+
</td>
|
|
1711
|
+
<td>
|
|
1712
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 198</span>
|
|
1713
|
+
|
|
1714
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
1715
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
1716
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'><<</span> <span class='id identifier rubyid_key'>key</span>
|
|
1717
|
+
|
|
1718
|
+
<span class='kw'>self</span>
|
|
1719
|
+
<span class='kw'>end</span></pre>
|
|
1720
|
+
</td>
|
|
1721
|
+
</tr>
|
|
1722
|
+
</table>
|
|
1723
|
+
</div>
|
|
1724
|
+
|
|
1725
|
+
<div class="method_details ">
|
|
1726
|
+
<h3 class="signature " id="include_count-instance_method">
|
|
1727
|
+
|
|
1728
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>include_count</strong>
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
</h3><div class="docstring">
|
|
1735
|
+
<div class="discussion">
|
|
1736
|
+
|
|
1737
|
+
<p>Include the count of objects matching the query in the result</p>
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
</div>
|
|
1741
|
+
</div>
|
|
1742
|
+
<div class="tags">
|
|
1743
|
+
|
|
1744
|
+
<p class="tag_title">Returns:</p>
|
|
1745
|
+
<ul class="return">
|
|
1746
|
+
|
|
1747
|
+
<li>
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
—
|
|
1755
|
+
<div class='inline'>
|
|
1756
|
+
<p>self</p>
|
|
1757
|
+
</div>
|
|
1758
|
+
|
|
1759
|
+
</li>
|
|
1760
|
+
|
|
1761
|
+
</ul>
|
|
1762
|
+
|
|
1763
|
+
</div><table class="source_code">
|
|
1764
|
+
<tr>
|
|
1765
|
+
<td>
|
|
1766
|
+
<pre class="lines">
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
189
|
|
1770
|
+
190
|
|
1771
|
+
191
|
|
1772
|
+
192
|
|
1773
|
+
193</pre>
|
|
1774
|
+
</td>
|
|
1775
|
+
<td>
|
|
1776
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 189</span>
|
|
1777
|
+
|
|
1778
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include_count'>include_count</span>
|
|
1779
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include_count</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1780
|
+
|
|
1781
|
+
<span class='kw'>self</span>
|
|
1782
|
+
<span class='kw'>end</span></pre>
|
|
1783
|
+
</td>
|
|
1784
|
+
</tr>
|
|
1785
|
+
</table>
|
|
1786
|
+
</div>
|
|
1787
|
+
|
|
1788
|
+
<div class="method_details ">
|
|
1789
|
+
<h3 class="signature " id="include_drafts-instance_method">
|
|
1790
|
+
|
|
1791
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>include_drafts</strong>
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
</h3><div class="docstring">
|
|
1798
|
+
<div class="discussion">
|
|
1799
|
+
|
|
1800
|
+
<p>Include draft objects that haven't been published yet</p>
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
</div>
|
|
1804
|
+
</div>
|
|
1805
|
+
<div class="tags">
|
|
1806
|
+
|
|
1807
|
+
<p class="tag_title">Returns:</p>
|
|
1808
|
+
<ul class="return">
|
|
1809
|
+
|
|
1810
|
+
<li>
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
—
|
|
1818
|
+
<div class='inline'>
|
|
1819
|
+
<p>self</p>
|
|
1820
|
+
</div>
|
|
1821
|
+
|
|
1822
|
+
</li>
|
|
1823
|
+
|
|
1824
|
+
</ul>
|
|
1825
|
+
|
|
1826
|
+
</div><table class="source_code">
|
|
1827
|
+
<tr>
|
|
1828
|
+
<td>
|
|
1829
|
+
<pre class="lines">
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
215
|
|
1833
|
+
216
|
|
1834
|
+
217
|
|
1835
|
+
218
|
|
1836
|
+
219</pre>
|
|
1837
|
+
</td>
|
|
1838
|
+
<td>
|
|
1839
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 215</span>
|
|
1840
|
+
|
|
1841
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include_drafts'>include_drafts</span>
|
|
1842
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include_unpublished</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1843
|
+
|
|
1844
|
+
<span class='kw'>self</span>
|
|
1845
|
+
<span class='kw'>end</span></pre>
|
|
1846
|
+
</td>
|
|
1847
|
+
</tr>
|
|
1848
|
+
</table>
|
|
1849
|
+
</div>
|
|
1850
|
+
|
|
1851
|
+
<div class="method_details ">
|
|
1852
|
+
<h3 class="signature " id="include_owner-instance_method">
|
|
1853
|
+
|
|
1854
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>include_owner</strong>
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
</h3><div class="docstring">
|
|
1861
|
+
<div class="discussion">
|
|
1862
|
+
|
|
1863
|
+
<p>Include the owner of the object in the parameter _owner</p>
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
</div>
|
|
1867
|
+
</div>
|
|
1868
|
+
<div class="tags">
|
|
1869
|
+
|
|
1870
|
+
<p class="tag_title">Returns:</p>
|
|
1871
|
+
<ul class="return">
|
|
1872
|
+
|
|
1873
|
+
<li>
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
—
|
|
1881
|
+
<div class='inline'>
|
|
1882
|
+
<p>self</p>
|
|
1883
|
+
</div>
|
|
1884
|
+
|
|
1885
|
+
</li>
|
|
1886
|
+
|
|
1887
|
+
</ul>
|
|
1888
|
+
|
|
1889
|
+
</div><table class="source_code">
|
|
1890
|
+
<tr>
|
|
1891
|
+
<td>
|
|
1892
|
+
<pre class="lines">
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
207
|
|
1896
|
+
208
|
|
1897
|
+
209
|
|
1898
|
+
210
|
|
1899
|
+
211</pre>
|
|
1900
|
+
</td>
|
|
1901
|
+
<td>
|
|
1902
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 207</span>
|
|
1903
|
+
|
|
1904
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include_owner'>include_owner</span>
|
|
1905
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include_owner</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1906
|
+
|
|
1907
|
+
<span class='kw'>self</span>
|
|
1908
|
+
<span class='kw'>end</span></pre>
|
|
1909
|
+
</td>
|
|
1910
|
+
</tr>
|
|
1911
|
+
</table>
|
|
1912
|
+
</div>
|
|
1913
|
+
|
|
1914
|
+
<div class="method_details ">
|
|
1915
|
+
<h3 class="signature " id="include_schema-instance_method">
|
|
1916
|
+
|
|
1917
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>include_schema</strong>
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
</h3><div class="docstring">
|
|
1924
|
+
<div class="discussion">
|
|
1925
|
+
|
|
1926
|
+
<p>Include the schema of the class in the result</p>
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
</div>
|
|
1930
|
+
</div>
|
|
1931
|
+
<div class="tags">
|
|
1932
|
+
|
|
1933
|
+
<p class="tag_title">Returns:</p>
|
|
1934
|
+
<ul class="return">
|
|
1935
|
+
|
|
1936
|
+
<li>
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
—
|
|
1944
|
+
<div class='inline'>
|
|
1945
|
+
<p>self</p>
|
|
1946
|
+
</div>
|
|
1947
|
+
|
|
1948
|
+
</li>
|
|
1949
|
+
|
|
1950
|
+
</ul>
|
|
1951
|
+
|
|
1952
|
+
</div><table class="source_code">
|
|
1953
|
+
<tr>
|
|
1954
|
+
<td>
|
|
1955
|
+
<pre class="lines">
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
223
|
|
1959
|
+
224
|
|
1960
|
+
225
|
|
1961
|
+
226
|
|
1962
|
+
227</pre>
|
|
1963
|
+
</td>
|
|
1964
|
+
<td>
|
|
1965
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 223</span>
|
|
1966
|
+
|
|
1967
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include_schema'>include_schema</span>
|
|
1968
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>include_schema</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1969
|
+
|
|
1970
|
+
<span class='kw'>self</span>
|
|
1971
|
+
<span class='kw'>end</span></pre>
|
|
1972
|
+
</td>
|
|
1973
|
+
</tr>
|
|
1974
|
+
</table>
|
|
1975
|
+
</div>
|
|
1976
|
+
|
|
1977
|
+
<div class="method_details ">
|
|
1978
|
+
<h3 class="signature " id="less_than-instance_method">
|
|
1979
|
+
|
|
1980
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>less_than</strong>(key, value)
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
</h3><div class="docstring">
|
|
1987
|
+
<div class="discussion">
|
|
1988
|
+
|
|
1989
|
+
<p>To check that the key has a value less than the one specified</p>
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
</div>
|
|
1993
|
+
</div>
|
|
1994
|
+
<div class="tags">
|
|
1995
|
+
<p class="tag_title">Parameters:</p>
|
|
1996
|
+
<ul class="param">
|
|
1997
|
+
|
|
1998
|
+
<li>
|
|
1999
|
+
|
|
2000
|
+
<span class='name'>key</span>
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
—
|
|
2008
|
+
<div class='inline'>
|
|
2009
|
+
<p>The key</p>
|
|
2010
|
+
</div>
|
|
2011
|
+
|
|
2012
|
+
</li>
|
|
2013
|
+
|
|
2014
|
+
<li>
|
|
2015
|
+
|
|
2016
|
+
<span class='name'>value</span>
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
—
|
|
2024
|
+
<div class='inline'>
|
|
2025
|
+
<p>The value</p>
|
|
2026
|
+
</div>
|
|
2027
|
+
|
|
2028
|
+
</li>
|
|
2029
|
+
|
|
2030
|
+
</ul>
|
|
2031
|
+
|
|
2032
|
+
<p class="tag_title">Returns:</p>
|
|
2033
|
+
<ul class="return">
|
|
2034
|
+
|
|
2035
|
+
<li>
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
|
|
2042
|
+
—
|
|
2043
|
+
<div class='inline'>
|
|
2044
|
+
<p>self</p>
|
|
2045
|
+
</div>
|
|
2046
|
+
|
|
2047
|
+
</li>
|
|
2048
|
+
|
|
2049
|
+
</ul>
|
|
2050
|
+
|
|
2051
|
+
</div><table class="source_code">
|
|
2052
|
+
<tr>
|
|
2053
|
+
<td>
|
|
2054
|
+
<pre class="lines">
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
61
|
|
2058
|
+
62
|
|
2059
|
+
63
|
|
2060
|
+
64
|
|
2061
|
+
65</pre>
|
|
2062
|
+
</td>
|
|
2063
|
+
<td>
|
|
2064
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 61</span>
|
|
2065
|
+
|
|
2066
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_less_than'>less_than</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
2067
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$lt</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span>
|
|
2068
|
+
|
|
2069
|
+
<span class='kw'>self</span>
|
|
2070
|
+
<span class='kw'>end</span></pre>
|
|
2071
|
+
</td>
|
|
2072
|
+
</tr>
|
|
2073
|
+
</table>
|
|
2074
|
+
</div>
|
|
2075
|
+
|
|
2076
|
+
<div class="method_details ">
|
|
2077
|
+
<h3 class="signature " id="less_than_equal-instance_method">
|
|
2078
|
+
|
|
2079
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>less_than_equal</strong>(key, value)
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
</h3><div class="docstring">
|
|
2086
|
+
<div class="discussion">
|
|
2087
|
+
|
|
2088
|
+
<p>To check that the key has a value less than OR equaling the one specified</p>
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
</div>
|
|
2092
|
+
</div>
|
|
2093
|
+
<div class="tags">
|
|
2094
|
+
<p class="tag_title">Parameters:</p>
|
|
2095
|
+
<ul class="param">
|
|
2096
|
+
|
|
2097
|
+
<li>
|
|
2098
|
+
|
|
2099
|
+
<span class='name'>key</span>
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
—
|
|
2107
|
+
<div class='inline'>
|
|
2108
|
+
<p>The key</p>
|
|
2109
|
+
</div>
|
|
2110
|
+
|
|
2111
|
+
</li>
|
|
2112
|
+
|
|
2113
|
+
<li>
|
|
2114
|
+
|
|
2115
|
+
<span class='name'>value</span>
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
—
|
|
2123
|
+
<div class='inline'>
|
|
2124
|
+
<p>The value</p>
|
|
2125
|
+
</div>
|
|
2126
|
+
|
|
2127
|
+
</li>
|
|
2128
|
+
|
|
2129
|
+
</ul>
|
|
2130
|
+
|
|
2131
|
+
<p class="tag_title">Returns:</p>
|
|
2132
|
+
<ul class="return">
|
|
2133
|
+
|
|
2134
|
+
<li>
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
—
|
|
2142
|
+
<div class='inline'>
|
|
2143
|
+
<p>self</p>
|
|
2144
|
+
</div>
|
|
2145
|
+
|
|
2146
|
+
</li>
|
|
2147
|
+
|
|
2148
|
+
</ul>
|
|
2149
|
+
|
|
2150
|
+
</div><table class="source_code">
|
|
2151
|
+
<tr>
|
|
2152
|
+
<td>
|
|
2153
|
+
<pre class="lines">
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
71
|
|
2157
|
+
72
|
|
2158
|
+
73
|
|
2159
|
+
74
|
|
2160
|
+
75</pre>
|
|
2161
|
+
</td>
|
|
2162
|
+
<td>
|
|
2163
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 71</span>
|
|
2164
|
+
|
|
2165
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_less_than_equal'>less_than_equal</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
2166
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$lte</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span>
|
|
2167
|
+
|
|
2168
|
+
<span class='kw'>self</span>
|
|
2169
|
+
<span class='kw'>end</span></pre>
|
|
2170
|
+
</td>
|
|
2171
|
+
</tr>
|
|
2172
|
+
</table>
|
|
2173
|
+
</div>
|
|
2174
|
+
|
|
2175
|
+
<div class="method_details ">
|
|
2176
|
+
<h3 class="signature " id="limit-instance_method">
|
|
2177
|
+
|
|
2178
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>limit</strong>(number)
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
</h3><div class="docstring">
|
|
2185
|
+
<div class="discussion">
|
|
2186
|
+
|
|
2187
|
+
<p>Limit the number of results to a given number</p>
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
</div>
|
|
2191
|
+
</div>
|
|
2192
|
+
<div class="tags">
|
|
2193
|
+
<p class="tag_title">Parameters:</p>
|
|
2194
|
+
<ul class="param">
|
|
2195
|
+
|
|
2196
|
+
<li>
|
|
2197
|
+
|
|
2198
|
+
<span class='name'>number</span>
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
<span class='type'>(<tt>Number</tt>)</span>
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
</li>
|
|
2206
|
+
|
|
2207
|
+
</ul>
|
|
2208
|
+
|
|
2209
|
+
<p class="tag_title">Returns:</p>
|
|
2210
|
+
<ul class="return">
|
|
2211
|
+
|
|
2212
|
+
<li>
|
|
2213
|
+
|
|
2214
|
+
|
|
2215
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
—
|
|
2220
|
+
<div class='inline'>
|
|
2221
|
+
<p>self</p>
|
|
2222
|
+
</div>
|
|
2223
|
+
|
|
2224
|
+
</li>
|
|
2225
|
+
|
|
2226
|
+
</ul>
|
|
2227
|
+
|
|
2228
|
+
</div><table class="source_code">
|
|
2229
|
+
<tr>
|
|
2230
|
+
<td>
|
|
2231
|
+
<pre class="lines">
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
164
|
|
2235
|
+
165
|
|
2236
|
+
166
|
|
2237
|
+
167
|
|
2238
|
+
168</pre>
|
|
2239
|
+
</td>
|
|
2240
|
+
<td>
|
|
2241
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 164</span>
|
|
2242
|
+
|
|
2243
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_limit'>limit</span><span class='lparen'>(</span><span class='id identifier rubyid_number'>number</span><span class='rparen'>)</span>
|
|
2244
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>limit</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_number'>number</span>
|
|
2245
|
+
|
|
2246
|
+
<span class='kw'>self</span>
|
|
2247
|
+
<span class='kw'>end</span></pre>
|
|
2248
|
+
</td>
|
|
2249
|
+
</tr>
|
|
2250
|
+
</table>
|
|
2251
|
+
</div>
|
|
2252
|
+
|
|
2253
|
+
<div class="method_details ">
|
|
2254
|
+
<h3 class="signature " id="not_contained_in-instance_method">
|
|
2255
|
+
|
|
2256
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>not_contained_in</strong>(key, array)
|
|
2257
|
+
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
</h3><div class="docstring">
|
|
2263
|
+
<div class="discussion">
|
|
2264
|
+
|
|
2265
|
+
<p>To check that the value for a key is NOT contained in a given array</p>
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
</div>
|
|
2269
|
+
</div>
|
|
2270
|
+
<div class="tags">
|
|
2271
|
+
<p class="tag_title">Parameters:</p>
|
|
2272
|
+
<ul class="param">
|
|
2273
|
+
|
|
2274
|
+
<li>
|
|
2275
|
+
|
|
2276
|
+
<span class='name'>key</span>
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
—
|
|
2284
|
+
<div class='inline'>
|
|
2285
|
+
<p>The key to check</p>
|
|
2286
|
+
</div>
|
|
2287
|
+
|
|
2288
|
+
</li>
|
|
2289
|
+
|
|
2290
|
+
<li>
|
|
2291
|
+
|
|
2292
|
+
<span class='name'>array</span>
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
—
|
|
2300
|
+
<div class='inline'>
|
|
2301
|
+
<p>An array of values</p>
|
|
2302
|
+
</div>
|
|
2303
|
+
|
|
2304
|
+
</li>
|
|
2305
|
+
|
|
2306
|
+
</ul>
|
|
2307
|
+
|
|
2308
|
+
<p class="tag_title">Returns:</p>
|
|
2309
|
+
<ul class="return">
|
|
2310
|
+
|
|
2311
|
+
<li>
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
—
|
|
2319
|
+
<div class='inline'>
|
|
2320
|
+
<p>self</p>
|
|
2321
|
+
</div>
|
|
2322
|
+
|
|
2323
|
+
</li>
|
|
2324
|
+
|
|
2325
|
+
</ul>
|
|
2326
|
+
|
|
2327
|
+
</div><table class="source_code">
|
|
2328
|
+
<tr>
|
|
2329
|
+
<td>
|
|
2330
|
+
<pre class="lines">
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
119
|
|
2334
|
+
120
|
|
2335
|
+
121
|
|
2336
|
+
122
|
|
2337
|
+
123</pre>
|
|
2338
|
+
</td>
|
|
2339
|
+
<td>
|
|
2340
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 119</span>
|
|
2341
|
+
|
|
2342
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_not_contained_in'>not_contained_in</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='rparen'>)</span>
|
|
2343
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$nin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_array'>array</span><span class='rbrace'>}</span>
|
|
2344
|
+
|
|
2345
|
+
<span class='kw'>self</span>
|
|
2346
|
+
<span class='kw'>end</span></pre>
|
|
2347
|
+
</td>
|
|
2348
|
+
</tr>
|
|
2349
|
+
</table>
|
|
2350
|
+
</div>
|
|
2351
|
+
|
|
2352
|
+
<div class="method_details ">
|
|
2353
|
+
<h3 class="signature " id="not_equal-instance_method">
|
|
2354
|
+
|
|
2355
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>not_equal</strong>(key, value)
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
</h3><div class="docstring">
|
|
2362
|
+
<div class="discussion">
|
|
2363
|
+
|
|
2364
|
+
<p>To check that the key has a value not equaling the one specified</p>
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
</div>
|
|
2368
|
+
</div>
|
|
2369
|
+
<div class="tags">
|
|
2370
|
+
<p class="tag_title">Parameters:</p>
|
|
2371
|
+
<ul class="param">
|
|
2372
|
+
|
|
2373
|
+
<li>
|
|
2374
|
+
|
|
2375
|
+
<span class='name'>key</span>
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
—
|
|
2383
|
+
<div class='inline'>
|
|
2384
|
+
<p>The key</p>
|
|
2385
|
+
</div>
|
|
2386
|
+
|
|
2387
|
+
</li>
|
|
2388
|
+
|
|
2389
|
+
<li>
|
|
2390
|
+
|
|
2391
|
+
<span class='name'>value</span>
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
—
|
|
2399
|
+
<div class='inline'>
|
|
2400
|
+
<p>The value</p>
|
|
2401
|
+
</div>
|
|
2402
|
+
|
|
2403
|
+
</li>
|
|
2404
|
+
|
|
2405
|
+
</ul>
|
|
2406
|
+
|
|
2407
|
+
<p class="tag_title">Returns:</p>
|
|
2408
|
+
<ul class="return">
|
|
2409
|
+
|
|
2410
|
+
<li>
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
—
|
|
2418
|
+
<div class='inline'>
|
|
2419
|
+
<p>self</p>
|
|
2420
|
+
</div>
|
|
2421
|
+
|
|
2422
|
+
</li>
|
|
2423
|
+
|
|
2424
|
+
</ul>
|
|
2425
|
+
|
|
2426
|
+
</div><table class="source_code">
|
|
2427
|
+
<tr>
|
|
2428
|
+
<td>
|
|
2429
|
+
<pre class="lines">
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
81
|
|
2433
|
+
82
|
|
2434
|
+
83
|
|
2435
|
+
84
|
|
2436
|
+
85</pre>
|
|
2437
|
+
</td>
|
|
2438
|
+
<td>
|
|
2439
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 81</span>
|
|
2440
|
+
|
|
2441
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_not_equal'>not_equal</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
2442
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$ne</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span>
|
|
2443
|
+
|
|
2444
|
+
<span class='kw'>self</span>
|
|
2445
|
+
<span class='kw'>end</span></pre>
|
|
2446
|
+
</td>
|
|
2447
|
+
</tr>
|
|
2448
|
+
</table>
|
|
2449
|
+
</div>
|
|
2450
|
+
|
|
2451
|
+
<div class="method_details ">
|
|
2452
|
+
<h3 class="signature " id="not_exists-instance_method">
|
|
2453
|
+
|
|
2454
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>not_exists</strong>(key)
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
</h3><div class="docstring">
|
|
2461
|
+
<div class="discussion">
|
|
2462
|
+
|
|
2463
|
+
<p>To check that the given key does not exist</p>
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
</div>
|
|
2467
|
+
</div>
|
|
2468
|
+
<div class="tags">
|
|
2469
|
+
<p class="tag_title">Parameters:</p>
|
|
2470
|
+
<ul class="param">
|
|
2471
|
+
|
|
2472
|
+
<li>
|
|
2473
|
+
|
|
2474
|
+
<span class='name'>key</span>
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
</li>
|
|
2482
|
+
|
|
2483
|
+
</ul>
|
|
2484
|
+
|
|
2485
|
+
<p class="tag_title">Returns:</p>
|
|
2486
|
+
<ul class="return">
|
|
2487
|
+
|
|
2488
|
+
<li>
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
—
|
|
2496
|
+
<div class='inline'>
|
|
2497
|
+
<p>self</p>
|
|
2498
|
+
</div>
|
|
2499
|
+
|
|
2500
|
+
</li>
|
|
2501
|
+
|
|
2502
|
+
</ul>
|
|
2503
|
+
|
|
2504
|
+
</div><table class="source_code">
|
|
2505
|
+
<tr>
|
|
2506
|
+
<td>
|
|
2507
|
+
<pre class="lines">
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
137
|
|
2511
|
+
138
|
|
2512
|
+
139
|
|
2513
|
+
140
|
|
2514
|
+
141</pre>
|
|
2515
|
+
</td>
|
|
2516
|
+
<td>
|
|
2517
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 137</span>
|
|
2518
|
+
|
|
2519
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_not_exists'>not_exists</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
2520
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$exists</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>false</span><span class='rbrace'>}</span>
|
|
2521
|
+
|
|
2522
|
+
<span class='kw'>self</span>
|
|
2523
|
+
<span class='kw'>end</span></pre>
|
|
2524
|
+
</td>
|
|
2525
|
+
</tr>
|
|
2526
|
+
</table>
|
|
2527
|
+
</div>
|
|
2528
|
+
|
|
2529
|
+
<div class="method_details ">
|
|
2530
|
+
<h3 class="signature " id="not_in_query-instance_method">
|
|
2531
|
+
|
|
2532
|
+
- (<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>not_in_query</strong>(key, query)
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
</h3><div class="docstring">
|
|
2539
|
+
<div class="discussion">
|
|
2540
|
+
|
|
2541
|
+
<p>Reference query a field negatively</p>
|
|
2542
|
+
|
|
2543
|
+
|
|
2544
|
+
</div>
|
|
2545
|
+
</div>
|
|
2546
|
+
<div class="tags">
|
|
2547
|
+
<p class="tag_title">Parameters:</p>
|
|
2548
|
+
<ul class="param">
|
|
2549
|
+
|
|
2550
|
+
<li>
|
|
2551
|
+
|
|
2552
|
+
<span class='name'>key</span>
|
|
2553
|
+
|
|
2554
|
+
|
|
2555
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
|
|
2559
|
+
</li>
|
|
2560
|
+
|
|
2561
|
+
<li>
|
|
2562
|
+
|
|
2563
|
+
<span class='name'>query</span>
|
|
2564
|
+
|
|
2565
|
+
|
|
2566
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2567
|
+
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
</li>
|
|
2571
|
+
|
|
2572
|
+
</ul>
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
</div><table class="source_code">
|
|
2576
|
+
<tr>
|
|
2577
|
+
<td>
|
|
2578
|
+
<pre class="lines">
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
155
|
|
2582
|
+
156
|
|
2583
|
+
157
|
|
2584
|
+
158
|
|
2585
|
+
159</pre>
|
|
2586
|
+
</td>
|
|
2587
|
+
<td>
|
|
2588
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 155</span>
|
|
2589
|
+
|
|
2590
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_not_in_query'>not_in_query</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
|
2591
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$nin_query</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span>
|
|
2592
|
+
|
|
2593
|
+
<span class='kw'>self</span>
|
|
2594
|
+
<span class='kw'>end</span></pre>
|
|
2595
|
+
</td>
|
|
2596
|
+
</tr>
|
|
2597
|
+
</table>
|
|
2598
|
+
</div>
|
|
2599
|
+
|
|
2600
|
+
<div class="method_details ">
|
|
2601
|
+
<h3 class="signature " id="skip-instance_method">
|
|
2602
|
+
|
|
2603
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>skip</strong>(number)
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
</h3><div class="docstring">
|
|
2610
|
+
<div class="discussion">
|
|
2611
|
+
|
|
2612
|
+
<p>Skip a give number of results</p>
|
|
2613
|
+
|
|
2614
|
+
|
|
2615
|
+
</div>
|
|
2616
|
+
</div>
|
|
2617
|
+
<div class="tags">
|
|
2618
|
+
<p class="tag_title">Parameters:</p>
|
|
2619
|
+
<ul class="param">
|
|
2620
|
+
|
|
2621
|
+
<li>
|
|
2622
|
+
|
|
2623
|
+
<span class='name'>number</span>
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
<span class='type'>(<tt>Number</tt>)</span>
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
|
|
2630
|
+
</li>
|
|
2631
|
+
|
|
2632
|
+
</ul>
|
|
2633
|
+
|
|
2634
|
+
<p class="tag_title">Returns:</p>
|
|
2635
|
+
<ul class="return">
|
|
2636
|
+
|
|
2637
|
+
<li>
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2641
|
+
|
|
2642
|
+
|
|
2643
|
+
|
|
2644
|
+
—
|
|
2645
|
+
<div class='inline'>
|
|
2646
|
+
<p>self</p>
|
|
2647
|
+
</div>
|
|
2648
|
+
|
|
2649
|
+
</li>
|
|
2650
|
+
|
|
2651
|
+
</ul>
|
|
2652
|
+
|
|
2653
|
+
</div><table class="source_code">
|
|
2654
|
+
<tr>
|
|
2655
|
+
<td>
|
|
2656
|
+
<pre class="lines">
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
173
|
|
2660
|
+
174
|
|
2661
|
+
175
|
|
2662
|
+
176
|
|
2663
|
+
177</pre>
|
|
2664
|
+
</td>
|
|
2665
|
+
<td>
|
|
2666
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 173</span>
|
|
2667
|
+
|
|
2668
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_skip'>skip</span><span class='lparen'>(</span><span class='id identifier rubyid_number'>number</span><span class='rparen'>)</span>
|
|
2669
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>skip</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_number'>number</span>
|
|
2670
|
+
|
|
2671
|
+
<span class='kw'>self</span>
|
|
2672
|
+
<span class='kw'>end</span></pre>
|
|
2673
|
+
</td>
|
|
2674
|
+
</tr>
|
|
2675
|
+
</table>
|
|
2676
|
+
</div>
|
|
2677
|
+
|
|
2678
|
+
<div class="method_details ">
|
|
2679
|
+
<h3 class="signature " id="where-instance_method">
|
|
2680
|
+
|
|
2681
|
+
- (<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>) <strong>where</strong>(key, value)
|
|
2682
|
+
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
|
|
2686
|
+
|
|
2687
|
+
</h3><div class="docstring">
|
|
2688
|
+
<div class="discussion">
|
|
2689
|
+
|
|
2690
|
+
<p>Where given key matches value</p>
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
</div>
|
|
2694
|
+
</div>
|
|
2695
|
+
<div class="tags">
|
|
2696
|
+
<p class="tag_title">Parameters:</p>
|
|
2697
|
+
<ul class="param">
|
|
2698
|
+
|
|
2699
|
+
<li>
|
|
2700
|
+
|
|
2701
|
+
<span class='name'>key</span>
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
|
|
2708
|
+
—
|
|
2709
|
+
<div class='inline'>
|
|
2710
|
+
<p>The key on which to search</p>
|
|
2711
|
+
</div>
|
|
2712
|
+
|
|
2713
|
+
</li>
|
|
2714
|
+
|
|
2715
|
+
<li>
|
|
2716
|
+
|
|
2717
|
+
<span class='name'>value</span>
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
<span class='type'>(<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>)</span>
|
|
2721
|
+
|
|
2722
|
+
|
|
2723
|
+
|
|
2724
|
+
—
|
|
2725
|
+
<div class='inline'>
|
|
2726
|
+
<p>The value with which to match</p>
|
|
2727
|
+
</div>
|
|
2728
|
+
|
|
2729
|
+
</li>
|
|
2730
|
+
|
|
2731
|
+
</ul>
|
|
2732
|
+
|
|
2733
|
+
<p class="tag_title">Returns:</p>
|
|
2734
|
+
<ul class="return">
|
|
2735
|
+
|
|
2736
|
+
<li>
|
|
2737
|
+
|
|
2738
|
+
|
|
2739
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Built::Query (class)">Query</a></span></tt>)</span>
|
|
2740
|
+
|
|
2741
|
+
|
|
2742
|
+
|
|
2743
|
+
—
|
|
2744
|
+
<div class='inline'>
|
|
2745
|
+
<p>self</p>
|
|
2746
|
+
</div>
|
|
2747
|
+
|
|
2748
|
+
</li>
|
|
2749
|
+
|
|
2750
|
+
</ul>
|
|
2751
|
+
|
|
2752
|
+
</div><table class="source_code">
|
|
2753
|
+
<tr>
|
|
2754
|
+
<td>
|
|
2755
|
+
<pre class="lines">
|
|
2756
|
+
|
|
2757
|
+
|
|
2758
|
+
31
|
|
2759
|
+
32
|
|
2760
|
+
33
|
|
2761
|
+
34
|
|
2762
|
+
35</pre>
|
|
2763
|
+
</td>
|
|
2764
|
+
<td>
|
|
2765
|
+
<pre class="code"><span class="info file"># File 'lib/built/query.rb', line 31</span>
|
|
2766
|
+
|
|
2767
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
2768
|
+
<span class='ivar'>@params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>query</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
|
|
2769
|
+
|
|
2770
|
+
<span class='kw'>self</span>
|
|
2771
|
+
<span class='kw'>end</span></pre>
|
|
2772
|
+
</td>
|
|
2773
|
+
</tr>
|
|
2774
|
+
</table>
|
|
2775
|
+
</div>
|
|
2776
|
+
|
|
2777
|
+
</div>
|
|
2778
|
+
|
|
2779
|
+
</div>
|
|
2780
|
+
|
|
2781
|
+
<div id="footer">
|
|
2782
|
+
Generated on Mon Mar 24 18:20:50 2014 by
|
|
2783
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2784
|
+
0.8.7.2 (ruby-1.9.3).
|
|
2785
|
+
</div>
|
|
2786
|
+
|
|
2787
|
+
</body>
|
|
2788
|
+
</html>
|