dynamoid 0.4.0 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- data/Dynamoid.gemspec +5 -3
- data/README.markdown +2 -2
- data/VERSION +1 -1
- data/doc/Dynamoid.html +26 -14
- data/doc/Dynamoid/Adapter.html +33 -35
- data/doc/Dynamoid/Adapter/AwsSdk.html +177 -153
- data/doc/Dynamoid/Adapter/Local.html +144 -57
- data/doc/Dynamoid/Associations.html +3 -3
- data/doc/Dynamoid/Associations/Association.html +104 -1016
- data/doc/Dynamoid/Associations/BelongsTo.html +11 -192
- data/doc/Dynamoid/Associations/ClassMethods.html +17 -17
- data/doc/Dynamoid/Associations/HasAndBelongsToMany.html +15 -190
- data/doc/Dynamoid/Associations/HasMany.html +15 -190
- data/doc/Dynamoid/Associations/HasOne.html +11 -192
- data/doc/Dynamoid/Associations/ManyAssociation.html +1640 -0
- data/doc/Dynamoid/Associations/SingleAssociation.html +598 -0
- data/doc/Dynamoid/Components.html +4 -2
- data/doc/Dynamoid/Config.html +10 -10
- data/doc/Dynamoid/Config/Options.html +1 -1
- data/doc/Dynamoid/Criteria.html +1 -1
- data/doc/Dynamoid/Criteria/Chain.html +326 -22
- data/doc/Dynamoid/Criteria/ClassMethods.html +1 -1
- data/doc/Dynamoid/Document.html +181 -27
- data/doc/Dynamoid/Document/ClassMethods.html +392 -36
- data/doc/Dynamoid/Errors.html +1 -1
- data/doc/Dynamoid/Errors/DocumentNotValid.html +1 -1
- data/doc/Dynamoid/Errors/Error.html +1 -1
- data/doc/Dynamoid/Errors/InvalidField.html +1 -1
- data/doc/Dynamoid/Errors/MissingRangeKey.html +1 -1
- data/doc/Dynamoid/Fields.html +44 -24
- data/doc/Dynamoid/Fields/ClassMethods.html +60 -15
- data/doc/Dynamoid/Finders.html +1 -1
- data/doc/Dynamoid/Finders/ClassMethods.html +45 -31
- data/doc/Dynamoid/Indexes.html +7 -7
- data/doc/Dynamoid/Indexes/ClassMethods.html +6 -4
- data/doc/Dynamoid/Indexes/Index.html +47 -32
- data/doc/Dynamoid/Persistence.html +47 -49
- data/doc/Dynamoid/Persistence/ClassMethods.html +149 -47
- data/doc/Dynamoid/Validations.html +1 -1
- data/doc/_index.html +35 -13
- data/doc/class_list.html +1 -1
- data/doc/file.LICENSE.html +1 -1
- data/doc/file.README.html +37 -4
- data/doc/index.html +37 -4
- data/doc/method_list.html +320 -136
- data/doc/top-level-namespace.html +1 -1
- data/lib/dynamoid/adapter.rb +28 -30
- data/lib/dynamoid/adapter/aws_sdk.rb +23 -22
- data/lib/dynamoid/persistence.rb +33 -27
- metadata +6 -4
data/doc/Dynamoid/Document.html
CHANGED
@@ -150,6 +150,50 @@ the database as documents.</p>
|
|
150
150
|
<span class="summary_desc"><div class='inline'><p>An object is equal to another object if their ids are equal.</p>
|
151
151
|
</div></span>
|
152
152
|
|
153
|
+
</li>
|
154
|
+
|
155
|
+
|
156
|
+
<li class="public ">
|
157
|
+
<span class="summary_signature">
|
158
|
+
|
159
|
+
<a href="#hash_key-instance_method" title="#hash_key (instance method)">- (Object) <strong>hash_key</strong> </a>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
</span>
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<span class="summary_desc"><div class='inline'><p>Return an object's hash key, regardless of what it might be called to the object.</p>
|
173
|
+
</div></span>
|
174
|
+
|
175
|
+
</li>
|
176
|
+
|
177
|
+
|
178
|
+
<li class="public ">
|
179
|
+
<span class="summary_signature">
|
180
|
+
|
181
|
+
<a href="#hash_key%3D-instance_method" title="#hash_key= (instance method)">- (Object) <strong>hash_key=</strong>(key) </a>
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
</span>
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
<span class="summary_desc"><div class='inline'><p>Assign an object's hash key, regardless of what it might be called to the object.</p>
|
195
|
+
</div></span>
|
196
|
+
|
153
197
|
</li>
|
154
198
|
|
155
199
|
|
@@ -279,6 +323,8 @@ changes to be reflected immediately, you would call this method.</p>
|
|
279
323
|
|
280
324
|
|
281
325
|
|
326
|
+
|
327
|
+
|
282
328
|
|
283
329
|
<div id="instance_method_details" class="method_details_list">
|
284
330
|
<h2>Instance Method Details</h2>
|
@@ -322,17 +368,123 @@ changes to be reflected immediately, you would call this method.</p>
|
|
322
368
|
<pre class="lines">
|
323
369
|
|
324
370
|
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
371
|
+
118
|
372
|
+
119
|
373
|
+
120
|
374
|
+
121</pre>
|
329
375
|
</td>
|
330
376
|
<td>
|
331
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
377
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 118</span>
|
332
378
|
|
333
379
|
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
334
380
|
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
335
|
-
<span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:
|
381
|
+
<span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:hash_key</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_hash_key'>hash_key</span> <span class='op'>==</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hash_key'>hash_key</span>
|
382
|
+
<span class='kw'>end</span></pre>
|
383
|
+
</td>
|
384
|
+
</tr>
|
385
|
+
</table>
|
386
|
+
</div>
|
387
|
+
|
388
|
+
<div class="method_details ">
|
389
|
+
<p class="signature " id="hash_key-instance_method">
|
390
|
+
|
391
|
+
- (<tt>Object</tt>) <strong>hash_key</strong>
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
</p><div class="docstring">
|
396
|
+
<div class="discussion">
|
397
|
+
<p>Return an object's hash key, regardless of what it might be called to the object.</p>
|
398
|
+
|
399
|
+
|
400
|
+
</div>
|
401
|
+
</div>
|
402
|
+
<div class="tags">
|
403
|
+
|
404
|
+
<h3>Since:</h3>
|
405
|
+
<ul class="since">
|
406
|
+
|
407
|
+
<li>
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
<div class='inline'><p>0.4.0</p>
|
414
|
+
</div>
|
415
|
+
|
416
|
+
</li>
|
417
|
+
|
418
|
+
</ul>
|
419
|
+
|
420
|
+
</div><table class="source_code">
|
421
|
+
<tr>
|
422
|
+
<td>
|
423
|
+
<pre class="lines">
|
424
|
+
|
425
|
+
|
426
|
+
138
|
427
|
+
139
|
428
|
+
140</pre>
|
429
|
+
</td>
|
430
|
+
<td>
|
431
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 138</span>
|
432
|
+
|
433
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash_key'>hash_key</span>
|
434
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</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_hash_key'>hash_key</span><span class='rparen'>)</span>
|
435
|
+
<span class='kw'>end</span></pre>
|
436
|
+
</td>
|
437
|
+
</tr>
|
438
|
+
</table>
|
439
|
+
</div>
|
440
|
+
|
441
|
+
<div class="method_details ">
|
442
|
+
<p class="signature " id="hash_key=-instance_method">
|
443
|
+
|
444
|
+
- (<tt>Object</tt>) <strong>hash_key=</strong>(key)
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
</p><div class="docstring">
|
449
|
+
<div class="discussion">
|
450
|
+
<p>Assign an object's hash key, regardless of what it might be called to the object.</p>
|
451
|
+
|
452
|
+
|
453
|
+
</div>
|
454
|
+
</div>
|
455
|
+
<div class="tags">
|
456
|
+
|
457
|
+
<h3>Since:</h3>
|
458
|
+
<ul class="since">
|
459
|
+
|
460
|
+
<li>
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
<div class='inline'><p>0.4.0</p>
|
467
|
+
</div>
|
468
|
+
|
469
|
+
</li>
|
470
|
+
|
471
|
+
</ul>
|
472
|
+
|
473
|
+
</div><table class="source_code">
|
474
|
+
<tr>
|
475
|
+
<td>
|
476
|
+
<pre class="lines">
|
477
|
+
|
478
|
+
|
479
|
+
145
|
480
|
+
146
|
481
|
+
147</pre>
|
482
|
+
</td>
|
483
|
+
<td>
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 145</span>
|
485
|
+
|
486
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash_key='>hash_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
487
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</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_hash_key'>hash_key</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
336
488
|
<span class='kw'>end</span></pre>
|
337
489
|
</td>
|
338
490
|
</tr>
|
@@ -398,27 +550,27 @@ changes to be reflected immediately, you would call this method.</p>
|
|
398
550
|
<pre class="lines">
|
399
551
|
|
400
552
|
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
553
|
+
105
|
554
|
+
106
|
555
|
+
107
|
556
|
+
108
|
557
|
+
109
|
558
|
+
110
|
559
|
+
111
|
560
|
+
112
|
561
|
+
113</pre>
|
410
562
|
</td>
|
411
563
|
<td>
|
412
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
564
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 105</span>
|
413
565
|
|
414
566
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
567
|
+
<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_send'>send</span><span class='lparen'>(</span><span class='symbol'>:field</span><span class='comma'>,</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_hash_key'>hash_key</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</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_hash_key'>hash_key</span><span class='rparen'>)</span>
|
568
|
+
|
415
569
|
<span class='ivar'>@new_record</span> <span class='op'>=</span> <span class='kw'>true</span>
|
416
570
|
<span class='ivar'>@attributes</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
417
|
-
<span class='
|
571
|
+
<span class='ivar'>@associations</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
418
572
|
|
419
|
-
<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
|
420
|
-
<span class='id identifier rubyid_send'>send</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_incoming_attributes'>incoming_attributes</span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span>
|
421
|
-
<span class='kw'>end</span>
|
573
|
+
<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_undump'>undump</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</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_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_send'>send</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rbrace'>}</span>
|
422
574
|
<span class='kw'>end</span></pre>
|
423
575
|
</td>
|
424
576
|
</tr>
|
@@ -481,16 +633,18 @@ changes to be reflected immediately, you would call this method.</p>
|
|
481
633
|
<pre class="lines">
|
482
634
|
|
483
635
|
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
636
|
+
129
|
637
|
+
130
|
638
|
+
131
|
639
|
+
132
|
640
|
+
133</pre>
|
488
641
|
</td>
|
489
642
|
<td>
|
490
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
643
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 129</span>
|
491
644
|
|
492
645
|
<span class='kw'>def</span> <span class='id identifier rubyid_reload'>reload</span>
|
493
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</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_find'>find</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier
|
646
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</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_find'>find</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hash_key'>hash_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span>
|
647
|
+
<span class='ivar'>@associations</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:reset</span><span class='rparen'>)</span>
|
494
648
|
<span class='kw'>self</span>
|
495
649
|
<span class='kw'>end</span></pre>
|
496
650
|
</td>
|
@@ -503,7 +657,7 @@ changes to be reflected immediately, you would call this method.</p>
|
|
503
657
|
</div>
|
504
658
|
|
505
659
|
<div id="footer">
|
506
|
-
Generated on
|
660
|
+
Generated on Thu Apr 26 01:26:24 2012 by
|
507
661
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
508
662
|
0.7.5 (ruby-1.9.3).
|
509
663
|
</div>
|
@@ -177,6 +177,95 @@
|
|
177
177
|
<span class="summary_desc"><div class='inline'><p>Does this object exist?.</p>
|
178
178
|
</div></span>
|
179
179
|
|
180
|
+
</li>
|
181
|
+
|
182
|
+
|
183
|
+
<li class="public ">
|
184
|
+
<span class="summary_signature">
|
185
|
+
|
186
|
+
<a href="#hash_key-instance_method" title="#hash_key (instance method)">- (Object) <strong>hash_key</strong> </a>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
</span>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
<span class="summary_desc"><div class='inline'><p>Returns the id field for this class.</p>
|
200
|
+
</div></span>
|
201
|
+
|
202
|
+
</li>
|
203
|
+
|
204
|
+
|
205
|
+
<li class="public ">
|
206
|
+
<span class="summary_signature">
|
207
|
+
|
208
|
+
<a href="#read_capacity-instance_method" title="#read_capacity (instance method)">- (Object) <strong>read_capacity</strong> </a>
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
</span>
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<span class="summary_desc"><div class='inline'><p>Returns the read_capacity for this table.</p>
|
222
|
+
</div></span>
|
223
|
+
|
224
|
+
</li>
|
225
|
+
|
226
|
+
|
227
|
+
<li class="public ">
|
228
|
+
<span class="summary_signature">
|
229
|
+
|
230
|
+
<a href="#table-instance_method" title="#table (instance method)">- (Object) <strong>table</strong>(options = {}) </a>
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
</span>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
<span class="summary_desc"><div class='inline'><p>Set up table options, including naming it whatever you want, setting the id key, and manually overriding read and
|
244
|
+
write capacity.</p>
|
245
|
+
</div></span>
|
246
|
+
|
247
|
+
</li>
|
248
|
+
|
249
|
+
|
250
|
+
<li class="public ">
|
251
|
+
<span class="summary_signature">
|
252
|
+
|
253
|
+
<a href="#write_capacity-instance_method" title="#write_capacity (instance method)">- (Object) <strong>write_capacity</strong> </a>
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
</span>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
<span class="summary_desc"><div class='inline'><p>Returns the write_capacity for this table.</p>
|
267
|
+
</div></span>
|
268
|
+
|
180
269
|
</li>
|
181
270
|
|
182
271
|
|
@@ -265,15 +354,15 @@
|
|
265
354
|
<pre class="lines">
|
266
355
|
|
267
356
|
|
268
|
-
|
269
|
-
|
270
|
-
|
357
|
+
82
|
358
|
+
83
|
359
|
+
84</pre>
|
271
360
|
</td>
|
272
361
|
<td>
|
273
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
362
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 82</span>
|
274
363
|
|
275
364
|
<span class='kw'>def</span> <span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
276
|
-
<span class='
|
365
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
|
277
366
|
<span class='kw'>end</span></pre>
|
278
367
|
</td>
|
279
368
|
</tr>
|
@@ -356,23 +445,15 @@
|
|
356
445
|
<pre class="lines">
|
357
446
|
|
358
447
|
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
26
|
363
|
-
27
|
364
|
-
28
|
365
|
-
29</pre>
|
448
|
+
60
|
449
|
+
61
|
450
|
+
62</pre>
|
366
451
|
</td>
|
367
452
|
<td>
|
368
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
453
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 60</span>
|
369
454
|
|
370
455
|
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
371
|
-
<span class='id identifier
|
372
|
-
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_run_callbacks'>run_callbacks</span><span class='lparen'>(</span><span class='symbol'>:create</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
373
|
-
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
374
|
-
<span class='kw'>end</span>
|
375
|
-
<span class='id identifier rubyid_obj'>obj</span>
|
456
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:save</span><span class='rparen'>)</span>
|
376
457
|
<span class='kw'>end</span></pre>
|
377
458
|
</td>
|
378
459
|
</tr>
|
@@ -455,23 +536,15 @@
|
|
455
536
|
<pre class="lines">
|
456
537
|
|
457
538
|
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
41
|
462
|
-
42
|
463
|
-
43
|
464
|
-
44</pre>
|
539
|
+
71
|
540
|
+
72
|
541
|
+
73</pre>
|
465
542
|
</td>
|
466
543
|
<td>
|
467
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
544
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 71</span>
|
468
545
|
|
469
546
|
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
470
|
-
<span class='id identifier
|
471
|
-
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_run_callbacks'>run_callbacks</span><span class='lparen'>(</span><span class='symbol'>:create</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
472
|
-
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_save!'>save!</span>
|
473
|
-
<span class='kw'>end</span>
|
474
|
-
<span class='id identifier rubyid_obj'>obj</span>
|
547
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:save!</span><span class='rparen'>)</span>
|
475
548
|
<span class='kw'>end</span></pre>
|
476
549
|
</td>
|
477
550
|
</tr>
|
@@ -552,12 +625,12 @@
|
|
552
625
|
<pre class="lines">
|
553
626
|
|
554
627
|
|
555
|
-
|
556
|
-
|
557
|
-
|
628
|
+
93
|
629
|
+
94
|
630
|
+
95</pre>
|
558
631
|
</td>
|
559
632
|
<td>
|
560
|
-
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line
|
633
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 93</span>
|
561
634
|
|
562
635
|
<span class='kw'>def</span> <span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
563
636
|
<span class='op'>!</span><span class='op'>!</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
@@ -565,6 +638,289 @@
|
|
565
638
|
</td>
|
566
639
|
</tr>
|
567
640
|
</table>
|
641
|
+
</div>
|
642
|
+
|
643
|
+
<div class="method_details ">
|
644
|
+
<p class="signature " id="hash_key-instance_method">
|
645
|
+
|
646
|
+
- (<tt>Object</tt>) <strong>hash_key</strong>
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
</p><div class="docstring">
|
651
|
+
<div class="discussion">
|
652
|
+
<p>Returns the id field for this class.</p>
|
653
|
+
|
654
|
+
|
655
|
+
</div>
|
656
|
+
</div>
|
657
|
+
<div class="tags">
|
658
|
+
|
659
|
+
<h3>Since:</h3>
|
660
|
+
<ul class="since">
|
661
|
+
|
662
|
+
<li>
|
663
|
+
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
|
668
|
+
<div class='inline'><p>0.4.0</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
|
+
49
|
682
|
+
50
|
683
|
+
51</pre>
|
684
|
+
</td>
|
685
|
+
<td>
|
686
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 49</span>
|
687
|
+
|
688
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash_key'>hash_key</span>
|
689
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='symbol'>:id</span>
|
690
|
+
<span class='kw'>end</span></pre>
|
691
|
+
</td>
|
692
|
+
</tr>
|
693
|
+
</table>
|
694
|
+
</div>
|
695
|
+
|
696
|
+
<div class="method_details ">
|
697
|
+
<p class="signature " id="read_capacity-instance_method">
|
698
|
+
|
699
|
+
- (<tt>Object</tt>) <strong>read_capacity</strong>
|
700
|
+
|
701
|
+
|
702
|
+
|
703
|
+
</p><div class="docstring">
|
704
|
+
<div class="discussion">
|
705
|
+
<p>Returns the read_capacity for this table.</p>
|
706
|
+
|
707
|
+
|
708
|
+
</div>
|
709
|
+
</div>
|
710
|
+
<div class="tags">
|
711
|
+
|
712
|
+
<h3>Since:</h3>
|
713
|
+
<ul class="since">
|
714
|
+
|
715
|
+
<li>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
|
721
|
+
<div class='inline'><p>0.4.0</p>
|
722
|
+
</div>
|
723
|
+
|
724
|
+
</li>
|
725
|
+
|
726
|
+
</ul>
|
727
|
+
|
728
|
+
</div><table class="source_code">
|
729
|
+
<tr>
|
730
|
+
<td>
|
731
|
+
<pre class="lines">
|
732
|
+
|
733
|
+
|
734
|
+
35
|
735
|
+
36
|
736
|
+
37</pre>
|
737
|
+
</td>
|
738
|
+
<td>
|
739
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 35</span>
|
740
|
+
|
741
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_read_capacity'>read_capacity</span>
|
742
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:read_capacity</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>Dynamoid</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_read_capacity'>read_capacity</span>
|
743
|
+
<span class='kw'>end</span></pre>
|
744
|
+
</td>
|
745
|
+
</tr>
|
746
|
+
</table>
|
747
|
+
</div>
|
748
|
+
|
749
|
+
<div class="method_details ">
|
750
|
+
<p class="signature " id="table-instance_method">
|
751
|
+
|
752
|
+
- (<tt>Object</tt>) <strong>table</strong>(options = {})
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
</p><div class="docstring">
|
757
|
+
<div class="discussion">
|
758
|
+
<p>Set up table options, including naming it whatever you want, setting the id key, and manually overriding read and
|
759
|
+
write capacity.</p>
|
760
|
+
|
761
|
+
|
762
|
+
</div>
|
763
|
+
</div>
|
764
|
+
<div class="tags">
|
765
|
+
<h3>Parameters:</h3>
|
766
|
+
<ul class="param">
|
767
|
+
|
768
|
+
<li>
|
769
|
+
|
770
|
+
<span class='name'>options</span>
|
771
|
+
|
772
|
+
|
773
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
774
|
+
|
775
|
+
|
776
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
777
|
+
|
778
|
+
|
779
|
+
—
|
780
|
+
<div class='inline'><p>options to pass for this table</p>
|
781
|
+
</div>
|
782
|
+
|
783
|
+
</li>
|
784
|
+
|
785
|
+
</ul>
|
786
|
+
|
787
|
+
|
788
|
+
|
789
|
+
|
790
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
791
|
+
<ul class="option">
|
792
|
+
|
793
|
+
<li>
|
794
|
+
<span class="name">:name</span>
|
795
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
796
|
+
<span class="default">
|
797
|
+
|
798
|
+
</span>
|
799
|
+
— <div class='inline'><p>the name for the table; this still gets namespaced</p>
|
800
|
+
</div>
|
801
|
+
</li>
|
802
|
+
|
803
|
+
<li>
|
804
|
+
<span class="name">:id</span>
|
805
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
806
|
+
<span class="default">
|
807
|
+
|
808
|
+
</span>
|
809
|
+
— <div class='inline'><p>id column for the table</p>
|
810
|
+
</div>
|
811
|
+
</li>
|
812
|
+
|
813
|
+
<li>
|
814
|
+
<span class="name">:read_capacity</span>
|
815
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
816
|
+
<span class="default">
|
817
|
+
|
818
|
+
</span>
|
819
|
+
— <div class='inline'><p>set the read capacity for the table; does not work on existing tables</p>
|
820
|
+
</div>
|
821
|
+
</li>
|
822
|
+
|
823
|
+
<li>
|
824
|
+
<span class="name">:write_capacity</span>
|
825
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
826
|
+
<span class="default">
|
827
|
+
|
828
|
+
</span>
|
829
|
+
— <div class='inline'><p>set the write capacity for the table; does not work on existing tables</p>
|
830
|
+
</div>
|
831
|
+
</li>
|
832
|
+
|
833
|
+
</ul>
|
834
|
+
|
835
|
+
|
836
|
+
<h3>Since:</h3>
|
837
|
+
<ul class="since">
|
838
|
+
|
839
|
+
<li>
|
840
|
+
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
<div class='inline'><p>0.4.0</p>
|
846
|
+
</div>
|
847
|
+
|
848
|
+
</li>
|
849
|
+
|
850
|
+
</ul>
|
851
|
+
|
852
|
+
</div><table class="source_code">
|
853
|
+
<tr>
|
854
|
+
<td>
|
855
|
+
<pre class="lines">
|
856
|
+
|
857
|
+
|
858
|
+
28
|
859
|
+
29
|
860
|
+
30</pre>
|
861
|
+
</td>
|
862
|
+
<td>
|
863
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 28</span>
|
864
|
+
|
865
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_table'>table</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
866
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
867
|
+
<span class='kw'>end</span></pre>
|
868
|
+
</td>
|
869
|
+
</tr>
|
870
|
+
</table>
|
871
|
+
</div>
|
872
|
+
|
873
|
+
<div class="method_details ">
|
874
|
+
<p class="signature " id="write_capacity-instance_method">
|
875
|
+
|
876
|
+
- (<tt>Object</tt>) <strong>write_capacity</strong>
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
</p><div class="docstring">
|
881
|
+
<div class="discussion">
|
882
|
+
<p>Returns the write_capacity for this table.</p>
|
883
|
+
|
884
|
+
|
885
|
+
</div>
|
886
|
+
</div>
|
887
|
+
<div class="tags">
|
888
|
+
|
889
|
+
<h3>Since:</h3>
|
890
|
+
<ul class="since">
|
891
|
+
|
892
|
+
<li>
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
<div class='inline'><p>0.4.0</p>
|
899
|
+
</div>
|
900
|
+
|
901
|
+
</li>
|
902
|
+
|
903
|
+
</ul>
|
904
|
+
|
905
|
+
</div><table class="source_code">
|
906
|
+
<tr>
|
907
|
+
<td>
|
908
|
+
<pre class="lines">
|
909
|
+
|
910
|
+
|
911
|
+
42
|
912
|
+
43
|
913
|
+
44</pre>
|
914
|
+
</td>
|
915
|
+
<td>
|
916
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 42</span>
|
917
|
+
|
918
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_write_capacity'>write_capacity</span>
|
919
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:write_capacity</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>Dynamoid</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_write_capacity'>write_capacity</span>
|
920
|
+
<span class='kw'>end</span></pre>
|
921
|
+
</td>
|
922
|
+
</tr>
|
923
|
+
</table>
|
568
924
|
</div>
|
569
925
|
|
570
926
|
</div>
|
@@ -572,7 +928,7 @@
|
|
572
928
|
</div>
|
573
929
|
|
574
930
|
<div id="footer">
|
575
|
-
Generated on
|
931
|
+
Generated on Thu Apr 26 01:26:25 2012 by
|
576
932
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
577
933
|
0.7.5 (ruby-1.9.3).
|
578
934
|
</div>
|