Peewee Migrate -- A simple migration engine for Peewee ORM
Contents
- peewee >= 3.8
- For
Peewee<3.0please usePeewee-Migrate==0.14.0 - For
Python 3.0-3.6please usePeewee-Migrate==1.1.6 - For
Python 3.7please usePeewee-Migrate==1.6.6 - For
Python 3.8+please usePeewee-Migrate>=1.12.1
Peewee Migrate should be installed using pip:
pip install peewee-migrate
Do you want Flask integration? Look at Flask-PW.
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]
Rollback a migration with given steps --count of last migrations 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 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()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):
passIf you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/peewee_migrate/issues
Development of starter happens at github: https://github.com/klen/peewee_migrate