console-helpers / db-migration
Database migrations made simple
Installs: 3 286
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 2
Requires
- php: >=5.3.7
- aura/sql: ^2.5 | ^3.0
Requires (Dev)
- aik099/coding-standard: dev-master
This package is auto-updated.
Last update: 2024-11-09 00:40:25 UTC
README
DB-Migration is a library allows to run migrations on SQLite databases with ease.
Goals, when developing the library:
- allow initializing library without knowing database connection details upfront
- allow creating new migration file without knowing database connection details upfront
- allow using several databases in parallel
- being framework agnostic
Usage
Initialization
use ConsoleHelpers\DatabaseMigration\MigrationManager; use ConsoleHelpers\DatabaseMigration\PhpMigrationRunner; use ConsoleHelpers\DatabaseMigration\SqlMigrationRunner; use Pimple\Container; // 1. Create migration manager instance. $migration_manager = new MigrationManager( '/path/to/migrations', // Directory containing migrations. new Container() // Anything implementing "ArrayAccess". ); // 2. Register migration runners. $migration_manager->registerMigrationRunner(new SqlMigrationRunner()); $migration_manager->registerMigrationRunner(new PhpMigrationRunner());
Creating new migration
The following code will create YYYYMMDD_HHMM_name.ext
migration file in configured migration folder and return it's name.
use ConsoleHelpers\DatabaseMigration\MigrationManager; $migration_name = $migration_manager->createMigration( 'example_migration', // any valid filename 'sql' // 'php' or 'sql' (comes from migration runner) );
As a result:
- the
/path/to/migrations/20160519_2155_example_migration.sql
file would be created - the
20160519_2155_example_migration.sql
would be returned to$migration_name
variable
Migration Templates
SQL:
Empty file.
PHP:
<?php use ConsoleHelpers\DatabaseMigration\MigrationContext; return function (MigrationContext $context) { // Write PHP code here. };
Running migrations
use Aura\Sql\ExtendedPdo; use ConsoleHelpers\DatabaseMigration\MigrationManager; use ConsoleHelpers\DatabaseMigration\MigrationContext; use Pimple\Container; // 1. Create database connection. $database = new ExtendedPdo('sqlite:/path/to/database.sqlite'); // 2. Run migrations. $migration_manager->runMigrations( // Context consists of the database and container. new MigrationContext($database) );
Installation
Execute this command to add dependencies:
php composer.phar require console-helpers/db-migration:^0.1
Requirements
Contributing
See CONTRIBUTING file.
License
DB-Migration is released under the BSD-3-Clause License. See the bundled LICENSE file for details.