Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/walkersumida/dynamodb-api

AWS DynamoDB SDK wrapper gem. like ActiveRecord and simply.
https://github.com/walkersumida/dynamodb-api

aws dynamodb gem ruby

Last synced: 6 days ago
JSON representation

AWS DynamoDB SDK wrapper gem. like ActiveRecord and simply.

Host: GitHub
URL: https://github.com/walkersumida/dynamodb-api
Owner: walkersumida
License: mit
Created: 2018-07-11T15:44:26.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2021-06-27T13:28:53.000Z (over 3 years ago)
Last Synced: 2024-04-30T02:02:21.869Z (7 months ago)
Topics: aws, dynamodb, gem, ruby
Language: Ruby
Homepage: https://rubygems.org/gems/dynamodb-api
Size: 161 KB
Stars: 16
Watchers: 3
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Dynamodb::Api

![Build Status](https://github.com/walkersumida/dynamodb-api/workflows/build/badge.svg?branch=master)

[![Gem Version](https://badge.fury.io/rb/dynamodb-api.svg)](https://badge.fury.io/rb/dynamodb-api)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'dynamodb-api'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install dynamodb-api

## Configuration

### Rails

`config/initializers/dynamodb_api.rb`

```ruby

Dynamodb::Api.config do |config|

  config.access_key_id = ''

  config.secret_access_key = ''

  config.region = ''

  config.table_name_prefix = ''

  config.index_name_prefix = ''

end

```

### Other

```ruby

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.

```ruby

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

```ruby

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

```ruby

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)

```ruby

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

```ruby

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

```ruby

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

```ruby

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

```ruby

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

```ruby

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)

```ruby

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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html).

```ruby

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

```ruby

item = { id: '5', maker_id: 1, maker: 'Honda', model: 'NSX', release_date: 19900914 }

Dynamodb::Api.insert('cars', item)

```

### Update

```ruby

key = { id: '5' }

value = { new_col: 'new' }

Dynamodb::Api.update('cars', key, value)

```

### Delete

```ruby

key = { id: '5' }

Dynamodb::Api.delete('cars', key)

```

### Remove attributes

```ruby

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 `` .

So, you can use all [API operations](https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html).

```ruby

client = Dynamodb::Api::Adapter.client # 

# e.g.

client.create_backup(

  table_name: 'TableName', # required

  backup_name: 'BackupName', # required

)

```

## Development

- Run `docker-compose up` to run the dynamodb_local.

- Run `docker-compose run ruby bundle exec rake spec` to run the tests. Or run `docker-compose run ruby bundle exec appraisal aws-sdk-* rake spec` to run the tests. Replase `*` with aws sdk major version.

- You can also run `docker-compose run ruby bin/console` for 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](https://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](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## 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](https://github.com/[USERNAME]/dynamodb-api/blob/master/CODE_OF_CONDUCT.md).