Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bchew committed Nov 18, 2013
1 parent c26ed5a commit 60a0979
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright 2013 Benny Chew

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
dynamodump
==========

Backup and restore for Amazon DynamoDB
Simple backup and restore script for Amazon DynamoDB using boto. Suitable for DynamoDB usages of smaller data volume which do not warrant the usage of AWS Data Pipeline for backup/restores.

Example
-------
```
usage: dynamodump.py [-h] [-m MODE] [-r REGION] [-t TABLE]
Simple DynamoDB backup/restore
optional arguments:
-h, --help show this help message and exit
-m MODE, --mode MODE 'backup' or 'restore'
-r REGION, --region REGION
AWS region to use, e.g. 'us-west-1'
-t TABLE, --table TABLE
DynamoDB table name to backup or restore to
```

The script assumes your AWS access key and secret key is present in ~/.boto


To Do
-----
- Support backup/restore to local DynamoDB installs
- Support handling of multiple tables
- Improve backup/restore performance

0 comments on commit 60a0979

Please sign in to comment.