tormor

Database migration helper


Keywords
migration-tool, postgres, python, sql
License
MIT
Install
pip install tormor==2.5

Documentation

Tormor Command Line Tool

PyPI version CircleCI Coverage Status

Tormor is a command line tool for migrating database. To use Tormor, please first ensure these requirements:

  • Postgresql has been installed
  • Postgresql can be accessed using command :
    $ psql
  • SCHEMA_PATH has been specified

Installation

Tormor requires Python 3.5 or later to run. Tormor can be installed using pip:

$ pip install git+https://github.com/Proteus-tech/tormor.git@pytest_asyncpg_dryrun

Instruction

$ tormor [opts] command [args]

For more information, please use command:

$ tormor --help

Enabling Modules

enable-modules command receives module name as a parameter to be enabled and later migrated using migrate command.

$ tormor enable-modules module-to-be-migrated

Migrate

migrate command executes sql files under the enabled modules. To start migration, use the following command:

$ tormor migrate

To simply output migration sql queries without executing them, use the following command.

$ tormor migrate --dry-run

Run a Script File

include command takes filename as a parameter allows tormor commands to be run in a script, each line at a time.

$ tormor include filename

Execute SQL File

sql command takes filename as a parameter and load and execute the query inside it.

$ tormor sql filename

Dev

Requirements

  • flit
  • PostgreSQL
pip install flit
flit install
./runtests

Publish to PyPI

flit publish