https://github.com/gabfl/dbschema

MySQL/PostgreSQL schema migrations made easy
https://github.com/gabfl/dbschema

database db-schema mysql postgresql schema-migrations sql-migration

Last synced: 11 days ago
JSON representation

MySQL/PostgreSQL schema migrations made easy

• Host: GitHub
• URL: https://github.com/gabfl/dbschema
• Owner: gabfl
• License: mit
• Created: 2017-08-05T00:13:00.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-05-09T00:23:19.000Z (over 1 year ago)
• Last Synced: 2024-10-14T01:27:01.960Z (26 days ago)
• Topics: database, db-schema, mysql, postgresql, schema-migrations, sql-migration
• Language: Python
• Size: 87.9 KB
• Stars: 16
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dbschema

[![Pypi](https://img.shields.io/pypi/v/dbschema.svg)](https://pypi.org/project/dbschema)

[![Build Status](https://github.com/gabfl/dbschema/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/gabfl/dbschema/actions)

[![codecov](https://codecov.io/gh/gabfl/dbschema/branch/main/graph/badge.svg)](https://codecov.io/gh/gabfl/dbschema)

[![MIT licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/gabfl/dbschema/main/LICENSE)

`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`

```bash

# Install required packages

apt-get update

apt-get install --yes libpq-dev gcc python3-dev

pip3 install dbschema

```

### Create a config file

Create the file `~/.dbschema.yml` and add your databases configuration. [See example](dbschema_sample.yml)

### 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](schema/mysql.sql) or [PostgreSQL](schema/postgresql.sql).

## 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 must contain a file called `up.sql` with the SQL queries and optionally a file called `down.sql` for rollbacks.

```

/path/to/migrations/db1/

|-- migration1/

|   |-- up.sql

|   |-- down.sql

|-- migration2/

|   |-- up.sql

|...

/path/to/migrations/db2/

|-- migration1/

|   |-- up.sql

|-- migration2/

|   |-- up.sql

|   |-- down.sql

|...

```

## Usage

### Apply pending migrations

```bash

dbschema

# or to specify a config file path

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

# or to migrate only a specific database

dbschema --tag db1

```

### Rollback

```bash

dbschema --tag db1 --rollback migration1

```

## Example

```bash

$ dbschema

  * Applying migrations for db1 (`test` on postgresql)

    -> Migration `migration1` applied

    -> Migration `migration2` applied

    -> Migration `migration3` applied

  * Migrations applied

  * Applying migrations for db2 (`test` on mysql)

    -> Migration `migration1` applied

    -> Migration `migration2` applied

    -> Migration `migration3` applied

  * Migrations applied

$

$ dbschema --tag db2 --rollback migration1

  * Rolling back mysql -> `migration1`

    -> Migration `migration1` has been rolled back

$

```