chronovoyage 0.1.3

My database migration framework.

ChronoVoyage

---

Table of Contents

• Installation
• License

Installation

To use MariaDB version, you need the MariaDB development package (libmariadb-dev in apt).

pip install chronovoyage[mariadb]

Usage

First, you should name and initialize a directory.

chronovoyage init my-project --vendor mariadb
cd my-project

Edit config.json.

{
  "$schema": "https://raw.githubusercontent.com/noritakaIzumi/chronovoyage/main/schema/config.schema.json",
  "vendor": "mariadb",
  "connection_info": {
    "host": "127.0.0.1",
    "port": 3306,
    "user": "mariadb",
    "password": "password",
    "database": "test"
  }
}

Create migration template directory.

chronovoyage add ddl initial_migration

If you create DML,

chronovoyage add dml second_migration

Write up sql to go.sql, and rollback sql to return.sql.

Then, migrate.

chronovoyage migrate

For more information

We have a documentation for more details.

https://chronovoyagemigration.net/

License

chronovoyage is distributed under the terms of the MIT license.

Roadmap

• Support for Python
  • 3.8
  • 3.9 or later
• Database support
  • MySQL
  • MariaDB
  • PostgreSQL
• Migration file support
  • SQL (.sql)
  • Shell script (.sh)
• Commands
  • new init
    • create migration directory and config file
  • generate add
    • create migration files from template
  • migrate
    • to latest
    • to specific version
    • from the beginning
    • from the middle
    • --dry-run
      • show executing SQL
    • detect ddl or dml
  • status current
    • show current migration status
  • rollback
    • to version
  • test
    • check if every "migrate -> rollback" operation means do nothing for schema
    • if dml, the operation means do nothing for data (including autoincrement num)
• Other
  • CLI logging
  • Documentation