Class: Dynamoid::AdapterPlugin::AwsSdkV3

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

Overview

The AwsSdkV3 adapter provides support for the aws-sdk version 2 for ruby.

Defined Under Namespace

Classes: ItemUpdater, Table

Constant Summary collapse

EQ = 
'EQ'
RANGE_MAP = 
{
  range_greater_than: 'GT',
  range_less_than:    'LT',
  range_gte:          'GE',
  range_lte:          'LE',
  range_begins_with:  'BEGINS_WITH',
  range_between:      'BETWEEN',
  range_eq:           'EQ'
}.freeze
FIELD_MAP =

Don’t implement NULL and NOT_NULL because it doesn’t make seanse - we declare schema in models

{
  eq:           'EQ',
  ne:           'NE',
  gt:           'GT',
  lt:           'LT',
  gte:          'GE',
  lte:          'LE',
  begins_with:  'BEGINS_WITH',
  between:      'BETWEEN',
  in:           'IN',
  contains:     'CONTAINS',
  not_contains: 'NOT_CONTAINS'
}.freeze
HASH_KEY = 
'HASH'
RANGE_KEY = 
'RANGE'
STRING_TYPE = 
'S'
NUM_TYPE = 
'N'
BINARY_TYPE = 
'B'
TABLE_STATUSES = 
{
  creating: 'CREATING',
  updating: 'UPDATING',
  deleting: 'DELETING',
  active: 'ACTIVE'
}.freeze
PARSE_TABLE_STATUS = 
lambda { |resp, lookup = :table|
  # lookup is table for describe_table API
  # lookup is table_description for create_table API
  #   because Amazon, damnit.
  resp.send(lookup).table_status
}
BATCH_WRITE_ITEM_REQUESTS_LIMIT = 
25
CONNECTION_CONFIG_OPTIONS = 
%i[endpoint region http_continue_timeout http_idle_timeout http_open_timeout http_read_timeout].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#table_cache ⇒ Object (readonly)

Returns the value of attribute table_cache.



57
58
59
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 57

def table_cache
  @table_cache
end

Instance Method Details

#batch_delete_item(options) ⇒ Object

Delete many items at once from DynamoDB. More efficient than delete each item individually.

or

Dynamoid::AdapterPlugin::AwsSdkV3.batch_delete_item('table1' => [['hk1', 'rk2'], ['hk1', 'rk2']]]))

See:

TODO handle rejections because of internal processing failures

Examples:

Delete IDs 1 and 2 from the table testtable

Dynamoid::AdapterPlugin::AwsSdk.batch_delete_item('table1' => ['1', '2'])

Parameters:

  • options (Hash) —

    the hash of tables and IDs to delete



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 256

def batch_delete_item(options)
  requests = []

  options.each_pair do |table_name, ids|
    table = describe_table(table_name)

    ids.each_slice(BATCH_WRITE_ITEM_REQUESTS_LIMIT) do |sliced_ids|
      delete_requests = sliced_ids.map do |id|
        { delete_request: { key: key_stanza(table, *id) } }
      end

      requests << { table_name => delete_requests }
    end
  end

  begin
    requests.map do |request_items|
      client.batch_write_item(
        request_items: request_items,
        return_consumed_capacity: 'TOTAL',
        return_item_collection_metrics: 'SIZE'
      )
    end
  rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
    raise Dynamoid::Errors::ConditionalCheckFailedException, e
  end
end

#batch_get_item(table_ids, options = {}) ⇒ Hash

Get many items at once from DynamoDB. More efficient than getting each item individually.

If optional block is passed ‘nil` will be returned and the block will be called for each read batch of items, meaning once per batch.

Block receives parameters:

  • hash with items like ‘{ table_name: [items]}`

  • and boolean flag is true if there are some unprocessed keys, otherwise false.

@todo: Provide support for passing options to underlying batch_get_item

Examples:

Retrieve IDs 1 and 2 from the table testtable

Dynamoid::AdapterPlugin::AwsSdkV3.batch_get_item('table1' => ['1', '2'])

Pass block to receive each batch

Dynamoid::AdapterPlugin::AwsSdkV3.batch_get_item('table1' => ids) do |hash, bool|
  puts hash['table1']

  if bool
    puts 'there are unprocessed keys'
  end
end

Parameters:

  • table_ids (Hash) —

    the hash of tables and IDs to retrieve

  • options (Hash) (defaults to: {}) —

    to be passed to underlying BatchGet call

  • optional (Proc) —

    block can be passed to handle each batch of items

Returns:

Since:

  • 1.0.0



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 182

def batch_get_item(table_ids, options = {})
  request_items = Hash.new { |h, k| h[k] = [] }
  return request_items if table_ids.all? { |_k, v| v.blank? }

  ret = Hash.new([].freeze) # Default for tables where no rows are returned

  table_ids.each do |t, ids|
    next if ids.blank?
    ids = Array(ids).dup
    tbl = describe_table(t)
    hk  = tbl.hash_key.to_s
    rng = tbl.range_key.to_s

    while ids.present?
      batch = ids.shift(Dynamoid::Config.batch_size)

      request_items = Hash.new { |h, k| h[k] = [] }

      keys = if rng.present?
               Array(batch).map do |h, r|
                 { hk => h, rng => r }
               end
             else
               Array(batch).map do |id|
                 { hk => id }
               end
             end

      request_items[t] = {
        keys: keys,
        consistent_read: options[:consistent_read]
      }

      results = client.batch_get_item(
        request_items: request_items
      )

      if block_given?
        batch_results = Hash.new([].freeze)

        results.data[:responses].each do |table, rows|
          batch_results[table] += rows.collect { |r| result_item_to_hash(r) }
        end

        yield(batch_results, results.unprocessed_keys.present?)
      else
        results.data[:responses].each do |table, rows|
          ret[table] += rows.collect { |r| result_item_to_hash(r) }
        end
      end

      if results.unprocessed_keys.present?
        ids += results.unprocessed_keys[t].keys.map { |h| h[hk] }
      end
    end
  end

  ret unless block_given?
end

#batch_write_item(table_name, objects, options = {}) ⇒ Object

Puts multiple items in one table

If optional block is passed it will be called for each written batch of items, meaning once per batch. Block receives boolean flag which is true if there are some unprocessed items, otherwise false.

See:

Examples:

Saves several items to the table testtable

Dynamoid::AdapterPlugin::AwsSdkV3.batch_write_item('table1', [{ id: '1', name: 'a' }, { id: '2', name: 'b'}])

Pass block

Dynamoid::AdapterPlugin::AwsSdkV3.batch_write_item('table1', items) do |bool|
  if bool
    puts 'there are unprocessed items'
  end
end

Parameters:

  • table_name (String) —

    the name of the table

  • items (Array) —

    to be processed

  • additional (Hash) —

    options

  • optional (Proc) —

    block



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 120

def batch_write_item(table_name, objects, options = {})
  items = objects.map { |o| sanitize_item(o) }

  begin
    while items.present?
      batch = items.shift(BATCH_WRITE_ITEM_REQUESTS_LIMIT)
      requests = batch.map { |item| { put_request: { item: item } } }

      response = client.batch_write_item(
        {
          request_items: {
            table_name => requests
          },
          return_consumed_capacity: 'TOTAL',
          return_item_collection_metrics: 'SIZE'
        }.merge!(options)
      )

      yield(response.unprocessed_items.present?) if block_given?

      if response.unprocessed_items.present?
        items += response.unprocessed_items[table_name].map { |r| r.put_request.item }
      end
    end
  rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
    raise Dynamoid::Errors::ConditionalCheckFailedException, e
  end
end

#client ⇒ Object

Return the client object.

Since:

  • 1.0.0



93
94
95
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 93

def client
  @client
end

#connect! ⇒ Aws::DynamoDB::Client

Establish the connection to DynamoDB.

Returns:

  • (Aws::DynamoDB::Client) —

    the DynamoDB connection



62
63
64
65
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 62

def connect!
  @client = Aws::DynamoDB::Client.new(connection_config)
  @table_cache = {}
end

#connection_config ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 67

def connection_config
  @connection_hash = {}

  (Dynamoid::Config.settings.compact.keys & CONNECTION_CONFIG_OPTIONS).each do |option|
    @connection_hash[option] = Dynamoid::Config.send(option)
  end
  if Dynamoid::Config.access_key?
    @connection_hash[:access_key_id] = Dynamoid::Config.access_key
  end
  if Dynamoid::Config.secret_key?
    @connection_hash[:secret_access_key] = Dynamoid::Config.secret_key
  end

  # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/plugins/logging.rb
  # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/log/formatter.rb
  formatter = Aws::Log::Formatter.new(':operation | Request :http_request_body | Response :http_response_body')
  @connection_hash[:logger] = Dynamoid::Config.logger
  @connection_hash[:log_level] = :debug
  @connection_hash[:log_formatter] = formatter

  @connection_hash
end

#count(table_name) ⇒ Object 



601
602
603
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 601

def count(table_name)
  describe_table(table_name, true).item_count
end

#create_table(table_name, key = :id, options = {}) ⇒ Object

Create a table on DynamoDB. This usually takes a long time to complete.

Parameters:

  • table_name (String) —

    the name of the table to create

  • key (Symbol) (defaults to: :id) —

    the table’s primary key (defaults to :id)

  • options (Hash) (defaults to: {}) —

    provide a range key here if the table has a composite key

Options Hash (options):

Since:

  • 1.0.0



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 294

def create_table(table_name, key = :id, options = {})
  Dynamoid.logger.info "Creating #{table_name} table. This could take a while."
  read_capacity = options[:read_capacity] || Dynamoid::Config.read_capacity
  write_capacity = options[:write_capacity] || Dynamoid::Config.write_capacity

  secondary_indexes = options.slice(
    :local_secondary_indexes,
    :global_secondary_indexes
  )
  ls_indexes = options[:local_secondary_indexes]
  gs_indexes = options[:global_secondary_indexes]

  key_schema = {
    hash_key_schema: { key => (options[:hash_key_type] || :string) },
    range_key_schema: options[:range_key]
  }
  attribute_definitions = build_all_attribute_definitions(
    key_schema,
    secondary_indexes
  )
  key_schema = aws_key_schema(
    key_schema[:hash_key_schema],
    key_schema[:range_key_schema]
  )

  client_opts = {
    table_name: table_name,
    provisioned_throughput: {
      read_capacity_units: read_capacity,
      write_capacity_units: write_capacity
    },
    key_schema: key_schema,
    attribute_definitions: attribute_definitions
  }

  if ls_indexes.present?
    client_opts[:local_secondary_indexes] = ls_indexes.map do |index|
      index_to_aws_hash(index)
    end
  end

  if gs_indexes.present?
    client_opts[:global_secondary_indexes] = gs_indexes.map do |index|
      index_to_aws_hash(index)
    end
  end
  resp = client.create_table(client_opts)
  options[:sync] = true if !options.key?(:sync) && ls_indexes.present? || gs_indexes.present?
  until_past_table_status(table_name, :creating) if options[:sync] &&
                                                    (status = PARSE_TABLE_STATUS.call(resp, :table_description)) &&
                                                    status == TABLE_STATUSES[:creating]
  # Response to original create_table, which, if options[:sync]
  #   may have an outdated table_description.table_status of "CREATING"
  resp
rescue Aws::DynamoDB::Errors::ResourceInUseException => e
  Dynamoid.logger.error "Table #{table_name} cannot be created as it already exists"
end

#create_table_synchronously(table_name, key = :id, options = {}) ⇒ Object

Create a table on DynamoDB synchronously. This usually takes a long time to complete. CreateTable is normally an asynchronous operation. You can optionally define secondary indexes on the new table,

as part of the CreateTable operation.

If you want to create multiple tables with secondary indexes on them,

you must create the tables sequentially.

Only one table with secondary indexes can be

in the CREATING state at any given time.

See: docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#create_table-instance_method

Parameters:

  • table_name (String) —

    the name of the table to create

  • key (Symbol) (defaults to: :id) —

    the table’s primary key (defaults to :id)

  • options (Hash) (defaults to: {}) —

    provide a range key here if the table has a composite key

Options Hash (options):

Since:

  • 1.2.0



370
371
372
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 370

def create_table_synchronously(table_name, key = :id, options = {})
  create_table(table_name, key, options.merge(sync: true))
end

#delete_item(table_name, key, options = {}) ⇒ Object

Removes an item from DynamoDB.

@todo: Provide support for various options docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method

Parameters:

  • table_name (String) —

    the name of the table

  • key (String) —

    the hash key of the item to delete

  • options (Hash) (defaults to: {}) —

    provide a range key here if the table has a composite key

Since:

  • 1.0.0



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 383

def delete_item(table_name, key, options = {})
  options ||= {}
  range_key = options[:range_key]
  conditions = options[:conditions]
  table = describe_table(table_name)
  client.delete_item(
    table_name: table_name,
    key: key_stanza(table, key, range_key),
    expected: expected_stanza(conditions)
  )
rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
  raise Dynamoid::Errors::ConditionalCheckFailedException, e
end

#delete_table(table_name, options = {}) ⇒ Object

Deletes an entire table from DynamoDB.

Parameters:

  • table_name (String) —

    the name of the table to destroy

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • sync (Boolean) —

    Wait for table status check to raise ResourceNotFoundException

Since:

  • 1.0.0



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 403

def delete_table(table_name, options = {})
  resp = client.delete_table(table_name: table_name)
  until_past_table_status(table_name, :deleting) if options[:sync] &&
                                                    (status = PARSE_TABLE_STATUS.call(resp, :table_description)) &&
                                                    status == TABLE_STATUSES[:deleting]
  table_cache.delete(table_name)
rescue Aws::DynamoDB::Errors::ResourceInUseException => e
  Dynamoid.logger.error "Table #{table_name} cannot be deleted as it is in use"
  raise e
end

#delete_table_synchronously(table_name, options = {}) ⇒ Object 



414
415
416
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 414

def delete_table_synchronously(table_name, options = {})
  delete_table(table_name, options.merge(sync: true))
end

#get_item(table_name, key, options = {}) ⇒ Hash

TODO:

Provide support for various options docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#get_item-instance_method

Fetches an item from DynamoDB.

Parameters:

  • table_name (String) —

    the name of the table

  • key (String) —

    the hash key of the item to find

  • options (Hash) (defaults to: {}) —

    provide a range key here if the table has a composite key

Returns:

  • (Hash) —

    a hash representing the raw item in DynamoDB

Since:

  • 1.0.0



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 431

def get_item(table_name, key, options = {})
  options = options.dup
  options ||= {}

  table = describe_table(table_name)
  range_key = options.delete(:range_key)
  consistent_read = options.delete(:consistent_read)

  item = client.get_item(table_name: table_name,
                         key: key_stanza(table, key, range_key),
                         consistent_read: consistent_read)[:item]
  item ? result_item_to_hash(item) : nil
end

#list_tables ⇒ Object

List all tables on DynamoDB.

Since:

  • 1.0.0



479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 479

def list_tables
  [].tap do |result|
    start_table_name = nil
    loop do
      result_page = client.list_tables exclusive_start_table_name: start_table_name
      start_table_name = result_page.last_evaluated_table_name
      result.concat result_page.table_names
      break unless start_table_name
    end
  end
end

#put_item(table_name, object, options = {}) ⇒ Object

Persists an item on DynamoDB.

See: docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method

Parameters:

  • table_name (String) —

    the name of the table

  • object (Object) —

    a hash or Dynamoid object to persist

Since:

  • 1.0.0



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 499

def put_item(table_name, object, options = {})
  options ||= {}
  item = sanitize_item(object)

  begin
    client.put_item(
      {
        table_name: table_name,
        item: item,
        expected: expected_stanza(options)
      }.merge!(options)
    )
  rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
    raise Dynamoid::Errors::ConditionalCheckFailedException, e
  end
end

#query(table_name, options = {}) ⇒ Enumerable

TODO:

Provide support for various other options docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method

Query the DynamoDB table. This employs DynamoDB’s indexes so is generally faster than scanning, but is only really useful for range queries, since it can only find by one hash key at once. Only provide one range key to the hash.

Parameters:

  • table_name (String) —

    the name of the table

  • options (Hash) (defaults to: {}) —

    the options to query the table with

Options Hash (options):

  • :hash_value (String) —

    the value of the hash key to find

  • :range_between (Number, Number) —

    find the range key within this range

  • :range_greater_than (Number) —

    find range keys greater than this

  • :range_less_than (Number) —

    find range keys less than this

  • :range_gte (Number) —

    find range keys greater than or equal to this

  • :range_lte (Number) —

    find range keys less than or equal to this

Returns:

  • (Enumerable) —

    matching items

Since:

  • 1.0.0



534
535
536
537
538
539
540
541
542
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 534

def query(table_name, options = {})
  table = describe_table(table_name)

  Enumerator.new do |yielder|
    Query.new(client, table, options).call.each do |page|
      page.items.each { |row| yielder << result_item_to_hash(row) }
    end
  end
end

#query_count(table_name, options = {}) ⇒ Object 



544
545
546
547
548
549
550
551
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 544

def query_count(table_name, options = {})
  table = describe_table(table_name)
  options[:select] = 'COUNT'

  Query.new(client, table, options).call
    .map(&:count)
    .reduce(:+)
end

#scan(table_name, conditions = {}, options = {}) ⇒ Enumerable

Scan the DynamoDB table. This is usually a very slow operation as it naively filters all data on the DynamoDB servers.

@todo: Provide support for various options docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#scan-instance_method

Parameters:

  • table_name (String) —

    the name of the table

  • conditions (Hash) (defaults to: {}) —

    a hash of attributes: matching records will be returned by the scan

Returns:

  • (Enumerable) —

    matching items

Since:

  • 1.0.0



564
565
566
567
568
569
570
571
572
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 564

def scan(table_name, conditions = {}, options = {})
  table = describe_table(table_name)

  Enumerator.new do |yielder|
    Scan.new(client, table, conditions, options).call.each do |page|
      page.items.each { |row| yielder << result_item_to_hash(row) }
    end
  end
end

#scan_count(table_name, conditions = {}, options = {}) ⇒ Object 



574
575
576
577
578
579
580
581
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 574

def scan_count(table_name, conditions = {}, options = {})
  table = describe_table(table_name)
  options[:select] = 'COUNT'

  Scan.new(client, table, conditions, options).call
    .map(&:count)
    .reduce(:+)
end

#truncate(table_name) ⇒ Object

Truncates all records in the given table

Parameters:

  • table_name (String) —

    the name of the table

Since:

  • 1.0.0



589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 589

def truncate(table_name)
  table = describe_table(table_name)
  hk    = table.hash_key
  rk    = table.range_key

  scan(table_name, {}, {}).each do |attributes|
    opts = {}
    opts[:range_key] = attributes[rk.to_sym] if rk
    delete_item(table_name, attributes[hk], opts)
  end
end

#update_item(table_name, key, options = {}) {|iu = ItemUpdater.new(table, key, range_key)| ... } ⇒ Object

TODO:

Provide support for various options docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method

Edits an existing item’s attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values

Parameters:

  • table_name (String) —

    the name of the table

  • key (String) —

    the hash key of the item to find

  • options (Hash) (defaults to: {}) —

    provide a range key here if the table has a composite key

Yields:

Returns:

  • new attributes for the record



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/dynamoid/adapter_plugin/aws_sdk_v3.rb', line 454

def update_item(table_name, key, options = {})
  options = options.dup

  range_key = options.delete(:range_key)
  conditions = options.delete(:conditions)
  table = describe_table(table_name)

  yield(iu = ItemUpdater.new(table, key, range_key))

  raise "non-empty options: #{options}" unless options.empty?
  begin
    result = client.update_item(table_name: table_name,
                                key: key_stanza(table, key, range_key),
                                attribute_updates: iu.to_h,
                                expected: expected_stanza(conditions),
                                return_values: 'ALL_NEW')
    result_item_to_hash(result[:attributes])
  rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
    raise Dynamoid::Errors::ConditionalCheckFailedException, e
  end
end