Class: Dynamoid::AdapterPlugin::AwsSdkV2::ItemUpdater

Inherits:
Object
  • Object
show all
Defined in:
lib/dynamoid/adapter_plugin/aws_sdk_v2.rb

Overview

Mimics behavior of the yielded object on DynamoDB’s update_item API (high level).

Constant Summary collapse

ADD = 
"ADD".freeze
DELETE = 
"DELETE".freeze
PUT = 
"PUT".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(table, key, range_key = nil) ⇒ ItemUpdater

Returns a new instance of ItemUpdater.



518
519
520
521
522
523
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 518

def initialize(table, key, range_key = nil)
  @table = table; @key = key, @range_key = range_key
  @additions = {}
  @deletions = {}
  @updates   = {}
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



516
517
518
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 516

def key
  @key
end

#range_key ⇒ Object (readonly)

Returns the value of attribute range_key.



516
517
518
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 516

def range_key
  @range_key
end

#table ⇒ Object (readonly)

Returns the value of attribute table.



516
517
518
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 516

def table
  @table
end

Instance Method Details

#add(values) ⇒ Object

Adds the given values to the values already stored in the corresponding columns. The column must contain a Set or a number.

Parameters:

  • vals (Hash) —

    keys of the hash are the columns to update, vals are the values to add. values must be a Set, Array, or Numeric



532
533
534
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 532

def add(values)
  @additions.merge!(values)
end

#delete(values) ⇒ Object

Removes values from the sets of the given columns

Parameters:

  • values (Hash) —

    keys of the hash are the columns, values are Arrays/Sets of items to remove



542
543
544
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 542

def delete(values)
  @deletions.merge!(values)
end

#set(values) ⇒ Object

Replaces the values of one or more attributes



549
550
551
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 549

def set(values)
  @updates.merge!(values)
end

#to_h ⇒ Object

Returns an AttributeUpdates hash suitable for passing to the V2 Client API



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v2.rb', line 556

def to_h
  ret = {}

  @additions.each do |k,v|
    ret[k.to_s] = {
      action: ADD,
      value: v
    }
  end
  @deletions.each do |k,v|
    ret[k.to_s] = {
      action: DELETE,
      value: v
    }
  end
  @updates.each do |k,v|
    ret[k.to_s] = {
      action: PUT,
      value: v
    }
  end

  ret
end