File: update_item.rb

package info (click to toggle)
ruby-fog-aws 3.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,816 kB
  • sloc: ruby: 68,587; makefile: 6
file content (49 lines) | stat: -rw-r--r-- 1,986 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
module Fog
  module AWS
    class DynamoDB
      class Real
        class DeprecatedAttributeUpdates < Exception; end
        # Update DynamoDB item
        #
        # ==== Parameters
        # * 'table_name'<~String> - name of table for item
        # * 'key'<~Hash> - list of elements to be updated and their value
        #   {
        #     "ForumName": {"S": "Amazon DynamoDB"},
        #     "Subject": {"S": "Maximum number of items?"}
        #   }
        #
        # * 'options'<~Hash>:
        #   * 'KeyConditionExpression'<~String> - the condition elements need to match
        #   * 'ExpressionAttributeValues'<~Hash> - values to be used in the key condition expression
        #   * '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
        #
        # See DynamoDB Documentation: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html
        #
        def update_item(table_name, key, options = {}, deprecated_attribute_updates = nil)
          if deprecated_attribute_updates
            raise DeprecatedAttributeUpdates, "The `20111205` DynamoDB API is deprecated. You need to use `ExpressionAttributeValues` instead of `AttributeUpdates`."
            attribute_updates = options
            options = deprecated_attribute_updates
          end

          body = {
            'Key'               => key,
            'TableName'         => table_name,
            'AttributeUpdates'  => attribute_updates,
          }.merge(options)

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