Module: Aws::Record::Attributes::ClassMethods
- Included in:
- Aws::Record
- Defined in:
- lib/aws-record/record/attributes.rb
Instance Method Summary collapse
-
#atomic_counter(name, opts = {}) ⇒ Object
Define an atomic counter attribute for your model.
-
#attr(name, marshaler, opts = {}) ⇒ Object
Define an attribute for your model, providing your own attribute type.
- #attributes ⇒ Object private
-
#boolean_attr(name, opts = {}) ⇒ Object
Define a boolean-type attribute for your model.
-
#date_attr(name, opts = {}) ⇒ Object
Define a date-type attribute for your model.
-
#datetime_attr(name, opts = {}) ⇒ Object
Define a datetime-type attribute for your model.
-
#epoch_time_attr(name, opts = {}) ⇒ Object
Define a time-type attribute for your model which persists as epoch-seconds.
-
#float_attr(name, opts = {}) ⇒ Object
Define a float-type attribute for your model.
-
#hash_key ⇒ Symbol?
The symbolic name of the table’s hash key.
-
#integer_attr(name, opts = {}) ⇒ Object
Define a integer-type attribute for your model.
- #keys ⇒ Object private
-
#list_attr(name, opts = {}) ⇒ Object
Define a list-type attribute for your model.
-
#map_attr(name, opts = {}) ⇒ Object
Define a map-type attribute for your model.
-
#numeric_set_attr(name, opts = {}) ⇒ Object
Define a numeric set attribute for your model.
-
#range_key ⇒ Symbol?
The symbloc name of the table’s range key, or nil if there is no range key.
-
#string_attr(name, opts = {}) ⇒ Object
Define a string-type attribute for your model.
-
#string_set_attr(name, opts = {}) ⇒ Object
Define a string set attribute for your model.
-
#time_attr(name, opts = {}) ⇒ Object
Define a time-type attribute for your model.
Instance Method Details
#atomic_counter(name, opts = {}) ⇒ Object
Define an atomic counter attribute for your model.
Atomic counter are an integer-type attribute that is incremented, unconditionally, without interfering with other write requests. The numeric value increments each time you call increment_<attr>!. If a specific numeric value are passed in the call, the attribute will increment by that value.
To use increment_<attr>! method, the following condition must be true:
-
None of the attributes have dirty changes.
-
If there is a value passed in, it must be an integer.
For more information, see Atomic counter in the Amazon DynamoDB Developer Guide.
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 448 449 450 451 452 453 454 |
# File 'lib/aws-record/record/attributes.rb', line 420 def atomic_counter(name, opts = {}) opts[:dynamodb_type] = "N" opts[:default_value] ||= 0 attr(name, Marshalers::IntegerMarshaler.new(opts), opts) define_method("increment_#{name}!") do |increment=1| if dirty? msg = "Attributes need to be saved before atomic counter can be incremented" raise Errors::RecordError, msg end unless increment.is_a?(Integer) msg = "expected an Integer value, got #{increment.class}" raise ArgumentError, msg end resp = dynamodb_client.update_item({ table_name: self.class.table_name, key: key_values, expression_attribute_values: { ":i" => increment }, expression_attribute_names: { "#n" => name }, update_expression: "SET #n = #n + :i", return_values: "UPDATED_NEW" }) assign_attributes(resp[:attributes]) @data.clean! @data.get_attribute(name) end end |
#attr(name, marshaler, opts = {}) ⇒ Object
Define an attribute for your model, providing your own attribute type.
90 91 92 93 94 |
# File 'lib/aws-record/record/attributes.rb', line 90 def attr(name, marshaler, opts = {}) @attributes.register_attribute(name, marshaler, opts) _define_attr_methods(name) _key_attributes(name, opts) end |
#attributes ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
467 468 469 |
# File 'lib/aws-record/record/attributes.rb', line 467 def attributes @attributes end |
#boolean_attr(name, opts = {}) ⇒ Object
Define a boolean-type attribute for your model.
133 134 135 136 |
# File 'lib/aws-record/record/attributes.rb', line 133 def boolean_attr(name, opts = {}) opts[:dynamodb_type] = "BOOL" attr(name, Marshalers::BooleanMarshaler.new(opts), opts) end |
#date_attr(name, opts = {}) ⇒ Object
Define a date-type attribute for your model.
196 197 198 199 |
# File 'lib/aws-record/record/attributes.rb', line 196 def date_attr(name, opts = {}) opts[:dynamodb_type] = "S" attr(name, Marshalers::DateMarshaler.new(opts), opts) end |
#datetime_attr(name, opts = {}) ⇒ Object
Define a datetime-type attribute for your model.
217 218 219 220 |
# File 'lib/aws-record/record/attributes.rb', line 217 def datetime_attr(name, opts = {}) opts[:dynamodb_type] = "S" attr(name, Marshalers::DateTimeMarshaler.new(opts), opts) end |
#epoch_time_attr(name, opts = {}) ⇒ Object
Define a time-type attribute for your model which persists as
epoch-seconds.
260 261 262 263 |
# File 'lib/aws-record/record/attributes.rb', line 260 def epoch_time_attr(name, opts = {}) opts[:dynamodb_type] = "N" attr(name, Marshalers::EpochTimeMarshaler.new(opts), opts) end |
#float_attr(name, opts = {}) ⇒ Object
Define a float-type attribute for your model.
175 176 177 178 |
# File 'lib/aws-record/record/attributes.rb', line 175 def float_attr(name, opts = {}) opts[:dynamodb_type] = "N" attr(name, Marshalers::FloatMarshaler.new(opts), opts) end |
#hash_key ⇒ Symbol?
Returns The symbolic name of the table’s hash key.
457 458 459 |
# File 'lib/aws-record/record/attributes.rb', line 457 def hash_key @keys.hash_key end |
#integer_attr(name, opts = {}) ⇒ Object
Define a integer-type attribute for your model.
154 155 156 157 |
# File 'lib/aws-record/record/attributes.rb', line 154 def integer_attr(name, opts = {}) opts[:dynamodb_type] = "N" attr(name, Marshalers::IntegerMarshaler.new(opts), opts) end |
#keys ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
472 473 474 |
# File 'lib/aws-record/record/attributes.rb', line 472 def keys @keys.keys end |
#list_attr(name, opts = {}) ⇒ Object
Define a list-type attribute for your model.
Lists do not have to be homogeneous, but they do have to be types that the AWS SDK for Ruby V2’s DynamoDB client knows how to marshal and unmarshal. Those types are:
-
Hash
-
Array
-
String
-
Numeric
-
Boolean
-
IO
-
Set
-
nil
Also note that, since lists are heterogeneous, you may lose some precision when marshaling and unmarshaling. For example, symbols will be stringified, but there is no way to return those strings to symbols when the object is read back from DynamoDB.
295 296 297 298 |
# File 'lib/aws-record/record/attributes.rb', line 295 def list_attr(name, opts = {}) opts[:dynamodb_type] = "L" attr(name, Marshalers::ListMarshaler.new(opts), opts) end |
#map_attr(name, opts = {}) ⇒ Object
Define a map-type attribute for your model.
Maps do not have to be homogeneous, but they do have to use types that the AWS SDK for Ruby V2’s DynamoDB client knows how to marshal and unmarshal. Those types are:
-
Hash
-
Array
-
String
-
Numeric
-
Boolean
-
IO
-
Set
-
nil
Also note that, since maps are heterogeneous, you may lose some precision when marshaling and unmarshaling. For example, symbols will be stringified, but there is no way to return those strings to symbols when the object is read back from DynamoDB.
330 331 332 333 |
# File 'lib/aws-record/record/attributes.rb', line 330 def map_attr(name, opts = {}) opts[:dynamodb_type] = "M" attr(name, Marshalers::MapMarshaler.new(opts), opts) end |
#numeric_set_attr(name, opts = {}) ⇒ Object
Define a numeric set attribute for your model.
Numeric sets are homogeneous sets, containing only numbers. Note that empty sets cannot be persisted to DynamoDB. Empty sets are valid for aws-record items, but they will not be persisted as sets. nil values from your table, or a lack of value from your table, will be treated as an empty set for item instances. At persistence time, the marshaler will attempt to marshal any non-numerics within the set to be Numeric objects.
380 381 382 383 |
# File 'lib/aws-record/record/attributes.rb', line 380 def numeric_set_attr(name, opts = {}) opts[:dynamodb_type] = "NS" attr(name, Marshalers::NumericSetMarshaler.new(opts), opts) end |
#range_key ⇒ Symbol?
Returns The symbloc name of the table’s range key, or nil if there is no range key.
462 463 464 |
# File 'lib/aws-record/record/attributes.rb', line 462 def range_key @keys.range_key end |
#string_attr(name, opts = {}) ⇒ Object
Define a string-type attribute for your model.
112 113 114 115 |
# File 'lib/aws-record/record/attributes.rb', line 112 def string_attr(name, opts = {}) opts[:dynamodb_type] = "S" attr(name, Marshalers::StringMarshaler.new(opts), opts) end |
#string_set_attr(name, opts = {}) ⇒ Object
Define a string set attribute for your model.
String sets are homogeneous sets, containing only strings. Note that empty sets cannot be persisted to DynamoDB. Empty sets are valid for aws-record items, but they will not be persisted as sets. nil values from your table, or a lack of value from your table, will be treated as an empty set for item instances. At persistence time, the marshaler will attempt to marshal any non-strings within the set to be String objects.
355 356 357 358 |
# File 'lib/aws-record/record/attributes.rb', line 355 def string_set_attr(name, opts = {}) opts[:dynamodb_type] = "SS" attr(name, Marshalers::StringSetMarshaler.new(opts), opts) end |
#time_attr(name, opts = {}) ⇒ Object
Define a time-type attribute for your model.
238 239 240 241 |
# File 'lib/aws-record/record/attributes.rb', line 238 def time_attr(name, opts = {}) opts[:dynamodb_type] = "S" attr(name, Marshalers::TimeMarshaler.new(opts), opts) end |