jasny/dbvc

Database version control

DBVC

The dbvc commandline tool allows you to manage your database schema updates in your version control (git) repository., _(*1)

Configuration

DBVC looks for the dbvc.json configuration file., _(*2)

{
  "db": {
    "driver": "mysql",
    "host": "localhost",
    "username": "root",
    "password": "open",
    "dbname": "foobar"
  },
  "datadir": "dev",
  "vcs": "none"
}

If datadir is omitted, it defaults to "dev". If vcs is omitted, the vcs is automatically determined., _(*3)

Supported database interfaces

• mysql

You may issue a feature request to support other DBMSs., _(*4)

Supported version control systems

• git
• none

You may issue a feature request to support other VCSs., _(*5)

When using git, the correct order of the updates is automatically found by examining the git log., _(*6)

When selecting vcs 'none', updates are run in natural order. It's up to you to prefix the update files with (for instance) a date, to make sure that run in the correct order, _(*7)

Usage

Show a list of commands, _(*8)

dbvc help

Show help on a specific command, _(*9)

dbvc help init

Initialise DBVC for an existing database., _(*10)

dbvc init

Create a database dump. This is used to create the DB on a new environment., _(*11)

mysqldump foobar > dev/schema.php

Create the DB using the schema., _(*12)

dbvc create

Add an update file. These are used to update the DB on other environments., _(*13)

echo 'ALTER TABLE `foo` ADD COLUMN `status` BOOL DEFAULT 1;' > dev/updates/add-status-to-foo.sql

Mark an update as already run., _(*14)

dbvc mark add-status-to-foo

Show a list of updates that need to be run., _(*15)

dbvc status

Show all updates with their status., _(*16)

dbvc status --all

Update the database., _(*17)

dbvc update