South for the winter
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
example/migrations
lib/Dws/Sftw
.gitignore
LICENSE
README.md
composer.json
composer.lock
composer.phar

README.md

South For the Winter (sftw)

South for the Winter ("SFTW") is a db migration tool, a port of the excellent Akrabat db migration tool. In fact, it's as close to a straight rip-off as can be with one primary difference: Akrabat uses a Zend\Db database adapter and is largely targeted towards Zend Framework apps, while SFTW uses a vanilla PDO adapter and its own CLI script. Because of this, SFTW should be usable across a wide range of applications without incurring a ZF dependency.

Install

As a standalone component

$ git clone git@github.com:startupdevs/sftw.git

In another project via Composer

Add to your project's composer.json as follows:

{
	"repositories" : [
		{
			"type" : "vcs",
			"url" : "https://github.com/startupdevs/sftw.git"
		}
	]
	"require": {
		"startupdevs/sftw" : "dev-master"
	}
}

Optionally, you can add a bin-dir entry into the config section of your project's composer.json to specify where the sftw CLI scripts are symlinked.

{
    "config": {
        "bin-dir": "scripts"
    }	
}

Then in your project root (assuming you used the bin-dir setting above):

$ php composer.phar update
$ chmod +x ./scripts/sftw.php
$ ln -s ./scripts/sftw.php ./scripts/sftw

Usage

Assumes you have installed SFTW via Composer in your project myproject with a bin-dir value of scripts.

For each schema change you wish to implement, define a migration class - extending Dws\Db\Schema\AbstractChange. For example:

/*
* Adding your own namespace to the migration classes is optional. If you do,
* then you will be required to specify it during the invocation of the migration
* script.
*/
namespace Ooga\Db\Migration;

use Dws\Db\Schema\AbstractChange as SchemaChange;

class AddUserTable extends SchemaChange
{
	public function up()
	{
		$sql = '
			CREATE TABLE `user` (
				`id` INT(11) UNSIGNED NOT NULL,
				`name` VARCHAR(255)
			)
		';
		$this->querySQL($sql);	
	}

	public function down()
	{
		$sql = 'DROP TABLE `user`';
		$this->querySQL($sql);
	}

}

Save this file as:

/path/to/myproject/scripts/migrations/001-AddUserTable.php

Invocation, starting in the project root, is as follows:

To display the current schema version:

$ ./scripts/sftw current --host myhost --user myuser --pass mypass --db mydb

To upgrade to latest schema version:

$ ./scripts/sftw latest --host myhost --user myuser --pass mypass --db mydb --path ./scripts/migrations --namespace Ooga/Db/Migrations

Note that for convenience, you can use forward slashes (/) in the namespace. They will be reversed before use.

To migrate to a specific schema version (in this case v1):

$ ./scripts/sftw migrate 1 --host myhost --user myuser --pass mypass --db mydb --path ./scripts/migrations --namespace Ooga/Db/Migrations

To roll all the way back to the state before the first migration file:

$ ./scripts/sftw migrate 0 --host myhost --user myuser --pass mypass --db mydb --path ./scripts/migrations --namespace Ooga/Db/Migrations

To set the schema pointer to a particular version (when you have some migrations already "baked-in" to the deployed db, for example):

$ ./scripts/sftw point-to 5 --host myhost --user myuser --pass mypass --db mydb --path ./scripts/migrations --namespace Ooga/Db/Migrations

If you want to wrap the entire migration in a transaction, then use the --useTransaction option:

$ ./scripts/sftw latest --host myhost --user myuser --pass mypass --db mydb --path ./scripts/migrations --namespace Ooga/Db/Migrations --useTransaction

The --useTransaction option is unset/false by default since some engines do not support it.

Note: Depending upon how you write your migrations, schema migrations can be "data destructive". This is especially true of ADD/DROP TABLE and ALTER TABLE ADD/DROP COLUMN calls, but is even true when merely changing the format of a column.

For example, consider altering a datetime field into a integer Unix timestamp. A straight cast of a datetime value into an integer will result in a 0 value. A return to datetime will result in a 1970 date. To avoid this, your migration methods can perform the conversion as follows:

  1. create a temp column of the desired type to store the converted data
  2. drop the targeted column
  3. add converted data into the temp column
  4. drop the temp column

Rollbacks would obviously need to work in reverse.

Generally speaking, an upgrade/rollback sequence will restore the schema as expected, but unless special steps - as above - are taken to save/protect the affected data, it will likely be lost.

Next Steps

  1. Allow a local config file (with some default name like sftw.ini and CLI options to point to a new one and to disable automatic detection of the config) to contain connection/namespace/path params, similar to how phpunit employs phpunit.xml by default.

  2. Support multiple environments, allowing you to define connection/namespace/path settings based upon environment (development, staging, production, etc).

Finally

Enjoy the warm weather.