Module: Dynamoid::Persistence

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

Overview

Persistence is responsible for dumping objects to and marshalling objects from the datastore. It tries to reserialize values to be of the same type as when they were passed in, based on the fields in the class.

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#new_record ⇒ Object Also known as: new_record?

Returns the value of attribute new_record.



13
14
15
 
# File 'lib/dynamoid/persistence.rb', line 13

def new_record
  @new_record
end

Instance Method Details

#delete ⇒ Object

Delete this object from the datastore.

Since:

  • 0.2.0



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/dynamoid/persistence.rb', line 228

def delete
  options = range_key ? {:range_key => dump_field(self.read_attribute(range_key), self.class.attributes[range_key])} : {}

  # Add an optimistic locking check if the lock_version column exists
  if(self.class.attributes[:lock_version])
    conditions = {:if => {}}
    conditions[:if][:lock_version] =
      if changes[:lock_version].nil?
        self.lock_version
      else
        changes[:lock_version][0]
      end
    options[:conditions] = conditions
  end
  Dynamoid.adapter.delete(self.class.table_name, self.hash_key, options)
rescue Dynamoid::Errors::ConditionalCheckFailedException
  raise Dynamoid::Errors::StaleObjectError.new(self, 'delete')
end

#destroy ⇒ Object

Delete this object, but only after running callbacks for it.

Since:

  • 0.2.0



218
219
220
221
222
223
 
# File 'lib/dynamoid/persistence.rb', line 218

def destroy
  run_callbacks(:destroy) do
    self.delete
  end
  self
end

#dump ⇒ Object

Dump this object’s attributes into hash form, fit to be persisted into the datastore.

Since:

  • 0.2.0



250
251
252
253
254
255
256
 
# File 'lib/dynamoid/persistence.rb', line 250

def dump
  Hash.new.tap do |hash|
    self.class.attributes.each do |attribute, options|
      hash[attribute] = dump_field(self.read_attribute(attribute), options)
    end
  end
end

#persisted? ⇒ Boolean

Is this object persisted in the datastore? Required for some ActiveModel integration stuff.

Returns:

  • (Boolean)

Since:

  • 0.2.0



162
163
164
 
# File 'lib/dynamoid/persistence.rb', line 162

def persisted?
  !new_record?
end

#save(options = {}) ⇒ Object

Run the callbacks and then persist this object in the datastore.

Since:

  • 0.2.0



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dynamoid/persistence.rb', line 169

def save(options = {})
  self.class.create_table

  if new_record?
    conditions = { :unless_exists => [self.class.hash_key]}
    conditions[:unless_exists] << range_key if(range_key)

    run_callbacks(:create) { persist(conditions) }
  else
    persist
  end

  self
end

#touch(name = nil) ⇒ Object

Set updated_at and any passed in field to current DateTime. Useful for things like last_login_at, etc.



152
153
154
155
156
157
 
# File 'lib/dynamoid/persistence.rb', line 152

def touch(name = nil)
  now = DateTime.now
  self.updated_at = now
  attributes[name] = now if name
  save
end

#update(conditions = {}, &block) ⇒ Object 



208
209
210
211
212
213
 
# File 'lib/dynamoid/persistence.rb', line 208

def update(conditions = {}, &block)
  update!(conditions, &block)
  true
rescue Dynamoid::Errors::StaleObjectError
  false
end

#update!(conditions = {}, &block) ⇒ Object

update!() will increment the lock_version if the table has the column, but will not check it. Thus, a concurrent save will never cause an update! to fail, but an update! may cause a concurrent save to fail.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/dynamoid/persistence.rb', line 189

def update!(conditions = {}, &block)
  run_callbacks(:update) do
    options = range_key ? {:range_key => dump_field(self.read_attribute(range_key), self.class.attributes[range_key])} : {}

    begin
      new_attrs = Dynamoid.adapter.update_item(self.class.table_name, self.hash_key, options.merge(:conditions => conditions)) do |t|
        if(self.class.attributes[:lock_version])
          t.add(lock_version: 1)
        end

        yield t
      end
      load(new_attrs)
    rescue Dynamoid::Errors::ConditionalCheckFailedException
      raise Dynamoid::Errors::StaleObjectError.new(self, 'update')
    end
  end
end