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.



11
12
13
 
# File 'lib/dynamoid/persistence.rb', line 11

def new_record
  @new_record
end

Instance Method Details

#delete ⇒ Object

Delete this object from the datastore and all indexes.

Since:

  • 0.2.0



211
212
213
214
215
 
# File 'lib/dynamoid/persistence.rb', line 211

def delete
  delete_indexes
  options = range_key ? {:range_key => dump_field(self.read_attribute(range_key), self.class.attributes[range_key])} : {}
  Dynamoid::Adapter.delete(self.class.table_name, self.hash_key, options)
end

#destroy ⇒ Object

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

Since:

  • 0.2.0



201
202
203
204
205
206
 
# File 'lib/dynamoid/persistence.rb', line 201

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



220
221
222
223
224
225
226
 
# File 'lib/dynamoid/persistence.rb', line 220

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



149
150
151
 
# File 'lib/dynamoid/persistence.rb', line 149

def persisted?
  !new_record?
end

#save(options = {}) ⇒ Object

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

Since:

  • 0.2.0



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/dynamoid/persistence.rb', line 156

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.



139
140
141
142
143
144
 
# File 'lib/dynamoid/persistence.rb', line 139

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

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



191
192
193
194
195
196
 
# File 'lib/dynamoid/persistence.rb', line 191

def update(conditions = {}, &block)
  update!(conditions, &block)
  true
rescue Dynamoid::Errors::ConditionalCheckFailedException
  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.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/dynamoid/persistence.rb', line 176

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])} : {}
    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])
        raise "Optimistic locking cannot be used with Partitioning" if(Dynamoid::Config.partitioning)
        t.add(lock_version: 1)
      end

      yield t
    end
    load(new_attrs)
  end
end