dynamoid-moda 0.7.1
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 +15 -0
- data/.document +5 -0
- data/.rspec +1 -0
- data/.travis.yml +7 -0
- data/Gemfile +24 -0
- data/Gemfile.lock +118 -0
- data/Gemfile_activemodel4 +24 -0
- data/Gemfile_activemodel4.lock +88 -0
- data/LICENSE.txt +20 -0
- data/README.markdown +360 -0
- data/Rakefile +93 -0
- data/VERSION +1 -0
- data/doc/.nojekyll +0 -0
- data/doc/Dynamoid.html +328 -0
- data/doc/Dynamoid/Adapter.html +1872 -0
- data/doc/Dynamoid/Adapter/AwsSdk.html +2101 -0
- data/doc/Dynamoid/Adapter/Local.html +1574 -0
- data/doc/Dynamoid/Associations.html +138 -0
- data/doc/Dynamoid/Associations/Association.html +847 -0
- data/doc/Dynamoid/Associations/BelongsTo.html +161 -0
- data/doc/Dynamoid/Associations/ClassMethods.html +766 -0
- data/doc/Dynamoid/Associations/HasAndBelongsToMany.html +167 -0
- data/doc/Dynamoid/Associations/HasMany.html +167 -0
- data/doc/Dynamoid/Associations/HasOne.html +161 -0
- data/doc/Dynamoid/Associations/ManyAssociation.html +1684 -0
- data/doc/Dynamoid/Associations/SingleAssociation.html +627 -0
- data/doc/Dynamoid/Components.html +242 -0
- data/doc/Dynamoid/Config.html +412 -0
- data/doc/Dynamoid/Config/Options.html +638 -0
- data/doc/Dynamoid/Criteria.html +138 -0
- data/doc/Dynamoid/Criteria/Chain.html +1471 -0
- data/doc/Dynamoid/Criteria/ClassMethods.html +105 -0
- data/doc/Dynamoid/Dirty.html +424 -0
- data/doc/Dynamoid/Dirty/ClassMethods.html +174 -0
- data/doc/Dynamoid/Document.html +1033 -0
- data/doc/Dynamoid/Document/ClassMethods.html +1116 -0
- data/doc/Dynamoid/Errors.html +125 -0
- data/doc/Dynamoid/Errors/ConditionalCheckFailedException.html +141 -0
- data/doc/Dynamoid/Errors/DocumentNotValid.html +221 -0
- data/doc/Dynamoid/Errors/Error.html +137 -0
- data/doc/Dynamoid/Errors/InvalidField.html +141 -0
- data/doc/Dynamoid/Errors/InvalidQuery.html +131 -0
- data/doc/Dynamoid/Errors/MissingRangeKey.html +141 -0
- data/doc/Dynamoid/Fields.html +686 -0
- data/doc/Dynamoid/Fields/ClassMethods.html +438 -0
- data/doc/Dynamoid/Finders.html +135 -0
- data/doc/Dynamoid/Finders/ClassMethods.html +943 -0
- data/doc/Dynamoid/IdentityMap.html +492 -0
- data/doc/Dynamoid/IdentityMap/ClassMethods.html +534 -0
- data/doc/Dynamoid/Indexes.html +321 -0
- data/doc/Dynamoid/Indexes/ClassMethods.html +369 -0
- data/doc/Dynamoid/Indexes/Index.html +1142 -0
- data/doc/Dynamoid/Middleware.html +115 -0
- data/doc/Dynamoid/Middleware/IdentityMap.html +264 -0
- data/doc/Dynamoid/Persistence.html +892 -0
- data/doc/Dynamoid/Persistence/ClassMethods.html +836 -0
- data/doc/Dynamoid/Validations.html +415 -0
- data/doc/_index.html +506 -0
- data/doc/class_list.html +53 -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.LICENSE.html +73 -0
- data/doc/file.README.html +416 -0
- data/doc/file_list.html +58 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +416 -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 +1144 -0
- data/doc/top-level-namespace.html +112 -0
- data/dynamoid-moda.gemspec +210 -0
- data/dynamoid.gemspec +208 -0
- data/lib/dynamoid.rb +46 -0
- data/lib/dynamoid/adapter.rb +267 -0
- data/lib/dynamoid/adapter/aws_sdk.rb +309 -0
- data/lib/dynamoid/associations.rb +106 -0
- data/lib/dynamoid/associations/association.rb +105 -0
- data/lib/dynamoid/associations/belongs_to.rb +44 -0
- data/lib/dynamoid/associations/has_and_belongs_to_many.rb +40 -0
- data/lib/dynamoid/associations/has_many.rb +39 -0
- data/lib/dynamoid/associations/has_one.rb +39 -0
- data/lib/dynamoid/associations/many_association.rb +191 -0
- data/lib/dynamoid/associations/single_association.rb +69 -0
- data/lib/dynamoid/components.rb +37 -0
- data/lib/dynamoid/config.rb +57 -0
- data/lib/dynamoid/config/options.rb +78 -0
- data/lib/dynamoid/criteria.rb +29 -0
- data/lib/dynamoid/criteria/chain.rb +326 -0
- data/lib/dynamoid/dirty.rb +47 -0
- data/lib/dynamoid/document.rb +199 -0
- data/lib/dynamoid/errors.rb +28 -0
- data/lib/dynamoid/fields.rb +138 -0
- data/lib/dynamoid/finders.rb +133 -0
- data/lib/dynamoid/identity_map.rb +96 -0
- data/lib/dynamoid/indexes.rb +69 -0
- data/lib/dynamoid/indexes/index.rb +103 -0
- data/lib/dynamoid/middleware/identity_map.rb +16 -0
- data/lib/dynamoid/persistence.rb +292 -0
- data/lib/dynamoid/validations.rb +36 -0
- data/spec/app/models/address.rb +13 -0
- data/spec/app/models/camel_case.rb +34 -0
- data/spec/app/models/car.rb +6 -0
- data/spec/app/models/magazine.rb +11 -0
- data/spec/app/models/message.rb +9 -0
- data/spec/app/models/nuclear_submarine.rb +5 -0
- data/spec/app/models/sponsor.rb +8 -0
- data/spec/app/models/subscription.rb +12 -0
- data/spec/app/models/tweet.rb +12 -0
- data/spec/app/models/user.rb +26 -0
- data/spec/app/models/vehicle.rb +7 -0
- data/spec/dynamoid/adapter/aws_sdk_spec.rb +376 -0
- data/spec/dynamoid/adapter_spec.rb +155 -0
- data/spec/dynamoid/associations/association_spec.rb +194 -0
- data/spec/dynamoid/associations/belongs_to_spec.rb +71 -0
- data/spec/dynamoid/associations/has_and_belongs_to_many_spec.rb +47 -0
- data/spec/dynamoid/associations/has_many_spec.rb +42 -0
- data/spec/dynamoid/associations/has_one_spec.rb +45 -0
- data/spec/dynamoid/associations_spec.rb +16 -0
- data/spec/dynamoid/config_spec.rb +27 -0
- data/spec/dynamoid/criteria/chain_spec.rb +210 -0
- data/spec/dynamoid/criteria_spec.rb +75 -0
- data/spec/dynamoid/dirty_spec.rb +57 -0
- data/spec/dynamoid/document_spec.rb +180 -0
- data/spec/dynamoid/fields_spec.rb +156 -0
- data/spec/dynamoid/finders_spec.rb +147 -0
- data/spec/dynamoid/identity_map_spec.rb +45 -0
- data/spec/dynamoid/indexes/index_spec.rb +104 -0
- data/spec/dynamoid/indexes_spec.rb +25 -0
- data/spec/dynamoid/persistence_spec.rb +301 -0
- data/spec/dynamoid/validations_spec.rb +36 -0
- data/spec/dynamoid_spec.rb +14 -0
- data/spec/spec_helper.rb +55 -0
- data/spec/support/with_partitioning.rb +15 -0
- metadata +363 -0
|
@@ -0,0 +1,174 @@
|
|
|
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
|
+
Module: Dynamoid::Dirty::ClassMethods
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.6.1
|
|
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 (C)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../Dynamoid.html" title="Dynamoid (module)">Dynamoid</a></span></span> » <span class='title'><span class='object_link'><a href="../Dirty.html" title="Dynamoid::Dirty (module)">Dirty</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">ClassMethods</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>Module: Dynamoid::Dirty::ClassMethods
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<dt class="r1 last">Defined in:</dt>
|
|
82
|
+
<dd class="r1 last">lib/dynamoid/dirty.rb</dd>
|
|
83
|
+
|
|
84
|
+
</dl>
|
|
85
|
+
<div class="clear"></div>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<h2>
|
|
96
|
+
Instance Method Summary
|
|
97
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
98
|
+
</h2>
|
|
99
|
+
|
|
100
|
+
<ul class="summary">
|
|
101
|
+
|
|
102
|
+
<li class="public ">
|
|
103
|
+
<span class="summary_signature">
|
|
104
|
+
|
|
105
|
+
<a href="#from_database-instance_method" title="#from_database (instance method)">- (Object) <strong>from_database</strong> </a>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</span>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
120
|
+
|
|
121
|
+
</li>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</ul>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<div id="instance_method_details" class="method_details_list">
|
|
130
|
+
<h2>Instance Method Details</h2>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<div class="method_details first">
|
|
134
|
+
<h3 class="signature first" id="from_database-instance_method">
|
|
135
|
+
|
|
136
|
+
- (<tt>Object</tt>) <strong>from_database</strong>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</h3><table class="source_code">
|
|
143
|
+
<tr>
|
|
144
|
+
<td>
|
|
145
|
+
<pre class="lines">
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
7
|
|
149
|
+
8
|
|
150
|
+
9</pre>
|
|
151
|
+
</td>
|
|
152
|
+
<td>
|
|
153
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/dirty.rb', line 7</span>
|
|
154
|
+
|
|
155
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_from_database'>from_database</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
|
156
|
+
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='id identifier rubyid_d'>d</span><span class='period'>.</span><span class='id identifier rubyid_changed_attributes'>changed_attributes</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span> <span class='rbrace'>}</span>
|
|
157
|
+
<span class='kw'>end</span></pre>
|
|
158
|
+
</td>
|
|
159
|
+
</tr>
|
|
160
|
+
</table>
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
</div>
|
|
166
|
+
|
|
167
|
+
<div id="footer">
|
|
168
|
+
Generated on Thu Jun 27 21:59:09 2013 by
|
|
169
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
170
|
+
0.8.6.1 (ruby-1.9.3).
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
</body>
|
|
174
|
+
</html>
|
|
@@ -0,0 +1,1033 @@
|
|
|
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
|
+
Module: Dynamoid::Document
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.6.1
|
|
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 (D)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../Dynamoid.html" title="Dynamoid (module)">Dynamoid</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Document</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>Module: Dynamoid::Document
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<dt class="r1">Extended by:</dt>
|
|
77
|
+
<dd class="r1">ActiveSupport::Concern</dd>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<dt class="r2">Includes:</dt>
|
|
83
|
+
<dd class="r2"><span class='object_link'><a href="Components.html" title="Dynamoid::Components (module)">Components</a></span></dd>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r1 last">Defined in:</dt>
|
|
90
|
+
<dd class="r1 last">lib/dynamoid/document.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>This is the base module for all domain objects that need to be persisted to
|
|
98
|
+
the database as documents.</p>
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
</div>
|
|
103
|
+
<div class="tags">
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
</div><h2>Defined Under Namespace</h2>
|
|
107
|
+
<p class="children">
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Document/ClassMethods.html" title="Dynamoid::Document::ClassMethods (module)">ClassMethods</a></span>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<h2>Instance Attribute Summary</h2>
|
|
123
|
+
|
|
124
|
+
<h3 class="inherited">Attributes included from <span class='object_link'><a href="Persistence.html" title="Dynamoid::Persistence (module)">Persistence</a></span></h3>
|
|
125
|
+
<p class="inherited"><span class='object_link'><a href="Persistence.html#new_record-instance_method" title="Dynamoid::Persistence#new_record (method)">#new_record</a></span></p>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h3 class="inherited">Attributes included from <span class='object_link'><a href="Fields.html" title="Dynamoid::Fields (module)">Fields</a></span></h3>
|
|
130
|
+
<p class="inherited"><span class='object_link'><a href="Fields.html#attributes-instance_method" title="Dynamoid::Fields#attributes (method)">#attributes</a></span></p>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h2>
|
|
135
|
+
Instance Method Summary
|
|
136
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
137
|
+
</h2>
|
|
138
|
+
|
|
139
|
+
<ul class="summary">
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#%3D%3D-instance_method" title="#== (instance method)">- (Object) <strong>==</strong>(other) </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'><p>An object is equal to another object if their ids are equal.</p>
|
|
159
|
+
</div></span>
|
|
160
|
+
|
|
161
|
+
</li>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<li class="public ">
|
|
165
|
+
<span class="summary_signature">
|
|
166
|
+
|
|
167
|
+
<a href="#eql%3F-instance_method" title="#eql? (instance method)">- (Boolean) <strong>eql?</strong>(other) </a>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</span>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
182
|
+
|
|
183
|
+
</li>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<li class="public ">
|
|
187
|
+
<span class="summary_signature">
|
|
188
|
+
|
|
189
|
+
<a href="#hash-instance_method" title="#hash (instance method)">- (Object) <strong>hash</strong> </a>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
204
|
+
|
|
205
|
+
</li>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<li class="public ">
|
|
209
|
+
<span class="summary_signature">
|
|
210
|
+
|
|
211
|
+
<a href="#hash_key-instance_method" title="#hash_key (instance method)">- (Object) <strong>hash_key</strong> </a>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<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>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#hash_key%3D-instance_method" title="#hash_key= (instance method)">- (Object) <strong>hash_key=</strong>(value) </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<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>
|
|
249
|
+
</div></span>
|
|
250
|
+
|
|
251
|
+
</li>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<li class="public ">
|
|
255
|
+
<span class="summary_signature">
|
|
256
|
+
|
|
257
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Dynamoid::Document) <strong>initialize</strong>(attrs = {}) </a>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</span>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<span class="summary_desc"><div class='inline'><p>Initialize a new object.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#load-instance_method" title="#load (instance method)">- (Object) <strong>load</strong>(attrs) </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<li class="public ">
|
|
300
|
+
<span class="summary_signature">
|
|
301
|
+
|
|
302
|
+
<a href="#range_value-instance_method" title="#range_value (instance method)">- (Object) <strong>range_value</strong> </a>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
317
|
+
|
|
318
|
+
</li>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<li class="public ">
|
|
322
|
+
<span class="summary_signature">
|
|
323
|
+
|
|
324
|
+
<a href="#range_value%3D-instance_method" title="#range_value= (instance method)">- (Object) <strong>range_value=</strong>(value) </a>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
</span>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
339
|
+
|
|
340
|
+
</li>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<li class="public ">
|
|
344
|
+
<span class="summary_signature">
|
|
345
|
+
|
|
346
|
+
<a href="#reload-instance_method" title="#reload (instance method)">- (Dynamoid::Document) <strong>reload</strong> </a>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</span>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<span class="summary_desc"><div class='inline'><p>Reload an object from the database -- if you suspect the object has changed in the datastore and you need those
|
|
361
|
+
changes to be reflected immediately, you would call this method.</p>
|
|
362
|
+
</div></span>
|
|
363
|
+
|
|
364
|
+
</li>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</ul>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Dirty.html" title="Dynamoid::Dirty (module)">Dirty</a></span></h3>
|
|
388
|
+
<p class="inherited"><span class='object_link'><a href="Dirty.html#clear_changes-instance_method" title="Dynamoid::Dirty#clear_changes (method)">#clear_changes</a></span>, <span class='object_link'><a href="Dirty.html#save-instance_method" title="Dynamoid::Dirty#save (method)">#save</a></span>, <span class='object_link'><a href="Dirty.html#update%21-instance_method" title="Dynamoid::Dirty#update! (method)">#update!</a></span>, <span class='object_link'><a href="Dirty.html#write_attribute-instance_method" title="Dynamoid::Dirty#write_attribute (method)">#write_attribute</a></span></p>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="IdentityMap.html" title="Dynamoid::IdentityMap (module)">IdentityMap</a></span></h3>
|
|
401
|
+
<p class="inherited"><span class='object_link'><a href="IdentityMap.html#clear-class_method" title="Dynamoid::IdentityMap.clear (method)">clear</a></span>, <span class='object_link'><a href="IdentityMap.html#delete-instance_method" title="Dynamoid::IdentityMap#delete (method)">#delete</a></span>, <span class='object_link'><a href="IdentityMap.html#identity_map-instance_method" title="Dynamoid::IdentityMap#identity_map (method)">#identity_map</a></span>, <span class='object_link'><a href="IdentityMap.html#identity_map_key-instance_method" title="Dynamoid::IdentityMap#identity_map_key (method)">#identity_map_key</a></span>, <span class='object_link'><a href="IdentityMap.html#models-class_method" title="Dynamoid::IdentityMap.models (method)">models</a></span>, <span class='object_link'><a href="IdentityMap.html#save-instance_method" title="Dynamoid::IdentityMap#save (method)">#save</a></span></p>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Validations.html" title="Dynamoid::Validations (module)">Validations</a></span></h3>
|
|
413
|
+
<p class="inherited"><span class='object_link'><a href="Validations.html#save-instance_method" title="Dynamoid::Validations#save (method)">#save</a></span>, <span class='object_link'><a href="Validations.html#save%21-instance_method" title="Dynamoid::Validations#save! (method)">#save!</a></span>, <span class='object_link'><a href="Validations.html#valid%3F-instance_method" title="Dynamoid::Validations#valid? (method)">#valid?</a></span></p>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Persistence.html" title="Dynamoid::Persistence (module)">Persistence</a></span></h3>
|
|
448
|
+
<p class="inherited"><span class='object_link'><a href="Persistence.html#delete-instance_method" title="Dynamoid::Persistence#delete (method)">#delete</a></span>, <span class='object_link'><a href="Persistence.html#destroy-instance_method" title="Dynamoid::Persistence#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Persistence.html#dump-instance_method" title="Dynamoid::Persistence#dump (method)">#dump</a></span>, <span class='object_link'><a href="Persistence.html#persisted%3F-instance_method" title="Dynamoid::Persistence#persisted? (method)">#persisted?</a></span>, <span class='object_link'><a href="Persistence.html#save-instance_method" title="Dynamoid::Persistence#save (method)">#save</a></span>, <span class='object_link'><a href="Persistence.html#touch-instance_method" title="Dynamoid::Persistence#touch (method)">#touch</a></span>, <span class='object_link'><a href="Persistence.html#update-instance_method" title="Dynamoid::Persistence#update (method)">#update</a></span>, <span class='object_link'><a href="Persistence.html#update%21-instance_method" title="Dynamoid::Persistence#update! (method)">#update!</a></span></p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Indexes.html" title="Dynamoid::Indexes (module)">Indexes</a></span></h3>
|
|
460
|
+
<p class="inherited"><span class='object_link'><a href="Indexes.html#delete_indexes-instance_method" title="Dynamoid::Indexes#delete_indexes (method)">#delete_indexes</a></span>, <span class='object_link'><a href="Indexes.html#save_indexes-instance_method" title="Dynamoid::Indexes#save_indexes (method)">#save_indexes</a></span></p>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Fields.html" title="Dynamoid::Fields (module)">Fields</a></span></h3>
|
|
472
|
+
<p class="inherited"><span class='object_link'><a href="Fields.html#read_attribute-instance_method" title="Dynamoid::Fields#read_attribute (method)">#read_attribute</a></span>, <span class='object_link'><a href="Fields.html#update_attribute-instance_method" title="Dynamoid::Fields#update_attribute (method)">#update_attribute</a></span>, <span class='object_link'><a href="Fields.html#update_attributes-instance_method" title="Dynamoid::Fields#update_attributes (method)">#update_attributes</a></span>, <span class='object_link'><a href="Fields.html#write_attribute-instance_method" title="Dynamoid::Fields#write_attribute (method)">#write_attribute</a></span></p>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<div id="instance_method_details" class="method_details_list">
|
|
484
|
+
<h2>Instance Method Details</h2>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<div class="method_details first">
|
|
488
|
+
<h3 class="signature first" id="==-instance_method">
|
|
489
|
+
|
|
490
|
+
- (<tt>Object</tt>) <strong>==</strong>(other)
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
</h3><div class="docstring">
|
|
497
|
+
<div class="discussion">
|
|
498
|
+
<p>An object is equal to another object if their ids are equal.</p>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
</div>
|
|
502
|
+
</div>
|
|
503
|
+
<div class="tags">
|
|
504
|
+
|
|
505
|
+
<p class="tag_title">Since:</p>
|
|
506
|
+
<ul class="since">
|
|
507
|
+
|
|
508
|
+
<li>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<div class='inline'><p>0.2.0</p>
|
|
515
|
+
</div>
|
|
516
|
+
|
|
517
|
+
</li>
|
|
518
|
+
|
|
519
|
+
</ul>
|
|
520
|
+
|
|
521
|
+
</div><table class="source_code">
|
|
522
|
+
<tr>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="lines">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
139
|
|
528
|
+
140
|
|
529
|
+
141
|
|
530
|
+
142
|
|
531
|
+
143
|
|
532
|
+
144
|
|
533
|
+
145
|
|
534
|
+
146</pre>
|
|
535
|
+
</td>
|
|
536
|
+
<td>
|
|
537
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 139</span>
|
|
538
|
+
|
|
539
|
+
<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>
|
|
540
|
+
<span class='kw'>if</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_identity_map_on?'>identity_map_on?</span>
|
|
541
|
+
<span class='kw'>super</span>
|
|
542
|
+
<span class='kw'>else</span>
|
|
543
|
+
<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>
|
|
544
|
+
<span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Dynamoid</span><span class='op'>::</span><span class='const'>Document</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hash_key'>hash_key</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_range_value'>range_value</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_range_value'>range_value</span>
|
|
545
|
+
<span class='kw'>end</span>
|
|
546
|
+
<span class='kw'>end</span></pre>
|
|
547
|
+
</td>
|
|
548
|
+
</tr>
|
|
549
|
+
</table>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
<div class="method_details ">
|
|
553
|
+
<h3 class="signature " id="eql?-instance_method">
|
|
554
|
+
|
|
555
|
+
- (<tt>Boolean</tt>) <strong>eql?</strong>(other)
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</h3><div class="docstring">
|
|
562
|
+
<div class="discussion">
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
</div>
|
|
567
|
+
<div class="tags">
|
|
568
|
+
|
|
569
|
+
<p class="tag_title">Returns:</p>
|
|
570
|
+
<ul class="return">
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</li>
|
|
580
|
+
|
|
581
|
+
</ul>
|
|
582
|
+
|
|
583
|
+
</div><table class="source_code">
|
|
584
|
+
<tr>
|
|
585
|
+
<td>
|
|
586
|
+
<pre class="lines">
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
148
|
|
590
|
+
149
|
|
591
|
+
150</pre>
|
|
592
|
+
</td>
|
|
593
|
+
<td>
|
|
594
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 148</span>
|
|
595
|
+
|
|
596
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
|
597
|
+
<span class='kw'>self</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
|
|
598
|
+
<span class='kw'>end</span></pre>
|
|
599
|
+
</td>
|
|
600
|
+
</tr>
|
|
601
|
+
</table>
|
|
602
|
+
</div>
|
|
603
|
+
|
|
604
|
+
<div class="method_details ">
|
|
605
|
+
<h3 class="signature " id="hash-instance_method">
|
|
606
|
+
|
|
607
|
+
- (<tt>Object</tt>) <strong>hash</strong>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
</h3><table class="source_code">
|
|
614
|
+
<tr>
|
|
615
|
+
<td>
|
|
616
|
+
<pre class="lines">
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
152
|
|
620
|
+
153
|
|
621
|
+
154</pre>
|
|
622
|
+
</td>
|
|
623
|
+
<td>
|
|
624
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 152</span>
|
|
625
|
+
|
|
626
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash'>hash</span>
|
|
627
|
+
<span class='id identifier rubyid_hash_key'>hash_key</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span> <span class='op'>^</span> <span class='id identifier rubyid_range_value'>range_value</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span>
|
|
628
|
+
<span class='kw'>end</span></pre>
|
|
629
|
+
</td>
|
|
630
|
+
</tr>
|
|
631
|
+
</table>
|
|
632
|
+
</div>
|
|
633
|
+
|
|
634
|
+
<div class="method_details ">
|
|
635
|
+
<h3 class="signature " id="hash_key-instance_method">
|
|
636
|
+
|
|
637
|
+
- (<tt>Object</tt>) <strong>hash_key</strong>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</h3><div class="docstring">
|
|
644
|
+
<div class="discussion">
|
|
645
|
+
<p>Return an object's hash key, regardless of what it might be called to the object.</p>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
</div>
|
|
649
|
+
</div>
|
|
650
|
+
<div class="tags">
|
|
651
|
+
|
|
652
|
+
<p class="tag_title">Since:</p>
|
|
653
|
+
<ul class="since">
|
|
654
|
+
|
|
655
|
+
<li>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<div class='inline'><p>0.4.0</p>
|
|
662
|
+
</div>
|
|
663
|
+
|
|
664
|
+
</li>
|
|
665
|
+
|
|
666
|
+
</ul>
|
|
667
|
+
|
|
668
|
+
</div><table class="source_code">
|
|
669
|
+
<tr>
|
|
670
|
+
<td>
|
|
671
|
+
<pre class="lines">
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
172
|
|
675
|
+
173
|
|
676
|
+
174</pre>
|
|
677
|
+
</td>
|
|
678
|
+
<td>
|
|
679
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 172</span>
|
|
680
|
+
|
|
681
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash_key'>hash_key</span>
|
|
682
|
+
<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>
|
|
683
|
+
<span class='kw'>end</span></pre>
|
|
684
|
+
</td>
|
|
685
|
+
</tr>
|
|
686
|
+
</table>
|
|
687
|
+
</div>
|
|
688
|
+
|
|
689
|
+
<div class="method_details ">
|
|
690
|
+
<h3 class="signature " id="hash_key=-instance_method">
|
|
691
|
+
|
|
692
|
+
- (<tt>Object</tt>) <strong>hash_key=</strong>(value)
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
</h3><div class="docstring">
|
|
699
|
+
<div class="discussion">
|
|
700
|
+
<p>Assign an object's hash key, regardless of what it might be called to the object.</p>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</div>
|
|
704
|
+
</div>
|
|
705
|
+
<div class="tags">
|
|
706
|
+
|
|
707
|
+
<p class="tag_title">Since:</p>
|
|
708
|
+
<ul class="since">
|
|
709
|
+
|
|
710
|
+
<li>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
<div class='inline'><p>0.4.0</p>
|
|
717
|
+
</div>
|
|
718
|
+
|
|
719
|
+
</li>
|
|
720
|
+
|
|
721
|
+
</ul>
|
|
722
|
+
|
|
723
|
+
</div><table class="source_code">
|
|
724
|
+
<tr>
|
|
725
|
+
<td>
|
|
726
|
+
<pre class="lines">
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
179
|
|
730
|
+
180
|
|
731
|
+
181</pre>
|
|
732
|
+
</td>
|
|
733
|
+
<td>
|
|
734
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 179</span>
|
|
735
|
+
|
|
736
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hash_key='>hash_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
737
|
+
<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='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
738
|
+
<span class='kw'>end</span></pre>
|
|
739
|
+
</td>
|
|
740
|
+
</tr>
|
|
741
|
+
</table>
|
|
742
|
+
</div>
|
|
743
|
+
|
|
744
|
+
<div class="method_details ">
|
|
745
|
+
<h3 class="signature " id="initialize-instance_method">
|
|
746
|
+
|
|
747
|
+
- (<tt><span class='object_link'><a href="" title="Dynamoid::Document (module)">Dynamoid::Document</a></span></tt>) <strong>initialize</strong>(attrs = {})
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
</h3><div class="docstring">
|
|
754
|
+
<div class="discussion">
|
|
755
|
+
<p>Initialize a new object.</p>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
</div>
|
|
759
|
+
</div>
|
|
760
|
+
<div class="tags">
|
|
761
|
+
<p class="tag_title">Parameters:</p>
|
|
762
|
+
<ul class="param">
|
|
763
|
+
|
|
764
|
+
<li>
|
|
765
|
+
|
|
766
|
+
<span class='name'>attrs</span>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
—
|
|
776
|
+
<div class='inline'><p>Attributes with which to create the object.</p>
|
|
777
|
+
</div>
|
|
778
|
+
|
|
779
|
+
</li>
|
|
780
|
+
|
|
781
|
+
</ul>
|
|
782
|
+
|
|
783
|
+
<p class="tag_title">Returns:</p>
|
|
784
|
+
<ul class="return">
|
|
785
|
+
|
|
786
|
+
<li>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Dynamoid::Document (module)">Dynamoid::Document</a></span></tt>)</span>
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
—
|
|
794
|
+
<div class='inline'><p>the new document</p>
|
|
795
|
+
</div>
|
|
796
|
+
|
|
797
|
+
</li>
|
|
798
|
+
|
|
799
|
+
</ul>
|
|
800
|
+
<p class="tag_title">Since:</p>
|
|
801
|
+
<ul class="since">
|
|
802
|
+
|
|
803
|
+
<li>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<div class='inline'><p>0.2.0</p>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
</ul>
|
|
815
|
+
|
|
816
|
+
</div><table class="source_code">
|
|
817
|
+
<tr>
|
|
818
|
+
<td>
|
|
819
|
+
<pre class="lines">
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
122
|
|
823
|
+
123
|
|
824
|
+
124
|
|
825
|
+
125
|
|
826
|
+
126
|
|
827
|
+
127
|
|
828
|
+
128
|
|
829
|
+
129
|
|
830
|
+
130</pre>
|
|
831
|
+
</td>
|
|
832
|
+
<td>
|
|
833
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 122</span>
|
|
834
|
+
|
|
835
|
+
<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>
|
|
836
|
+
<span class='id identifier rubyid_run_callbacks'>run_callbacks</span> <span class='symbol'>:initialize</span> <span class='kw'>do</span>
|
|
837
|
+
<span class='ivar'>@new_record</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
838
|
+
<span class='ivar'>@attributes</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
839
|
+
<span class='ivar'>@associations</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
840
|
+
|
|
841
|
+
<span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
|
|
842
|
+
<span class='kw'>end</span>
|
|
843
|
+
<span class='kw'>end</span></pre>
|
|
844
|
+
</td>
|
|
845
|
+
</tr>
|
|
846
|
+
</table>
|
|
847
|
+
</div>
|
|
848
|
+
|
|
849
|
+
<div class="method_details ">
|
|
850
|
+
<h3 class="signature " id="load-instance_method">
|
|
851
|
+
|
|
852
|
+
- (<tt>Object</tt>) <strong>load</strong>(attrs)
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
</h3><table class="source_code">
|
|
859
|
+
<tr>
|
|
860
|
+
<td>
|
|
861
|
+
<pre class="lines">
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
132
|
|
865
|
+
133
|
|
866
|
+
134</pre>
|
|
867
|
+
</td>
|
|
868
|
+
<td>
|
|
869
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 132</span>
|
|
870
|
+
|
|
871
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
|
|
872
|
+
<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>
|
|
873
|
+
<span class='kw'>end</span></pre>
|
|
874
|
+
</td>
|
|
875
|
+
</tr>
|
|
876
|
+
</table>
|
|
877
|
+
</div>
|
|
878
|
+
|
|
879
|
+
<div class="method_details ">
|
|
880
|
+
<h3 class="signature " id="range_value-instance_method">
|
|
881
|
+
|
|
882
|
+
- (<tt>Object</tt>) <strong>range_value</strong>
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
</h3><table class="source_code">
|
|
889
|
+
<tr>
|
|
890
|
+
<td>
|
|
891
|
+
<pre class="lines">
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
183
|
|
895
|
+
184
|
|
896
|
+
185
|
|
897
|
+
186
|
|
898
|
+
187</pre>
|
|
899
|
+
</td>
|
|
900
|
+
<td>
|
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 183</span>
|
|
902
|
+
|
|
903
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_range_value'>range_value</span>
|
|
904
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_range_key'>range_key</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_range_key'>range_key</span>
|
|
905
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_range_key'>range_key</span><span class='rparen'>)</span>
|
|
906
|
+
<span class='kw'>end</span>
|
|
907
|
+
<span class='kw'>end</span></pre>
|
|
908
|
+
</td>
|
|
909
|
+
</tr>
|
|
910
|
+
</table>
|
|
911
|
+
</div>
|
|
912
|
+
|
|
913
|
+
<div class="method_details ">
|
|
914
|
+
<h3 class="signature " id="range_value=-instance_method">
|
|
915
|
+
|
|
916
|
+
- (<tt>Object</tt>) <strong>range_value=</strong>(value)
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
</h3><table class="source_code">
|
|
923
|
+
<tr>
|
|
924
|
+
<td>
|
|
925
|
+
<pre class="lines">
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
189
|
|
929
|
+
190
|
|
930
|
+
191</pre>
|
|
931
|
+
</td>
|
|
932
|
+
<td>
|
|
933
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 189</span>
|
|
934
|
+
|
|
935
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_range_value='>range_value=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
936
|
+
<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_range_key'>range_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='rparen'>)</span>
|
|
937
|
+
<span class='kw'>end</span></pre>
|
|
938
|
+
</td>
|
|
939
|
+
</tr>
|
|
940
|
+
</table>
|
|
941
|
+
</div>
|
|
942
|
+
|
|
943
|
+
<div class="method_details ">
|
|
944
|
+
<h3 class="signature " id="reload-instance_method">
|
|
945
|
+
|
|
946
|
+
- (<tt><span class='object_link'><a href="" title="Dynamoid::Document (module)">Dynamoid::Document</a></span></tt>) <strong>reload</strong>
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
</h3><div class="docstring">
|
|
953
|
+
<div class="discussion">
|
|
954
|
+
<p>Reload an object from the database -- if you suspect the object has changed in the datastore and you need those
|
|
955
|
+
changes to be reflected immediately, you would call this method. This is a consistent read.</p>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
</div>
|
|
959
|
+
</div>
|
|
960
|
+
<div class="tags">
|
|
961
|
+
|
|
962
|
+
<p class="tag_title">Returns:</p>
|
|
963
|
+
<ul class="return">
|
|
964
|
+
|
|
965
|
+
<li>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Dynamoid::Document (module)">Dynamoid::Document</a></span></tt>)</span>
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
—
|
|
973
|
+
<div class='inline'><p>the document this method was called on</p>
|
|
974
|
+
</div>
|
|
975
|
+
|
|
976
|
+
</li>
|
|
977
|
+
|
|
978
|
+
</ul>
|
|
979
|
+
<p class="tag_title">Since:</p>
|
|
980
|
+
<ul class="since">
|
|
981
|
+
|
|
982
|
+
<li>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
<div class='inline'><p>0.2.0</p>
|
|
989
|
+
</div>
|
|
990
|
+
|
|
991
|
+
</li>
|
|
992
|
+
|
|
993
|
+
</ul>
|
|
994
|
+
|
|
995
|
+
</div><table class="source_code">
|
|
996
|
+
<tr>
|
|
997
|
+
<td>
|
|
998
|
+
<pre class="lines">
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
162
|
|
1002
|
+
163
|
|
1003
|
+
164
|
|
1004
|
+
165
|
|
1005
|
+
166
|
|
1006
|
+
167</pre>
|
|
1007
|
+
</td>
|
|
1008
|
+
<td>
|
|
1009
|
+
<pre class="code"><span class="info file"># File 'lib/dynamoid/document.rb', line 162</span>
|
|
1010
|
+
|
|
1011
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reload'>reload</span>
|
|
1012
|
+
<span class='id identifier rubyid_range_key_value'>range_key_value</span> <span class='op'>=</span> <span class='id identifier rubyid_range_value'>range_value</span> <span class='op'>?</span> <span class='id identifier rubyid_dumped_range_value'>dumped_range_value</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
|
1013
|
+
<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='id identifier rubyid_hash_key'>hash_key</span><span class='comma'>,</span> <span class='symbol'>:range_key</span> <span class='op'>=></span> <span class='id identifier rubyid_range_key_value'>range_key_value</span><span class='comma'>,</span> <span class='symbol'>:consistent_read</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span>
|
|
1014
|
+
<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>
|
|
1015
|
+
<span class='kw'>self</span>
|
|
1016
|
+
<span class='kw'>end</span></pre>
|
|
1017
|
+
</td>
|
|
1018
|
+
</tr>
|
|
1019
|
+
</table>
|
|
1020
|
+
</div>
|
|
1021
|
+
|
|
1022
|
+
</div>
|
|
1023
|
+
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
<div id="footer">
|
|
1027
|
+
Generated on Thu Jun 27 21:59:11 2013 by
|
|
1028
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1029
|
+
0.8.6.1 (ruby-1.9.3).
|
|
1030
|
+
</div>
|
|
1031
|
+
|
|
1032
|
+
</body>
|
|
1033
|
+
</html>
|