django-pgclone
django-pgclone makes it easy to dump and restore Postgres databases.
Here are some key features:
- Streaming dumps and restores to configurable storage backends like S3. Instances with limited memory aren't a problem for large databases.
- A restoration process that works behind the scenes, swapping in the restored database when finished.
- Configurable hooks into the dump and restore process, for example, migrating a restored database before it is swapped.
- Reversible restores, making it possible to quickly revert to the initial restore or the previous database.
- Re-usable configurations for instrumenting different types of dumps and restores.
Quickstart
To dump a database, do:
python manage.py pgclone dump
To list database dump keys, do:
python manage.py pgclone ls
To restore a datase, do:
python manage.py pgclone restore <dump_key>
Database dumps are relative to the storage location, which defaults to the local file system. Dump keys are in the format of <instance>/<database>/<config>/<timestamp>.dump.
When listing, use an optional prefix. Restoring supports the same interface, using the latest key that matches the prefix.
Documentation
View the django-pgclone docs here to learn more about:
- The basics and an overview of how it works.
- The core command docs.
- Configuring an S3 storage backend.
- Running management command hooks during dumping or restoring.
- Creating restores that can be quickly reverted.
- Re-using command parameters for different flows.
- All settings.
- Additional details on using AWS RDS databases.
Compatibility
django-pgclone is compatible with Python 3.10 - 3.14, Django 4.2 - 6.0, Psycopg 2 - 3, and Postgres 14 - 18.
Installation
Install django-pgclone with:
pip3 install django-pgclone
After this, add pgclone to the INSTALLED_APPS setting of your Django project.
Note Install the AWS CLI to enable the S3 storage backend. Use pip install awscli or follow the installation guide here.
Contributing Guide
For information on setting up django-pgclone for development and contributing changes, view CONTRIBUTING.md.
Primary Authors
- @wesleykendall (Wes Kendall)
- @ethanpobrien (Ethan O'Brien)
1 maintainer
Metadata
1 maintainer
Release files for django-pgclone 3.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django_pgclone-3.8.0.tar.gz | 17.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_pgclone-3.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 38.9 kB
Release files / django_pgclone-3.8.0.tar.gz
| Download URL | django_pgclone-3.8.0.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f8e67bc8d2dc00cb1b6a5aa83bd2be85f5fc2d9124c807526f34f64bfcd56fcd
|
|
BLAKE2b-256 checksum How to use checksums |
17b54e80d1153bf746d4ea7db16c8059ddf3a4507dd1d1d3bfe7cccc6a0ba1d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.14.0 Linux/6.8.0-1040-aws
|
Release files / django_pgclone-3.8.0-py3-none-any.whl
| Download URL | django_pgclone-3.8.0-py3-none-any.whl |
|---|---|
| Size | 21.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
57a2ff119493f38708c54e64ef22a616f29408f4dff84b933e62e6cabecc5f65
|
|
BLAKE2b-256 checksum How to use checksums |
d422af97557122390dbce217040315cdb48d9d99114704815328f92e3e12387c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.14.0 Linux/6.8.0-1040-aws
|
