Skip to main content

Schema migration made easy

Project description

dbschema is a tool to run MySQL or PostgreSQL migrations automatically. Using a table, it keeps a state of previous migrations to avoid duplicates.

Features:

  • Support for MySQL and PostgreSQL

  • Optional pre and post-migration queries (for example to update privileges)

  • Multiple migrations in multiple databases can be processed as one.

Installation

Install dbschema

pip3 install dbschema

Create a config file

Create the file ~/.dbschema.yml and add your databases configuration. See example

Create migrations table

dbschema uses a table called migrations_applied to keep track of migrations already applied to avoid duplication. See the schema for MySQL or PostgreSQL.

Migrations folder structure

For each database, you need to have a migration path (setting path in the migration file).

Within that path you need to create one folder per migration. This folder needs to contain a file called up.sql with the SQL queries.

/path/to/migrations/db1/
|-- migration1/
|   |-- up.sql
|-- migration2/
|   |-- up.sql
|...
/path/to/migrations/db2/
|-- migration1/
|   |-- up.sql
|-- migration2/
|   |-- up.sql
|...

Usage

dbschema

# or
dbschema --config /path/to/config.yml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbschema-1.0.2.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

dbschema-1.0.2-py2.py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page