https://github.com/activecollab/databasemigrations
Database migrations for Active Collab Database Connection and Database Structure
https://github.com/activecollab/databasemigrations
Last synced: 4 months ago
JSON representation
Database migrations for Active Collab Database Connection and Database Structure
- Host: GitHub
- URL: https://github.com/activecollab/databasemigrations
- Owner: activecollab
- License: mit
- Created: 2016-03-13T11:44:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T00:12:39.000Z (over 1 year ago)
- Last Synced: 2025-10-20T02:40:20.464Z (8 months ago)
- Language: PHP
- Size: 158 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Database Migrations
[](https://travis-ci.org/activecollab/databasemigrations)
## Migrations
To write a migration, create a class that is discoverable by Finder that you are using, and extend `Migration` class:
```php
connection->getTableNames()) {
$this->logger->debug('{table} not found in the database', ['table' => 'user_roles']);
$thos->connection->execute('CREATE TABLE STATEMENT');
$this->logger->debug('{table} created', ['table' => 'user_roles']);
}
}
}
```
## Finders
Migration classes are "discovered" using objects that implement `FinderInterface` interface. All that we expect from finders is that they return an array where key is migration class name, and value is path where we can expect to find the class definition. This makes migration library independent on directory and file structure that you decide to use to organize your migrations.
This library currently implements only one Finder - Migrations in Changesets.
### Migrations in a Changeset Finder
What we found to work really well for [Active Collab](https://www.activecollab.com/index.html) project are migrations that are grouped in changesets. A changeset is a directory that has one or more related migrations. Valid format of the changeset directory name is `YYYY-MM-DD-what-this-is-all-about`. Here's a couple of valid changeset names:
* `2016-01-02-add-invoicing-module`
* `2016-03-12-remove-is-trashed-project-field`
* `2016-12-09-fix-users-table-indexes`
Timestamp part of the changeset name is used for sorting, and details part is used to make it clear what the changeset is all about.
## Command Line
Database Migrations package includes a couple of traits that make implementation of commands that work with migrations easy. These commands are:
* List all migrations and their status (All)
* Run all non-executed migrations (Up)
* Create a new migration file (Create)
In order to use these traits, you need to include them in a regular Symfony Console class, and provide implementation of `getMigrations()` method. This method needs to return a valid, configured `MigrationsInterface` instance.
Create helper has extra requirements and extension points that lets you configure how migration stubs are created. Please check protected and abstract methods under `Override` comment in `/src/Command/Create.php` file for details.
## To Do
1. Add basic field, index and foreign key management helper methods to the base `Migration` implementation