A simple migration engine for Peewee ORM
Project description
Peewee Migrate – A simple migration engine for Peewee ORM
Requirements
peewee >= 3.7
Dependency Note
For Peewee<3.0 please use Peewee-Migrate==0.14.0. For Python<3.7 please use Peewee-Migrate==1.1.6.
Installation
Peewee Migrate should be installed using pip:
pip install peewee-migrate
Usage
Do you want Flask integration? Look at Flask-PW.
From shell
Getting help:
$ pw_migrate --help
Usage: pw_migrate [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
create Create migration.
migrate Run migrations.
rollback Rollback migration.
Create migration:
$ pw_migrate create --help
Usage: pw_migrate create [OPTIONS] NAME
Create migration.
Options:
--auto FLAG Scan sources and create db migrations automatically. Supports autodiscovery.
--auto-source TEXT Set to python module path for changes autoscan (e.g. 'package.models'). Current directory will be recursively scanned by default.
--database TEXT Database connection
--directory TEXT Directory where migrations are stored
-v, --verbose
--help Show this message and exit.
Run migrations:
$ pw_migrate migrate --help
Usage: pw_migrate migrate [OPTIONS]
Run migrations.
Options:
--name TEXT Select migration
--database TEXT Database connection
--directory TEXT Directory where migrations are stored
-v, --verbose
--help Show this message and exit.
Rollback migrations:
$ pw_migrate rollback --help
Usage: pw_migrate rollback [OPTIONS] [NAME]
Rollback a migration with given name or number of last migrations with
given --count option as integer number
Options:
--count INTEGER Number of last migrations to be rolled back.Ignored in
case of non-empty name
--database TEXT Database connection
--directory TEXT Directory where migrations are stored
-v, --verbose
--help Show this message and exit.
From python
from peewee_migrate import Router
from peewee import SqliteDatabase
router = Router(SqliteDatabase('test.db'))
# Create migration
router.create('migration_name')
# Run migration/migrations
router.run('migration_name')
# Run all unapplied migrations
router.run()Migration files
By default, migration files are looked up in os.getcwd()/migrations directory, but custom directory can be given.
Migration files are sorted and applied in ascending order per their filename.
Each migration file must specify migrate() function and may specify rollback() function
def migrate(migrator, database, fake=False, **kwargs):
pass
def rollback(migrator, database, fake=False, **kwargs):
passBug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/peewee_migrate/issues
Contributing
Development of starter happens at github: https://github.com/klen/peewee_migrate
Contributors
See AUTHORS.rst
License
Licensed under a BSD license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file peewee-migrate-1.4.9.tar.gz.
File metadata
- Download URL: peewee-migrate-1.4.9.tar.gz
- Upload date:
- Size: 16.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5cc8b5e3cbba5a07a4e9eccf460ce6c869a12ad6d62b246ecf1b42471cf57e0b |
|
| MD5 | aa86c855278bc5373f31e16fc066ab6b |
|
| BLAKE2b-256 | 56fe2d782a040286bc8dd283af554fe2eff8dfb254c3bce9027f54d59bb3f1f6 |
File details
Details for the file peewee_migrate-1.4.9-py3-none-any.whl.
File metadata
- Download URL: peewee_migrate-1.4.9-py3-none-any.whl
- Upload date:
- Size: 16.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6cd7fb9189a55731a9a2058a642fd513428b11fe0a76c3f429be19f04beeaf29 |
|
| MD5 | ce1d9078e2734c73bf138ca2b8cae3f3 |
|
| BLAKE2b-256 | c6f5b0ceb72430660743dce749e354ee3969d4caa65d6ea12ccddacda4c9d322 |
