Module: Dynamoid::Fields

Extended by:
ActiveSupport::Concern
Included in:
Components
Defined in:
lib/dynamoid/fields.rb

Overview

All fields on a Dynamoid::Document must be explicitly defined – if you have fields in the database that are not specified with field, then they will be ignored.

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

PERMITTED_KEY_TYPES = 
[
  :number,
  :integer,
  :string,
  :datetime
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#attributes ⇒ Object Also known as: raw_attributes

You can access the attributes of an object directly on its attributes method, which is by default an empty hash.



89
90
91
 
# File 'lib/dynamoid/fields.rb', line 89

def attributes
  @attributes
end

Instance Method Details

#read_attribute(name) ⇒ Object Also known as: []

Read an attribute from an object.

Parameters:

  • name (Symbol) —

    the name of the field

Since:

  • 0.2.0



116
117
118
 
# File 'lib/dynamoid/fields.rb', line 116

def read_attribute(name)
  attributes[name.to_sym]
end

#update_attribute(attribute, value) ⇒ Object

Update a single attribute, saving the object afterwards.

Parameters:

  • attribute (Symbol) —

    the attribute to update

  • value (Object) —

    the value to assign it

Since:

  • 0.2.0



137
138
139
140
 
# File 'lib/dynamoid/fields.rb', line 137

def update_attribute(attribute, value)
  write_attribute(attribute, value)
  save
end

#update_attributes(attributes) ⇒ Object

Updates multiple attibutes at once, saving the object once the updates are complete.

Parameters:

  • attributes (Hash) —

    a hash of attributes to update

Since:

  • 0.2.0



126
127
128
129
 
# File 'lib/dynamoid/fields.rb', line 126

def update_attributes(attributes)
  attributes.each {|attribute, value| self.write_attribute(attribute, value)} unless attributes.nil? || attributes.empty?
  save
end

#write_attribute(name, value) ⇒ Object Also known as: []=

Write an attribute on the object. Also marks the previous value as dirty.

Parameters:

  • name (Symbol) —

    the name of the field

  • value (Object) —

    the value to assign to that field

Since:

  • 0.2.0



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/dynamoid/fields.rb', line 98

def write_attribute(name, value)
  if (size = value.to_s.size) > MAX_ITEM_SIZE
    Dynamoid.logger.warn "DynamoDB can't store items larger than #{MAX_ITEM_SIZE} and the #{name} field has a length of #{size}."
  end

  if association = @associations[name]
    association.reset
  end

  attributes[name.to_sym] = value
end