dynamodb-migrator
A library that helps you create and migrate DynamoDB databases.
As performant DynamoDB is, that does come with the trade-off of being inflexible. Changing column names or adding secondary indexes is impossible.
The recommended approach is to create a new table with the desired properties, and migrate the existing data.
This library will help you do just that.
Usage
- Write a migration script
- Execute the migration script as a step in the build pipeline
- Add to the migration-script as required
Example Script
from migrator.dynamodb_migrator import Migrator
migrator = Migrator()
@migrator.version(1)
@migrator.create(AttributeDefinitions=[{'AttributeName': 'hash_key', 'AttributeType': 'N'}],
TableName='my_new_table',
KeySchema=[{'AttributeName': 'hash_key', 'KeyType': 'HASH'}],
BillingMode='PAY_PER_REQUEST')
def v1(created_table):
print("Table created using the kwargs provided")
print("Note that the keyword-args are passed onto boto as is")
print(created_table)
@migrator.version(2)
@migrator.add_index(AttributeDefinitions=[{'AttributeName': 'postcode', 'AttributeType': 'S'}],
LocalSecondaryIndexes=[{'IndexName': 'string',
'KeySchema': [{'AttributeName': 'customer_nr', 'KeyType': 'HASH'},
{'AttributeName': 'postcode', 'KeyType': 'RANGE'}],
'Projection': {'ProjectionType': 'ALL'}}])
def v2(created_table):
print("Created a new table with the new index")
print("Created a DynamoDB stream that sends all updates to the old table to a custom Lambda-function")
print("The custom Lambda-function sends all updates to the new table")
print(created_table)
@NotYetImplemented
@migrator.version(3)
@migrator.delete_table("first_table")
def v3(migrate):
print("About to delete table")
print("Ensure that all upstream applications point to the new table, before adding this part to the pipeline!")
migrate()
print("Table deleted")
@NotYetImplemented
@migrator.version(4)
@migrator.convert(lambda item -> {'id': translate(item.id)})
def v4(migrate):
print("About to:")
print(" - Create new table (first_table_v4)")
print(" - Create a AWS Lambda script that will execute the above lambda, and write the result int he new table")
print(" - Create DynamoDB Stream on 'first_table' that triggers the new Lambda")
print(" - Execute a script that automatically updates all existing data")
print(" (This will trigger all data in 'first_table' to be converted and copied into the new table")
migrate()
print("Table with new data is ready to use")
Examples
See the examples-folder.
Metadata
Release files for dynamodb-migrator 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dynamodb-migrator-0.0.8.tar.gz | 9.6 kB | Without provenance | Details for dynamodb-migrator-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dynamodb_migrator-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for dynamodb_migrator-0.0.8-py3-none-any.whl |
Total release size: 25.7 kB
Release files / dynamodb-migrator-0.0.8.tar.gz
| Download URL | dynamodb-migrator-0.0.8.tar.gz |
|---|---|
| Size | 9.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c5d1470c7b58089d2356c930c4ce4da3ae9169fbdab9abd5c895f1c6365da8d
|
|
BLAKE2b-256 checksum How to use checksums |
e996be752d01579455eab70bbc375b42d2e955fc52462204313551a6e0eca050
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5
|
Release files / dynamodb_migrator-0.0.8-py3-none-any.whl
| Download URL | dynamodb_migrator-0.0.8-py3-none-any.whl |
|---|---|
| Size | 16.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df91e6717fa7494c8362641e0168395911b4a543bb6c3ab839d6032a09f66b4b
|
|
BLAKE2b-256 checksum How to use checksums |
7999b6c400cd54bed60181039723b17e467cd88cc25177da48f58070293d7d13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5
|
Security for dynamodb-migrator 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.