db-struct 0.1.0
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.
- checksums.yaml +7 -0
- data/README.md +125 -0
- data/Rakefile +35 -0
- data/db-struct.gemspec +37 -0
- data/doc/DBStruct/BogoHash.html +1384 -0
- data/doc/DBStruct/ErrorHelpers.html +288 -0
- data/doc/DBStruct/Failure.html +139 -0
- data/doc/DBStruct/FieldError.html +143 -0
- data/doc/DBStruct/MissingRowError.html +143 -0
- data/doc/DBStruct/TypeError.html +143 -0
- data/doc/DBStruct.html +1652 -0
- data/doc/_index.html +189 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.README.html +187 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +187 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +342 -0
- data/doc/top-level-namespace.html +110 -0
- data/gem.deps.rb +7 -0
- data/lib/dbstruct.rb +29 -0
- data/lib/internal/bogohash.rb +226 -0
- data/lib/internal/dbstruct_base.rb +144 -0
- data/lib/internal/dbstruct_class.rb +301 -0
- data/lib/internal/error.rb +44 -0
- data/lib/internal/util.rb +11 -0
- data/spec/dbstruct_spec.rb +452 -0
- data/spec/spec_helper.rb +48 -0
- metadata +138 -0
|
@@ -0,0 +1,1384 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: DBStruct::BogoHash
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "DBStruct::BogoHash";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (B)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">BogoHash</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: DBStruct::BogoHash
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">DBStruct::BogoHash</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<dl>
|
|
91
|
+
<dt>Includes:</dt>
|
|
92
|
+
<dd>Enumerable</dd>
|
|
93
|
+
</dl>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/internal/bogohash.rb<span class="defines">,<br />
|
|
103
|
+
lib/dbstruct.rb</span>
|
|
104
|
+
</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Overview</h2><div class="docstring">
|
|
110
|
+
<div class="discussion">
|
|
111
|
+
|
|
112
|
+
<p>‘BogoHash` provides a `Hash`-like interface to the database table corresponding to a <span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span> subclass.</p>
|
|
113
|
+
|
|
114
|
+
<p>You can think if it as a ‘Hash` that holds all instances of a particular <span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span> subclass keyed on the objects’ ‘rowid` attributes. Most of the `Hash` interface is available (including `Enumerable`) with the exception of `[]=`. `delete` and `delete_if` work as expected, however.</p>
|
|
115
|
+
|
|
116
|
+
<p>You should never explicitly create a ‘BogoHash`. Instead, use the class’s <span class='object_link'><a href="../DBStruct.html#items-class_method" title="DBStruct.items (method)">items</a></span> or <span class='object_link'><a href="../DBStruct.html#where-class_method" title="DBStruct.where (method)">where</a></span> methods.</p>
|
|
117
|
+
|
|
118
|
+
<p>Since these methods can be used to narrow the range of items, a ‘BogoHash` does not necessarily encompass all instances of its associated `DBStruct` subclass. Rows that do not match the selection criteria are not available even when explicitly addressed by row ID.</p>
|
|
119
|
+
|
|
120
|
+
<p>Under the hood, a ‘BogoHash` is a wrapper around a `Sequel::Dataset`.</p>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
<div class="tags">
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<h2>
|
|
137
|
+
Instance Method Summary
|
|
138
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
139
|
+
</h2>
|
|
140
|
+
|
|
141
|
+
<ul class="summary">
|
|
142
|
+
|
|
143
|
+
<li class="public ">
|
|
144
|
+
<span class="summary_signature">
|
|
145
|
+
|
|
146
|
+
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(rowid) ⇒ Object </a>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</span>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<span class="summary_desc"><div class='inline'>
|
|
161
|
+
<p>Retrieve the item at ‘rowid` or nil if its not present.</p>
|
|
162
|
+
</div></span>
|
|
163
|
+
|
|
164
|
+
</li>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<li class="public ">
|
|
168
|
+
<span class="summary_signature">
|
|
169
|
+
|
|
170
|
+
<a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> ⇒ Object </a>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
</span>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<span class="summary_desc"><div class='inline'>
|
|
185
|
+
<p>Delete all entries.</p>
|
|
186
|
+
</div></span>
|
|
187
|
+
|
|
188
|
+
</li>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<li class="public ">
|
|
192
|
+
<span class="summary_signature">
|
|
193
|
+
|
|
194
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(rowid, &block) ⇒ DBStruct.with(...) </a>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</span>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<span class="summary_desc"><div class='inline'>
|
|
209
|
+
<p>Delete ‘rowid` and its associated value from the underlying table (and `self` by extension).</p>
|
|
210
|
+
</div></span>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<li class="public ">
|
|
216
|
+
<span class="summary_signature">
|
|
217
|
+
|
|
218
|
+
<a href="#delete_if-instance_method" title="#delete_if (instance method)">#<strong>delete_if</strong> {|value| ... } ⇒ Object </a>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
(also: #reject!)
|
|
223
|
+
|
|
224
|
+
</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="summary_desc"><div class='inline'>
|
|
235
|
+
<p>Evaluate the block on each key-value pair in ‘self` end delete each entry for which the block returns true.</p>
|
|
236
|
+
</div></span>
|
|
237
|
+
|
|
238
|
+
</li>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<li class="public ">
|
|
242
|
+
<span class="summary_signature">
|
|
243
|
+
|
|
244
|
+
<a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong>(&block) ⇒ Object </a>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
(also: #each_pair)
|
|
249
|
+
|
|
250
|
+
</span>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<span class="summary_desc"><div class='inline'>
|
|
261
|
+
<p>Evaluate ‘block` over each key-and-value pair (i.e. row and row-id).</p>
|
|
262
|
+
</div></span>
|
|
263
|
+
|
|
264
|
+
</li>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<li class="public ">
|
|
268
|
+
<span class="summary_signature">
|
|
269
|
+
|
|
270
|
+
<a href="#each_key-instance_method" title="#each_key (instance method)">#<strong>each_key</strong>(&block) ⇒ Object </a>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</span>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class="summary_desc"><div class='inline'>
|
|
285
|
+
<p>Like <span class='object_link'><a href="#each-instance_method" title="DBStruct::BogoHash#each (method)">#each</a></span> but only yields the key (i.e. row ID).</p>
|
|
286
|
+
</div></span>
|
|
287
|
+
|
|
288
|
+
</li>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<li class="public ">
|
|
292
|
+
<span class="summary_signature">
|
|
293
|
+
|
|
294
|
+
<a href="#each_value-instance_method" title="#each_value (instance method)">#<strong>each_value</strong>(&block) ⇒ Object </a>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</span>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<span class="summary_desc"><div class='inline'>
|
|
309
|
+
<p>Like <span class='object_link'><a href="#each-instance_method" title="DBStruct::BogoHash#each (method)">#each</a></span> but only yields the value.</p>
|
|
310
|
+
</div></span>
|
|
311
|
+
|
|
312
|
+
</li>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<li class="public ">
|
|
316
|
+
<span class="summary_signature">
|
|
317
|
+
|
|
318
|
+
<a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> ⇒ Boolean </a>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
</span>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<span class="summary_desc"><div class='inline'>
|
|
333
|
+
<p>Test if self has no items.</p>
|
|
334
|
+
</div></span>
|
|
335
|
+
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<li class="public ">
|
|
340
|
+
<span class="summary_signature">
|
|
341
|
+
|
|
342
|
+
<a href="#has_key%3F-instance_method" title="#has_key? (instance method)">#<strong>has_key?</strong>(rowid) ⇒ Boolean </a>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
(also: #include?, #member?, #key?)
|
|
347
|
+
|
|
348
|
+
</span>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<span class="summary_desc"><div class='inline'>
|
|
359
|
+
<p>Test if ‘rowid` is one of the keys in `self`.</p>
|
|
360
|
+
</div></span>
|
|
361
|
+
|
|
362
|
+
</li>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
<li class="public ">
|
|
366
|
+
<span class="summary_signature">
|
|
367
|
+
|
|
368
|
+
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ String </a>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
(also: #to_s)
|
|
373
|
+
|
|
374
|
+
</span>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<span class="summary_desc"><div class='inline'>
|
|
385
|
+
<p>Return a human-friendly string describing this object.</p>
|
|
386
|
+
</div></span>
|
|
387
|
+
|
|
388
|
+
</li>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
<li class="public ">
|
|
392
|
+
<span class="summary_signature">
|
|
393
|
+
|
|
394
|
+
<a href="#keys-instance_method" title="#keys (instance method)">#<strong>keys</strong> ⇒ Array[Integer] </a>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
</span>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<span class="summary_desc"><div class='inline'>
|
|
409
|
+
<p>Return all keys.</p>
|
|
410
|
+
</div></span>
|
|
411
|
+
|
|
412
|
+
</li>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<li class="public ">
|
|
416
|
+
<span class="summary_signature">
|
|
417
|
+
|
|
418
|
+
<a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> ⇒ Object </a>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
(also: #length)
|
|
423
|
+
|
|
424
|
+
</span>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<span class="summary_desc"><div class='inline'>
|
|
435
|
+
<p>Return the number of items in ‘self`.</p>
|
|
436
|
+
</div></span>
|
|
437
|
+
|
|
438
|
+
</li>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
<li class="public ">
|
|
442
|
+
<span class="summary_signature">
|
|
443
|
+
|
|
444
|
+
<a href="#to_a-instance_method" title="#to_a (instance method)">#<strong>to_a</strong> ⇒ Array[Array[Integer, DBStruct.with(...)]] </a>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
</span>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<span class="summary_desc"><div class='inline'>
|
|
459
|
+
<p>Return all keys and values as an array of two-element arrays.</p>
|
|
460
|
+
</div></span>
|
|
461
|
+
|
|
462
|
+
</li>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
<li class="public ">
|
|
466
|
+
<span class="summary_signature">
|
|
467
|
+
|
|
468
|
+
<a href="#transaction-instance_method" title="#transaction (instance method)">#<strong>transaction</strong>(*args, **kwargs, &block) ⇒ Object </a>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</span>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<span class="summary_desc"><div class='inline'>
|
|
483
|
+
<p>Calls the underling ‘Sequel::Database#transaction` methods with all arguments.</p>
|
|
484
|
+
</div></span>
|
|
485
|
+
|
|
486
|
+
</li>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<li class="public ">
|
|
490
|
+
<span class="summary_signature">
|
|
491
|
+
|
|
492
|
+
<a href="#values-instance_method" title="#values (instance method)">#<strong>values</strong> ⇒ Array[DBStruct.with(...)] </a>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
</span>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<span class="summary_desc"><div class='inline'>
|
|
507
|
+
<p>Return all values.</p>
|
|
508
|
+
</div></span>
|
|
509
|
+
|
|
510
|
+
</li>
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
<li class="public ">
|
|
514
|
+
<span class="summary_signature">
|
|
515
|
+
|
|
516
|
+
<a href="#where-instance_method" title="#where (instance method)">#<strong>where</strong>(*cond, **kwcond, &block) ⇒ BogoHash </a>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
</span>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
<span class="summary_desc"><div class='inline'>
|
|
531
|
+
<p>Expose ‘Sequel::Dataset#where` for more advanced querying.</p>
|
|
532
|
+
</div></span>
|
|
533
|
+
|
|
534
|
+
</li>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</ul>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<div id="instance_method_details" class="method_details_list">
|
|
544
|
+
<h2>Instance Method Details</h2>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<div class="method_details first">
|
|
548
|
+
<h3 class="signature first" id="[]-instance_method">
|
|
549
|
+
|
|
550
|
+
#<strong>[]</strong>(rowid) ⇒ <tt>Object</tt>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
</h3><div class="docstring">
|
|
557
|
+
<div class="discussion">
|
|
558
|
+
|
|
559
|
+
<p>Retrieve the item at ‘rowid` or nil if its not present.</p>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
</div>
|
|
563
|
+
</div>
|
|
564
|
+
<div class="tags">
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
</div><table class="source_code">
|
|
568
|
+
<tr>
|
|
569
|
+
<td>
|
|
570
|
+
<pre class="lines">
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
44
|
|
574
|
+
45
|
|
575
|
+
46
|
|
576
|
+
47
|
|
577
|
+
48</pre>
|
|
578
|
+
</td>
|
|
579
|
+
<td>
|
|
580
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 44</span>
|
|
581
|
+
|
|
582
|
+
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span>
|
|
583
|
+
<span class='id identifier rubyid_row'>row</span> <span class='op'>=</span> <span class='ivar'>@dataset</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lparen'>(</span><span class='label'>_id:</span> <span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span>
|
|
584
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_row'>row</span>
|
|
585
|
+
<span class='kw'>return</span> <span class='ivar'>@dbs_klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>_id:</span> <span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span>
|
|
586
|
+
<span class='kw'>end</span></pre>
|
|
587
|
+
</td>
|
|
588
|
+
</tr>
|
|
589
|
+
</table>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
<div class="method_details ">
|
|
593
|
+
<h3 class="signature " id="clear-instance_method">
|
|
594
|
+
|
|
595
|
+
#<strong>clear</strong> ⇒ <tt>Object</tt>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
</h3><div class="docstring">
|
|
602
|
+
<div class="discussion">
|
|
603
|
+
|
|
604
|
+
<p>Delete all entries</p>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</div>
|
|
608
|
+
</div>
|
|
609
|
+
<div class="tags">
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</div><table class="source_code">
|
|
613
|
+
<tr>
|
|
614
|
+
<td>
|
|
615
|
+
<pre class="lines">
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
118
|
|
619
|
+
119
|
|
620
|
+
120
|
|
621
|
+
121</pre>
|
|
622
|
+
</td>
|
|
623
|
+
<td>
|
|
624
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 118</span>
|
|
625
|
+
|
|
626
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
|
|
627
|
+
<span class='ivar'>@dataset</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span>
|
|
628
|
+
<span class='kw'>return</span> <span class='kw'>self</span>
|
|
629
|
+
<span class='kw'>end</span></pre>
|
|
630
|
+
</td>
|
|
631
|
+
</tr>
|
|
632
|
+
</table>
|
|
633
|
+
</div>
|
|
634
|
+
|
|
635
|
+
<div class="method_details ">
|
|
636
|
+
<h3 class="signature " id="delete-instance_method">
|
|
637
|
+
|
|
638
|
+
#<strong>delete</strong>(rowid, &block) ⇒ <tt><span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)</tt>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
</h3><div class="docstring">
|
|
645
|
+
<div class="discussion">
|
|
646
|
+
|
|
647
|
+
<p>Delete ‘rowid` and its associated value from the underlying table (and `self` by extension). If `rowid` is not present, does nothing.</p>
|
|
648
|
+
|
|
649
|
+
<p>Note that the deleted row object will be returned but can no longer be used. In particular, it does not hold the contents of the deleted row.</p>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
</div>
|
|
653
|
+
</div>
|
|
654
|
+
<div class="tags">
|
|
655
|
+
|
|
656
|
+
<p class="tag_title">Returns:</p>
|
|
657
|
+
<ul class="return">
|
|
658
|
+
|
|
659
|
+
<li>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<span class='type'>(<tt><span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)</tt>)</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
—
|
|
667
|
+
<div class='inline'>
|
|
668
|
+
<p>The deleted value or nil</p>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</li>
|
|
672
|
+
|
|
673
|
+
</ul>
|
|
674
|
+
|
|
675
|
+
</div><table class="source_code">
|
|
676
|
+
<tr>
|
|
677
|
+
<td>
|
|
678
|
+
<pre class="lines">
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
89
|
|
682
|
+
90
|
|
683
|
+
91
|
|
684
|
+
92
|
|
685
|
+
93
|
|
686
|
+
94
|
|
687
|
+
95
|
|
688
|
+
96
|
|
689
|
+
97
|
|
690
|
+
98
|
|
691
|
+
99
|
|
692
|
+
100</pre>
|
|
693
|
+
</td>
|
|
694
|
+
<td>
|
|
695
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 89</span>
|
|
696
|
+
|
|
697
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_rowid'>rowid</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
698
|
+
<span class='id identifier rubyid_transaction'>transaction</span> <span class='lbrace'>{</span>
|
|
699
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span>
|
|
700
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
|
|
701
|
+
<span class='kw'>return</span> <span class='kw'>nil</span>
|
|
702
|
+
<span class='kw'>end</span>
|
|
703
|
+
|
|
704
|
+
<span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_rowid'>rowid</span><span class='rbracket'>]</span>
|
|
705
|
+
<span class='ivar'>@dataset</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>_id:</span> <span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span>
|
|
706
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_val'>val</span>
|
|
707
|
+
<span class='rbrace'>}</span>
|
|
708
|
+
<span class='kw'>end</span></pre>
|
|
709
|
+
</td>
|
|
710
|
+
</tr>
|
|
711
|
+
</table>
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
<div class="method_details ">
|
|
715
|
+
<h3 class="signature " id="delete_if-instance_method">
|
|
716
|
+
|
|
717
|
+
#<strong>delete_if</strong> {|value| ... } ⇒ <tt>Object</tt>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
<span class="aliases">Also known as:
|
|
722
|
+
<span class="names"><span id='reject!-instance_method'>reject!</span></span>
|
|
723
|
+
</span>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
</h3><div class="docstring">
|
|
728
|
+
<div class="discussion">
|
|
729
|
+
|
|
730
|
+
<p>Evaluate the block on each key-value pair in ‘self` end delete each entry for which the block returns true.</p>
|
|
731
|
+
|
|
732
|
+
<p>Like all enumeration operations, the tests and deletions occur in a single transaction.</p>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
</div>
|
|
736
|
+
</div>
|
|
737
|
+
<div class="tags">
|
|
738
|
+
|
|
739
|
+
<p class="tag_title">Yields:</p>
|
|
740
|
+
<ul class="yield">
|
|
741
|
+
|
|
742
|
+
<li>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
<span class='type'>(<tt>value</tt>)</span>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
—
|
|
750
|
+
<div class='inline'>
|
|
751
|
+
<p>The block to evaluate</p>
|
|
752
|
+
</div>
|
|
753
|
+
|
|
754
|
+
</li>
|
|
755
|
+
|
|
756
|
+
</ul>
|
|
757
|
+
|
|
758
|
+
</div><table class="source_code">
|
|
759
|
+
<tr>
|
|
760
|
+
<td>
|
|
761
|
+
<pre class="lines">
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
109
|
|
765
|
+
110
|
|
766
|
+
111
|
|
767
|
+
112
|
|
768
|
+
113
|
|
769
|
+
114</pre>
|
|
770
|
+
</td>
|
|
771
|
+
<td>
|
|
772
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 109</span>
|
|
773
|
+
|
|
774
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_if'>delete_if</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
775
|
+
<span class='id identifier rubyid_transaction'>transaction</span> <span class='lbrace'>{</span>
|
|
776
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
777
|
+
<span class='rbrace'>}</span>
|
|
778
|
+
<span class='kw'>return</span> <span class='kw'>self</span>
|
|
779
|
+
<span class='kw'>end</span></pre>
|
|
780
|
+
</td>
|
|
781
|
+
</tr>
|
|
782
|
+
</table>
|
|
783
|
+
</div>
|
|
784
|
+
|
|
785
|
+
<div class="method_details ">
|
|
786
|
+
<h3 class="signature " id="each-instance_method">
|
|
787
|
+
|
|
788
|
+
#<strong>each</strong>(&block) ⇒ <tt>Object</tt>
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<span class="aliases">Also known as:
|
|
793
|
+
<span class="names"><span id='each_pair-instance_method'>each_pair</span></span>
|
|
794
|
+
</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
</h3><div class="docstring">
|
|
799
|
+
<div class="discussion">
|
|
800
|
+
|
|
801
|
+
<p>Evaluate ‘block` over each key-and-value pair (i.e. row and row-id). If no block is given, returns an Enumerator instead.</p>
|
|
802
|
+
|
|
803
|
+
<p>It is safe to perform other database operations inside the block or enumeration loop. This includes modifications to the database being enumerated, although whether or not added or removed items are still visited is undefined.</p>
|
|
804
|
+
|
|
805
|
+
<p>If called with a block, the entire operation happens within a single transaction.</p>
|
|
806
|
+
|
|
807
|
+
<p>Since this class imports Enumerable, all of its functionality is also available.</p>
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
</div>
|
|
811
|
+
</div>
|
|
812
|
+
<div class="tags">
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
</div><table class="source_code">
|
|
816
|
+
<tr>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="lines">
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
142</pre>
|
|
822
|
+
</td>
|
|
823
|
+
<td>
|
|
824
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 142</span>
|
|
825
|
+
|
|
826
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_each_backend'>each_backend</span><span class='lparen'>(</span><span class='symbol'>:basic_each</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span></pre>
|
|
827
|
+
</td>
|
|
828
|
+
</tr>
|
|
829
|
+
</table>
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
<div class="method_details ">
|
|
833
|
+
<h3 class="signature " id="each_key-instance_method">
|
|
834
|
+
|
|
835
|
+
#<strong>each_key</strong>(&block) ⇒ <tt>Object</tt>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
</h3><div class="docstring">
|
|
842
|
+
<div class="discussion">
|
|
843
|
+
|
|
844
|
+
<p>Like <span class='object_link'><a href="#each-instance_method" title="DBStruct::BogoHash#each (method)">#each</a></span> but only yields the key (i.e. row ID).</p>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</div>
|
|
848
|
+
</div>
|
|
849
|
+
<div class="tags">
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</div><table class="source_code">
|
|
853
|
+
<tr>
|
|
854
|
+
<td>
|
|
855
|
+
<pre class="lines">
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
146</pre>
|
|
859
|
+
</td>
|
|
860
|
+
<td>
|
|
861
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 146</span>
|
|
862
|
+
|
|
863
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_each_key'>each_key</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_each_backend'>each_backend</span><span class='lparen'>(</span><span class='symbol'>:basic_each_key</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span></pre>
|
|
864
|
+
</td>
|
|
865
|
+
</tr>
|
|
866
|
+
</table>
|
|
867
|
+
</div>
|
|
868
|
+
|
|
869
|
+
<div class="method_details ">
|
|
870
|
+
<h3 class="signature " id="each_value-instance_method">
|
|
871
|
+
|
|
872
|
+
#<strong>each_value</strong>(&block) ⇒ <tt>Object</tt>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
</h3><div class="docstring">
|
|
879
|
+
<div class="discussion">
|
|
880
|
+
|
|
881
|
+
<p>Like <span class='object_link'><a href="#each-instance_method" title="DBStruct::BogoHash#each (method)">#each</a></span> but only yields the value.</p>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
</div>
|
|
885
|
+
</div>
|
|
886
|
+
<div class="tags">
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
</div><table class="source_code">
|
|
890
|
+
<tr>
|
|
891
|
+
<td>
|
|
892
|
+
<pre class="lines">
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
149</pre>
|
|
896
|
+
</td>
|
|
897
|
+
<td>
|
|
898
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 149</span>
|
|
899
|
+
|
|
900
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_each_value'>each_value</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_each_backend'>each_backend</span><span class='lparen'>(</span><span class='symbol'>:basic_each_value</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span></pre>
|
|
901
|
+
</td>
|
|
902
|
+
</tr>
|
|
903
|
+
</table>
|
|
904
|
+
</div>
|
|
905
|
+
|
|
906
|
+
<div class="method_details ">
|
|
907
|
+
<h3 class="signature " id="empty?-instance_method">
|
|
908
|
+
|
|
909
|
+
#<strong>empty?</strong> ⇒ <tt>Boolean</tt>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
</h3><div class="docstring">
|
|
916
|
+
<div class="discussion">
|
|
917
|
+
|
|
918
|
+
<p>Test if self has no items</p>
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
</div>
|
|
922
|
+
</div>
|
|
923
|
+
<div class="tags">
|
|
924
|
+
|
|
925
|
+
<p class="tag_title">Returns:</p>
|
|
926
|
+
<ul class="return">
|
|
927
|
+
|
|
928
|
+
<li>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
</li>
|
|
936
|
+
|
|
937
|
+
</ul>
|
|
938
|
+
|
|
939
|
+
</div><table class="source_code">
|
|
940
|
+
<tr>
|
|
941
|
+
<td>
|
|
942
|
+
<pre class="lines">
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
61</pre>
|
|
946
|
+
</td>
|
|
947
|
+
<td>
|
|
948
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 61</span>
|
|
949
|
+
|
|
950
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>=</span> <span class='id identifier rubyid_size'>size</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span></pre>
|
|
951
|
+
</td>
|
|
952
|
+
</tr>
|
|
953
|
+
</table>
|
|
954
|
+
</div>
|
|
955
|
+
|
|
956
|
+
<div class="method_details ">
|
|
957
|
+
<h3 class="signature " id="has_key?-instance_method">
|
|
958
|
+
|
|
959
|
+
#<strong>has_key?</strong>(rowid) ⇒ <tt>Boolean</tt>
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
<span class="aliases">Also known as:
|
|
964
|
+
<span class="names"><span id='include?-instance_method'>include?</span>, <span id='member?-instance_method'>member?</span>, <span id='key?-instance_method'>key?</span></span>
|
|
965
|
+
</span>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
</h3><div class="docstring">
|
|
970
|
+
<div class="discussion">
|
|
971
|
+
|
|
972
|
+
<p>Test if ‘rowid` is one of the keys in `self`.</p>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
</div>
|
|
976
|
+
</div>
|
|
977
|
+
<div class="tags">
|
|
978
|
+
|
|
979
|
+
<p class="tag_title">Returns:</p>
|
|
980
|
+
<ul class="return">
|
|
981
|
+
|
|
982
|
+
<li>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
</li>
|
|
990
|
+
|
|
991
|
+
</ul>
|
|
992
|
+
|
|
993
|
+
</div><table class="source_code">
|
|
994
|
+
<tr>
|
|
995
|
+
<td>
|
|
996
|
+
<pre class="lines">
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
51</pre>
|
|
1000
|
+
</td>
|
|
1001
|
+
<td>
|
|
1002
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 51</span>
|
|
1003
|
+
|
|
1004
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_rowid'>rowid</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='op'>!</span><span class='op'>!</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_rowid'>rowid</span><span class='rbracket'>]</span></pre>
|
|
1005
|
+
</td>
|
|
1006
|
+
</tr>
|
|
1007
|
+
</table>
|
|
1008
|
+
</div>
|
|
1009
|
+
|
|
1010
|
+
<div class="method_details ">
|
|
1011
|
+
<h3 class="signature " id="inspect-instance_method">
|
|
1012
|
+
|
|
1013
|
+
#<strong>inspect</strong> ⇒ <tt>String</tt>
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<span class="aliases">Also known as:
|
|
1018
|
+
<span class="names"><span id='to_s-instance_method'>to_s</span></span>
|
|
1019
|
+
</span>
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
</h3><div class="docstring">
|
|
1024
|
+
<div class="discussion">
|
|
1025
|
+
|
|
1026
|
+
<p>Return a human-friendly string describing this object.</p>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
</div>
|
|
1030
|
+
</div>
|
|
1031
|
+
<div class="tags">
|
|
1032
|
+
|
|
1033
|
+
<p class="tag_title">Returns:</p>
|
|
1034
|
+
<ul class="return">
|
|
1035
|
+
|
|
1036
|
+
<li>
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
</li>
|
|
1044
|
+
|
|
1045
|
+
</ul>
|
|
1046
|
+
|
|
1047
|
+
</div><table class="source_code">
|
|
1048
|
+
<tr>
|
|
1049
|
+
<td>
|
|
1050
|
+
<pre class="lines">
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
36
|
|
1054
|
+
37
|
|
1055
|
+
38
|
|
1056
|
+
39
|
|
1057
|
+
40</pre>
|
|
1058
|
+
</td>
|
|
1059
|
+
<td>
|
|
1060
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 36</span>
|
|
1061
|
+
|
|
1062
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
|
|
1063
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1064
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>(</span><span class='embexpr_beg'>#{</span><span class='ivar'>@query</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:inspect</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>, </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@query</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
1065
|
+
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@dbs_klass</span><span class='embexpr_end'>}</span><span class='tstring_content'>.items</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
1066
|
+
<span class='kw'>end</span></pre>
|
|
1067
|
+
</td>
|
|
1068
|
+
</tr>
|
|
1069
|
+
</table>
|
|
1070
|
+
</div>
|
|
1071
|
+
|
|
1072
|
+
<div class="method_details ">
|
|
1073
|
+
<h3 class="signature " id="keys-instance_method">
|
|
1074
|
+
|
|
1075
|
+
#<strong>keys</strong> ⇒ <tt>Array[Integer]</tt>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
</h3><div class="docstring">
|
|
1082
|
+
<div class="discussion">
|
|
1083
|
+
|
|
1084
|
+
<p>Return all keys.</p>
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
</div>
|
|
1088
|
+
</div>
|
|
1089
|
+
<div class="tags">
|
|
1090
|
+
|
|
1091
|
+
<p class="tag_title">Returns:</p>
|
|
1092
|
+
<ul class="return">
|
|
1093
|
+
|
|
1094
|
+
<li>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
<span class='type'>(<tt>Array[Integer]</tt>)</span>
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
—
|
|
1102
|
+
<div class='inline'><ul><li>
|
|
1103
|
+
<p>the row IDs</p>
|
|
1104
|
+
</li></ul>
|
|
1105
|
+
</div>
|
|
1106
|
+
|
|
1107
|
+
</li>
|
|
1108
|
+
|
|
1109
|
+
</ul>
|
|
1110
|
+
|
|
1111
|
+
</div><table class="source_code">
|
|
1112
|
+
<tr>
|
|
1113
|
+
<td>
|
|
1114
|
+
<pre class="lines">
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
65</pre>
|
|
1118
|
+
</td>
|
|
1119
|
+
<td>
|
|
1120
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 65</span>
|
|
1121
|
+
|
|
1122
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span> <span class='op'>=</span> <span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_k'>k</span><span class='rbrace'>}</span></pre>
|
|
1123
|
+
</td>
|
|
1124
|
+
</tr>
|
|
1125
|
+
</table>
|
|
1126
|
+
</div>
|
|
1127
|
+
|
|
1128
|
+
<div class="method_details ">
|
|
1129
|
+
<h3 class="signature " id="size-instance_method">
|
|
1130
|
+
|
|
1131
|
+
#<strong>size</strong> ⇒ <tt>Object</tt>
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<span class="aliases">Also known as:
|
|
1136
|
+
<span class="names"><span id='length-instance_method'>length</span></span>
|
|
1137
|
+
</span>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
</h3><div class="docstring">
|
|
1142
|
+
<div class="discussion">
|
|
1143
|
+
|
|
1144
|
+
<p>Return the number of items in ‘self`.</p>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
</div>
|
|
1148
|
+
</div>
|
|
1149
|
+
<div class="tags">
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
</div><table class="source_code">
|
|
1153
|
+
<tr>
|
|
1154
|
+
<td>
|
|
1155
|
+
<pre class="lines">
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
57</pre>
|
|
1159
|
+
</td>
|
|
1160
|
+
<td>
|
|
1161
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 57</span>
|
|
1162
|
+
|
|
1163
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='ivar'>@dataset</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span></pre>
|
|
1164
|
+
</td>
|
|
1165
|
+
</tr>
|
|
1166
|
+
</table>
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
<div class="method_details ">
|
|
1170
|
+
<h3 class="signature " id="to_a-instance_method">
|
|
1171
|
+
|
|
1172
|
+
#<strong>to_a</strong> ⇒ <tt>Array[Array[Integer, <span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)]]</tt>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
</h3><div class="docstring">
|
|
1179
|
+
<div class="discussion">
|
|
1180
|
+
|
|
1181
|
+
<p>Return all keys and values as an array of two-element arrays.</p>
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
</div>
|
|
1185
|
+
</div>
|
|
1186
|
+
<div class="tags">
|
|
1187
|
+
|
|
1188
|
+
<p class="tag_title">Returns:</p>
|
|
1189
|
+
<ul class="return">
|
|
1190
|
+
|
|
1191
|
+
<li>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
<span class='type'>(<tt>Array[Array[Integer, <span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)]]</tt>)</span>
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
</li>
|
|
1199
|
+
|
|
1200
|
+
</ul>
|
|
1201
|
+
|
|
1202
|
+
</div><table class="source_code">
|
|
1203
|
+
<tr>
|
|
1204
|
+
<td>
|
|
1205
|
+
<pre class="lines">
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
73</pre>
|
|
1209
|
+
</td>
|
|
1210
|
+
<td>
|
|
1211
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 73</span>
|
|
1212
|
+
|
|
1213
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span> <span class='op'>=</span> <span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rbracket'>]</span><span class='rbrace'>}</span></pre>
|
|
1214
|
+
</td>
|
|
1215
|
+
</tr>
|
|
1216
|
+
</table>
|
|
1217
|
+
</div>
|
|
1218
|
+
|
|
1219
|
+
<div class="method_details ">
|
|
1220
|
+
<h3 class="signature " id="transaction-instance_method">
|
|
1221
|
+
|
|
1222
|
+
#<strong>transaction</strong>(*args, **kwargs, &block) ⇒ <tt>Object</tt>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</h3><div class="docstring">
|
|
1229
|
+
<div class="discussion">
|
|
1230
|
+
|
|
1231
|
+
<p>Calls the underling ‘Sequel::Database#transaction` methods with all arguments.</p>
|
|
1232
|
+
|
|
1233
|
+
<p>Convenience method.</p>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
</div>
|
|
1237
|
+
</div>
|
|
1238
|
+
<div class="tags">
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
</div><table class="source_code">
|
|
1242
|
+
<tr>
|
|
1243
|
+
<td>
|
|
1244
|
+
<pre class="lines">
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
224
|
|
1248
|
+
225</pre>
|
|
1249
|
+
</td>
|
|
1250
|
+
<td>
|
|
1251
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 224</span>
|
|
1252
|
+
|
|
1253
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_transaction'>transaction</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='op'>=</span>
|
|
1254
|
+
<span class='ivar'>@dbs_klass</span><span class='period'>.</span><span class='id identifier rubyid_transaction'>transaction</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span></pre>
|
|
1255
|
+
</td>
|
|
1256
|
+
</tr>
|
|
1257
|
+
</table>
|
|
1258
|
+
</div>
|
|
1259
|
+
|
|
1260
|
+
<div class="method_details ">
|
|
1261
|
+
<h3 class="signature " id="values-instance_method">
|
|
1262
|
+
|
|
1263
|
+
#<strong>values</strong> ⇒ <tt>Array[<span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)]</tt>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
</h3><div class="docstring">
|
|
1270
|
+
<div class="discussion">
|
|
1271
|
+
|
|
1272
|
+
<p>Return all values.</p>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
</div>
|
|
1276
|
+
</div>
|
|
1277
|
+
<div class="tags">
|
|
1278
|
+
|
|
1279
|
+
<p class="tag_title">Returns:</p>
|
|
1280
|
+
<ul class="return">
|
|
1281
|
+
|
|
1282
|
+
<li>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
<span class='type'>(<tt>Array[<span class='object_link'><a href="../DBStruct.html" title="DBStruct (class)">DBStruct</a></span>.<span class='object_link'><a href="../DBStruct.html#with-class_method" title="DBStruct.with (method)">with</a></span>(...)]</tt>)</span>
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
</li>
|
|
1290
|
+
|
|
1291
|
+
</ul>
|
|
1292
|
+
|
|
1293
|
+
</div><table class="source_code">
|
|
1294
|
+
<tr>
|
|
1295
|
+
<td>
|
|
1296
|
+
<pre class="lines">
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
69</pre>
|
|
1300
|
+
</td>
|
|
1301
|
+
<td>
|
|
1302
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 69</span>
|
|
1303
|
+
|
|
1304
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span> <span class='op'>=</span> <span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='rbrace'>}</span></pre>
|
|
1305
|
+
</td>
|
|
1306
|
+
</tr>
|
|
1307
|
+
</table>
|
|
1308
|
+
</div>
|
|
1309
|
+
|
|
1310
|
+
<div class="method_details ">
|
|
1311
|
+
<h3 class="signature " id="where-instance_method">
|
|
1312
|
+
|
|
1313
|
+
#<strong>where</strong>(*cond, **kwcond, &block) ⇒ <tt><span class='object_link'><a href="" title="DBStruct::BogoHash (class)">BogoHash</a></span></tt>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
</h3><div class="docstring">
|
|
1320
|
+
<div class="discussion">
|
|
1321
|
+
|
|
1322
|
+
<p>Expose ‘Sequel::Dataset#where` for more advanced querying.</p>
|
|
1323
|
+
|
|
1324
|
+
<p>The underlying ‘Sequel::Dataset`’s ‘where` method is called with all of the arguments and the result is a new BogoHash containing only the items that match the query.</p>
|
|
1325
|
+
|
|
1326
|
+
<p>This is the Bigger Hammer you can use to narrow a down to a subset of your data when groups are not enough.</p>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
</div>
|
|
1330
|
+
</div>
|
|
1331
|
+
<div class="tags">
|
|
1332
|
+
|
|
1333
|
+
<p class="tag_title">Returns:</p>
|
|
1334
|
+
<ul class="return">
|
|
1335
|
+
|
|
1336
|
+
<li>
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="DBStruct::BogoHash (class)">BogoHash</a></span></tt>)</span>
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
</li>
|
|
1344
|
+
|
|
1345
|
+
</ul>
|
|
1346
|
+
|
|
1347
|
+
</div><table class="source_code">
|
|
1348
|
+
<tr>
|
|
1349
|
+
<td>
|
|
1350
|
+
<pre class="lines">
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
210
|
|
1354
|
+
211
|
|
1355
|
+
212
|
|
1356
|
+
213
|
|
1357
|
+
214</pre>
|
|
1358
|
+
</td>
|
|
1359
|
+
<td>
|
|
1360
|
+
<pre class="code"><span class="info file"># File 'lib/internal/bogohash.rb', line 210</span>
|
|
1361
|
+
|
|
1362
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_cond'>cond</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwcond'>kwcond</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1363
|
+
<span class='id identifier rubyid_new_dataset'>new_dataset</span> <span class='op'>=</span> <span class='ivar'>@dataset</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_cond'>cond</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwcond'>kwcond</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1364
|
+
<span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SQL:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_new_dataset'>new_dataset</span><span class='period'>.</span><span class='id identifier rubyid_sql'>sql</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
1365
|
+
<span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@dbs_klass</span><span class='comma'>,</span> <span class='id identifier rubyid_new_dataset'>new_dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='rparen'>)</span>
|
|
1366
|
+
<span class='kw'>end</span></pre>
|
|
1367
|
+
</td>
|
|
1368
|
+
</tr>
|
|
1369
|
+
</table>
|
|
1370
|
+
</div>
|
|
1371
|
+
|
|
1372
|
+
</div>
|
|
1373
|
+
|
|
1374
|
+
</div>
|
|
1375
|
+
|
|
1376
|
+
<div id="footer">
|
|
1377
|
+
Generated on Wed Sep 11 13:00:27 2024 by
|
|
1378
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1379
|
+
0.9.37 (ruby-3.1.4).
|
|
1380
|
+
</div>
|
|
1381
|
+
|
|
1382
|
+
</div>
|
|
1383
|
+
</body>
|
|
1384
|
+
</html>
|