Metadata-Version: 2.0
Name: dynamodb-utils
Version: 1.0.0
Summary: A toolchain for AWS DynamoDB to make common operations (backup, restore backups) easier.
Home-page: https://github.com/adamchainz/dynamodb_utils
Author: Adam Johnson
Author-email: me@adamj.eu
License: GPLv3
Keywords: python dynamodb amazon aws
Platform: UNKNOWN
Requires-Dist: pynamodb

dynamodb_utils
==============

A toolchain for Amazon's `DynamoDB <http://aws.amazon.com/dynamodb/>`_ to make
common operations (backup, restore backups) easier. Currently contains:

* ``dynamodb-dumper`` - backup tables out of DynamoDB with ease.
* ``dynamodb-loader`` - restore tables dumped by ``dynamodb-dumper`` with ease.

All tools are built to work with both the main DynamoDB service and DynamoDB
Local so you can test them out, and also move data easily between production
and your test environment, or between Dynamo regions.

Install with::

    pip install dynamodb_utils


Usage Examples
--------------

You can get the (hopefully detailed enough) help with e.g.::

    dynamodb-dumper --help

To dump a table, with compression::

    dynamodb-dumper mytable.name --compress

To dump just a few hash-key values from a table (for example, if you want a
restricted subset of data for development)::

    dynamodb-dumper mytable.name --compress --hash-keys 101 104 404

To load some compressed dump files on a DynamoDB Local instance running locally
on port 3232::

    dynamodb-loader mytable.name --host http://localhost:3232 --region localhost --load mytable.name.*.dump.gz

The tools are based upon `PynamoDB <https://github.com/jlafon/PynamoDB/>`_,
which is based upon `botocore <https://github.com/boto/botocore>`_. Therefore,
credentials will be read from one of many places - IAM Role, environment
variables, or a 'boto file'. See the `boto documentation
<https://boto.readthedocs.io/en/latest/boto_config_tut.html#credentials>`_ for
more details.


