Dynamodb::Api
Installation
Add this line to your application's Gemfile:
gem 'dynamodb-api'And then execute:
$ bundle
Or install it yourself as:
$ gem install dynamodb-api
Configuration
Rails
config/initializers/dynamodb_api.rb
Dynamodb::Api.config do |config|
config.access_key_id = ''
config.secret_access_key = ''
config.region = ''
config.table_name_prefix = ''
config.index_name_prefix = ''
endOther
Dynamodb::Api.config.access_key_id = ''
Dynamodb::Api.config.secret_access_key = ''
Dynamodb::Api.config.region = ''
Dynamodb::Api.config.table_name_prefix = ''
Dynamodb::Api.config.index_name_prefix = ''How to use
e.g.
cars table.
| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 1 | 1 | Accord | 0.19760508e8 | 0 |
| 2 | 2 | CROWN | 0.19550101e8 | 0 |
| 3 | 3 | Model S | 0.20120601e8 | 0 |
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Scan
Scan returns items in random order.
scan = Dynamodb::Api.scan
scan.from('cars')
items = scan.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 1 | 1 | Accord | 0.19760508e8 | 0 |
| 2 | 2 | CROWN | 0.19550101e8 | 0 |
| 3 | 3 | Model S | 0.20120601e8 | 0 |
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Filter
scan = Dynamodb::Api.scan
scan.from('cars').
filter('model = :model', ':model': 'S2000')
items = scan.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Limit
scan = Dynamodb::Api.scan
scan.from('cars').
limit(1)
items = scan.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 1 | 1 | Accord | 0.19760508e8 | 0 |
Next(Paging)
scan = Dynamodb::Api.scan
scan.from('cars').
limit(1)
_items = scan.all.items
items = scan.next.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 2 | 2 | CROWN | 0.19550101e8 | 0 |
Query
https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method
Partition(Hash) key
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1])
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
| 1 | 1 | Accord | 0.19760508e8 | 0 |
Partition key and Sort(Range) key
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where([['maker_id', '=', 1], ['release_date', '>=', 19_980_101]])
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Sorting
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1]).
order('asc') # default: 'desc'
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 1 | 1 | Accord | 0.19760508e8 | 0 |
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Filter
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1]).
filter('model = :model', ':model': 'S2000')
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Limit
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1]).
order('asc'). # default: 'desc'
limit(1)
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 1 | 1 | Accord | 0.19760508e8 | 0 |
Next(Paging)
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1]).
order('asc'). # default: 'desc'
limit(1)
_items = query.all.items
items = query.next.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
Expression Attribute Names
Words reserved in DynamoDB can not be used without special processing.
In dynamodb-api , you can omit the special processing by putting # at the beginning of the word.
Refer to the list of reserved words from here.
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 1]).
filter('#status = :status', ':status': 1)
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) | status |
|---|---|---|---|---|
| 4 | 1 | S2000 | 0.19980101e8 | 1 |
If you don't add # to a reserved word, the following error will occur:
Aws::DynamoDB::Errors::ValidationException:
Invalid FilterExpression: Attribute name is a reserved keyword; reserved keyword: [reserved word]
Insert
item = { id: '5', maker_id: 1, maker: 'Honda', model: 'NSX', release_date: 19900914 }
Dynamodb::Api.insert('cars', item)Update
key = { id: '5' }
value = { new_col: 'new' }
Dynamodb::Api.update('cars', key, value)Delete
key = { id: '5' }
Dynamodb::Api.delete('cars', key)Remove attributes
key = { id: '3' }
attributes = ['status']
Dynamodb::Api.remove_attributes('cars', key, attributes)
query = Dynamodb::Api.query
query.from('cars').index('index_maker_id_release_date').
where(['maker_id', '=', 3])
items = query.all.items| id | maker_id(Partition key) | model | release_date(Sort key) |
|---|---|---|---|
| 3 | 3 | Model S | 0.20120601e8 |
Other API operations
client returns the <Aws::DynamoDB::Client> .
So, you can use all API operations.
client = Dynamodb::Api::Adapter.client # <Aws::DynamoDB::Client>
# e.g.
client.create_backup(
table_name: 'TableName', # required
backup_name: 'BackupName', # required
)Development
- Run
docker-compose upto run the dynamodb_local. - Run
docker-compose run ruby bundle exec rake specto run the tests. Or rundocker-compose run ruby bundle exec appraisal aws-sdk-* rake specto run the tests. Replase*with aws sdk major version. - You can also run
docker-compose run ruby bin/consolefor an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run docker-compose run ruby bundle exec rake install. To release a new version, update the version number in version.rb, and then run docker-compose run ruby bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dynamodb-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Dynamodb::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.