Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tflori/breyta
Library for database migrations
https://github.com/tflori/breyta
Last synced: about 1 month ago
JSON representation
Library for database migrations
- Host: GitHub
- URL: https://github.com/tflori/breyta
- Owner: tflori
- License: mit
- Created: 2018-11-19T06:54:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T22:11:23.000Z (4 months ago)
- Last Synced: 2024-10-04T22:46:41.183Z (3 months ago)
- Language: PHP
- Size: 104 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# breyta
[](https://github.com/tflori/breyta/actions/workflows/push.yml)
[](https://codeclimate.com/github/tflori/breyta/test_coverage)
[](https://codeclimate.com/github/tflori/breyta/maintainability)
[](https://packagist.org/packages/tflori/breyta)
[](https://packagist.org/packages/tflori/breyta)
[](https://packagist.org/packages/tflori/breyta)
Breyta is a **library** for database migrations. There are a lot of applications for database migrations but no
actual library (without any user interface).
## Trivia
I created this library after trying ruckusing-migrations. It's the only one that does not require any additional library
to provide a user interface and is mentioned in awesome-php. Unfortunately it seems to be not actively developed and
maintained. Also I'm missing some functionality and it is very old, not using PSR-2/4 and namespaces.
The name for this library comes again from the Icelandic language and means "to change".
## Concept
* A migration is a set of database statements
* A migration has to run in a transaction
* Logging is important and goes to the migration table
* No code generating from this library (pure SQL)
* No user interface (API only)
* Generate fancy output and support progress bars
## Installation
We only support and suggest using composer - everything else on your own risk.
```console
$ composer require tflori/breyta
```
## Usage
> This might change in the next days till version 1.
Migration Script:
```php
exec('DROP TABLE IF EXISTS animals');
$this->exec('CREATE TABLE animals (
id MEDIUMINT NOT NULL AUTO_INCREMENT,
name CHAR(30) NOT NULL,
PRIMARY KEY (id)
)');
}
public function down(): void
{
$this->exec('DROP TABLE IF EXISTS animals');
}
}
```
Control structure:
```php
db, '/path/to/migrations', function($class, ...$args) {
// return app()->make($class, $args);
// the closure is optional. default:
if ($class === \Breyta\AdapterInterface::class) {
return new \Breyta\BasicAdapter(...$args); // first arg = closure $executor
}
return new $class(...$args); // first arg = AdapterInterface $adapter
});
// register handler (optional)
/** @var \Breyta\CallbackProgress $callbackProgress */
$callbackProgress = $breyta->getProgress();
$callbackProgress->onStart([$this, 'start'])
->onBeforeMigration([$this, 'beginMigration'])
->onBeforeExecution([$this, 'beforeExecution'])
->onAfterExecution([$this, 'afterExecution'])
->onAfterMigration([$this, 'finishMigration'])
->onFinish([$this, 'finish']);
// alternative: implement \Breyta\ProgressInterface and register
// $breyta->setProgress($this);
$breyta->migrate();
}
}
```
Please also have a look at the [reference](reference.md) for a better overview of the api.