headlight

A database migration toolkit.

Installation

Install headlight using PIP or poetry:

pip install headlight
# or
poetry add headlight

Features

• TODO

Usage

Create migration file

# create migration with
headlight new --name initial

It will create a new python file in migrations directory

Define schema

# migrations/0000_initial.py

from headlight import Blueprint, types

date = "2022-08-21T16:19:13.465195"
author = "alex"
transactional = True


def migrate(schema: Blueprint) -> None:
    with schema.create_table('users') as table:
        table.autoincrements()
        table.add_column('first_name', types.VarCharType(256))
        table.add_column('last_name', types.VarCharType(256))
        table.add_column('email', types.VarCharType(256))
        table.add_column('password', types.VarCharType(512))
        table.add_column('active', types.BooleanType(), default='1')
        table.add_column('photo', types.VarCharType(512), null=True)
        table.add_column('deleted_at', types.DateTimeType(True), null=True)
        table.add_created_timestamp('joined_at')
        table.add_index(['(lower(email))'], unique=True)

Execute migration

headlight upgrade

All migrations will be applied to the database

Rollback migration

headlight downgrade

The last migration will be rolled back,