Module: Aws::Record::ItemOperations::ItemOperationsClassMethods
- Included in:
- Aws::Record
- Defined in:
- lib/aws-record/record/item_operations.rb
Instance Method Summary collapse
-
#find(opts) ⇒ Aws::Record
Builds and returns an instance of your model.
-
#find_with_opts(opts) ⇒ Aws::Record
Note that
#find_with_opts
will pass through all options other than:key
unaltered to the underlying Aws::DynamoDB::Client#get_item request. - #tfind_opts(opts) ⇒ Object
-
#transact_check_expression(opts) ⇒ Hash
Allows you to build a “check” expression for use in transactional write operations.
-
#transact_find(opts) ⇒ OpenStruct
Provides a way to run a transactional find across multiple DynamoDB items, including transactions which get items across multiple actual or virtual tables.
-
#update(opts) ⇒ Object
Performs an Aws::DynamoDB::Client#update_item call immediately on the table, using the attribute key/value pairs provided.
Instance Method Details
#find(opts) ⇒ Aws::Record
Returns builds and returns an instance of your model.
452 453 454 |
# File 'lib/aws-record/record/item_operations.rb', line 452 def find(opts) find_with_opts(key: opts) end |
#find_with_opts(opts) ⇒ Aws::Record
Note that #find_with_opts
will pass through all options other than :key
unaltered to the underlying Aws::DynamoDB::Client#get_item request. You should ensure that you have an aws-sdk gem version which supports the options you are including, and avoid adding options not recognized by the underlying client to avoid runtime exceptions.
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'lib/aws-record/record/item_operations.rb', line 482 def find_with_opts(opts) key = opts.delete(:key) request_key = {} @keys.keys.each_value do |attr_sym| unless key[attr_sym] raise Errors::KeyMissing.new( "Missing required key #{attr_sym} in #{key}" ) end attr_name = attributes.storage_name_for(attr_sym) request_key[attr_name] = attributes.attribute_for(attr_sym). serialize(key[attr_sym]) end request_opts = { table_name: table_name, key: request_key }.merge(opts) resp = dynamodb_client.get_item(request_opts) if resp.item.nil? nil else build_item_from_resp(resp) end end |
#tfind_opts(opts) ⇒ Object
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/aws-record/record/item_operations.rb', line 374 def tfind_opts(opts) opts = opts.dup key = opts.delete(:key) request_key = {} @keys.keys.each_value do |attr_sym| unless key[attr_sym] raise Errors::KeyMissing.new( "Missing required key #{attr_sym} in #{key}" ) end attr_name = attributes.storage_name_for(attr_sym) request_key[attr_name] = attributes.attribute_for(attr_sym). serialize(key[attr_sym]) end # this is a :get item used by #transact_get_items, with the exception # of :model_class which needs to be removed before passing along opts[:key] = request_key opts[:table_name] = table_name { model_class: self, get: opts } end |
#transact_check_expression(opts) ⇒ Hash
Allows you to build a “check” expression for use in transactional write operations.
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/aws-record/record/item_operations.rb', line 354 def transact_check_expression(opts) # need to transform the key, and add the table name opts = opts.dup key = opts.delete(:key) check_key = {} @keys.keys.each_value do |attr_sym| unless key[attr_sym] raise Errors::KeyMissing.new( "Missing required key #{attr_sym} in #{key}" ) end attr_name = attributes.storage_name_for(attr_sym) check_key[attr_name] = attributes.attribute_for(attr_sym). serialize(key[attr_sym]) end opts[:key] = check_key opts[:table_name] = table_name opts end |
#transact_find(opts) ⇒ OpenStruct
Provides a way to run a transactional find across multiple DynamoDB items, including transactions which get items across multiple actual or virtual tables.
427 428 429 430 431 432 433 434 435 436 |
# File 'lib/aws-record/record/item_operations.rb', line 427 def transact_find(opts) opts = opts.dup transact_items = opts.delete(:transact_items) global_transact_items = transact_items.map do |topts| tfind_opts(topts) end opts[:transact_items] = global_transact_items opts[:client] = dynamodb_client Transactions.transact_find(opts) end |
#update(opts) ⇒ Object
Performs an Aws::DynamoDB::Client#update_item call immediately on the table, using the attribute key/value pairs provided.
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/aws-record/record/item_operations.rb', line 529 def update(opts) key = {} updates = {} @keys.keys.each_value do |attr_sym| unless value = opts.delete(attr_sym) raise Errors::KeyMissing.new( "Missing required key #{attr_sym} in #{opts}" ) end attr_name = attributes.storage_name_for(attr_sym) key[attr_name] = attributes.attribute_for(attr_sym).serialize(value) end request_opts = { table_name: table_name, key: key } update_tuple = _build_update_expression(opts) unless update_tuple.nil? uex, exp_attr_names, exp_attr_values = update_tuple request_opts[:update_expression] = uex request_opts[:expression_attribute_names] = exp_attr_names request_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty? end dynamodb_client.update_item(request_opts) end |