Module: Aws::Record::Transactions

Extended by:: ClientConfiguration

Defined in:: lib/aws-record/record/transactions.rb

Class Method Summary collapse

.transact_find(opts) ⇒ OpenStruct

Provides support for the Aws::DynamoDB::Client#transact_get_item for aws-record models.
.transact_write(opts) ⇒ Object

Provides support for the Aws::DynamoDB::Client#transact_write_items for aws-record models.

Methods included from ClientConfiguration

configure_client, dynamodb_client

Class Method Details

.transact_find(opts) ⇒ `OpenStruct`

Provides support for the Aws::DynamoDB::Client#transact_get_item for aws-record models.

This method runs a transactional find across multiple DynamoDB items, including transactions which get items across multiple actual or virtual tables. This call can contain up to 100 item keys.

DynamoDB will reject the request if any of the following is true:

A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.
The aggregate size of the items in the transaction cannot exceed 4 MB.

Examples:

Usage Example

class TableOne
  include Aws::Record
  string_attr :uuid, hash_key: true
end

class TableTwo
  include Aws::Record
  string_attr :hk, hash_key: true
  string_attr :rk, range_key: true
end

results = Aws::Record::Transactions.transact_find(
  transact_items: [
    TableOne.tfind_opts(key: { uuid: "uuid1234" }),
    TableTwo.tfind_opts(key: { hk: "hk1", rk: "rk1"}),
    TableTwo.tfind_opts(key: { hk: "hk2", rk: "rk2"})
  ]
) # => results.responses contains nil or marshalled items
results.responses.map { |r| r.class } # [TableOne, TableTwo, TableTwo]

Parameters:

opts (Hash) —

Options to pass through to Aws::DynamoDB::Client#transact_get_items, with the exception of the :transact_items array, which uses the #tfind_opts operation on your model class to provide extra metadata used to marshal your items after retrieval.

Options Hash (opts):

:transact_items (Array) —

A set of #tfind_opts results, such as those created by the usage example.
:client (Aws::DynamoDB::Client) —

Optionally, you can pass in your own client to use for the transaction calls.

Returns:

(OpenStruct) —

Structured like the client API response from #transact_get_items, except that the responses member contains Aws::Record items marshaled into the classes used to call #tfind_opts in each positional member. See the usage example.

# File 'lib/aws-record/record/transactions.rb', line 58

def transact_find(opts)
  opts = opts.dup
  client = opts.delete(:client) || dynamodb_client
  transact_items = opts.delete(:transact_items) # add nil check?
  model_classes = []
  client_transact_items = transact_items.map do |tfind_opts|
    model_class = tfind_opts.delete(:model_class)
    model_classes << model_class
    tfind_opts
  end
  request_opts = opts
  request_opts[:transact_items] = client_transact_items
  client_resp = client.transact_get_items(
    request_opts
  )
  index = -1
  ret = OpenStruct.new
  ret.consumed_capacity = client_resp.consumed_capacity
  ret.missing_items = []
  ret.responses = client_resp.responses.map do |item|
    index += 1
    if item.nil? || item.item.nil?
      missing_data = {
        model_class: model_classes[index],
        key: transact_items[index][:get][:key]
      }
      ret.missing_items << missing_data
      nil
    else
      # need to translate the item keys
      raw_item = item.item
      model_class = model_classes[index]
      new_item_opts = {}
      raw_item.each do |db_name, value|
        name = model_class.attributes.db_to_attribute_name(db_name)
        new_item_opts[name] = value
      end
      item = model_class.new(new_item_opts)
      item.clean!
      item
    end
  end
  ret
end

.transact_write(opts) ⇒ `Object`

Provides support for the Aws::DynamoDB::Client#transact_write_items for aws-record models.

This method passes in aws-record items into transactional writes, as well as adding the ability to run ‘save’ commands in a transaction while allowing aws-record to determine if a :put or :update operation is most appropriate. #transact_write supports 5 different transact item modes:

save: Behaves much like the #save operation on the item itself. If the keys are dirty, and thus it appears to be a new item, will create a :put operation with a conditional check on the item’s existence. Note that you cannot bring your own conditional expression in this case. If you wish to force put or add your own conditional checks, use the :put operation.
put: Does a force put for the given item key and model.
update: Does an upsert for the given item.
delete: Deletes the given item.
check: Takes the result of #transact_check_expression, performing the specified check as a part of the transaction. See #transact_check_expression for more information.

This call contain up to 100 action requests.