Sha256: 01ea0c6051a0396bbcdd706005e560934042246a1ffaad3bcf730646721fb915

Contents?: true

Size: 1.97 KB

Versions: 79

Compression:

Stored size: 1.97 KB

Contents

module Fog
  module AWS
    class DynamoDB
      class Real

        # Update DynamoDB item
        #
        # ==== Parameters
        # * 'table_name'<~String> - name of table for item
        # * 'key'<~Hash>:
        #   * 'HashKeyElement'<~Hash>: info for primary key
        #     * 'AttributeName'<~String> - name of attribute
        #     * 'AttributeType'<~String> - type of attribute
        #   * 'RangeKeyElement'<~Hash>: optional, info for range key
        #     * 'AttributeName'<~String> - name of attribute
        #     * 'AttributeType'<~String> - type of attribute
        # * 'attribute_updates'<~Hash>:
        #   * 'AttributeName'<~String> - Attribute to update
        #     * 'Value'<~Hash> - formated as {type => value}
        #     * 'Action'<~String> - action to take if expects matches, in %w{ADD DELETE PUT}, defaults to PUT
        # * 'options'<~Hash>:
        #   * 'Expected'<~Hash>: data to check against
        #     * 'AttributeName'<~String> - name of attribute
        #     * 'Value'<~Hash> - a value to check for the value of
        #     or
        #     * 'Exists'<~Boolean> - set as false to only allow update if attribute doesn't exist
        #   * 'ReturnValues'<~String> - data to return in %w{ALL_NEW ALL_OLD NONE UPDATED_NEW UPDATED_OLD}, defaults to NONE
        #
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        #     varies based on ReturnValues param, see: http://docs.amazonwebservices.com/amazondynamodb/latest/developerguide/API_UpdateItem.html
        def update_item(table_name, key, attribute_updates, options = {})
          body = {
            'AttributeUpdates'  => attribute_updates,
            'Key'               => key,
            'TableName'         => table_name
          }.merge(options)

          request(
            :body     => Fog::JSON.encode(body),
            :headers  => {'x-amz-target' => 'DynamoDB_20111205.UpdateItem'}
          )
        end

      end
    end
  end
end

Version data entries

79 entries across 79 versions & 12 rubygems

Version Path
fog-1.22.0 lib/fog/aws/requests/dynamodb/update_item.rb
fog-1.21.0 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.20.0.20140305101839 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.20.0.20140305101305 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140212012611 lib/fog/aws/requests/dynamodb/update_item.rb
fog-1.20.0 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140110004459 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140110003812 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140109202555 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140107192102 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20140107142106 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.19.0.20131219203941 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131219193542 lib/fog/aws/requests/dynamodb/update_item.rb
fog-1.19.0 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131219033443 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131219032002 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131219030716 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131219022322 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131218202447 lib/fog/aws/requests/dynamodb/update_item.rb
fog-maestrodev-1.18.0.20131209091424 lib/fog/aws/requests/dynamodb/update_item.rb