47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# Migrations plugin for CakePHP
|
|
|
|
[](LICENSE.txt)
|
|
[](https://travis-ci.org/cakephp/migrations)
|
|
[](https://codecov.io/github/cakephp/migrations?branch=master)
|
|
[](https://packagist.org/packages/cakephp/migrations)
|
|
|
|
This is a Database Migrations system for CakePHP 3.
|
|
|
|
The plugin consists of a CakePHP shell wrapper for the [Phinx](http://phinx.org) migrations library.
|
|
|
|
## Installation
|
|
|
|
You can install this plugin into your CakePHP application using [Composer](http://getcomposer.org).
|
|
|
|
Run the following command
|
|
```sh
|
|
composer require cakephp/migrations
|
|
```
|
|
|
|
## Configuration
|
|
|
|
You can load the plugin using the shell command:
|
|
|
|
```
|
|
bin/cake plugin load Migrations
|
|
```
|
|
|
|
Or you can manually add the loading statement in the **src/Application.php** file of your application:
|
|
```php
|
|
public function bootstrap()
|
|
{
|
|
parent::bootstrap();
|
|
$this->addPlugin('Migrations');
|
|
}
|
|
```
|
|
Prior to 3.6.0
|
|
```php
|
|
Plugin::load('Migrations');
|
|
```
|
|
|
|
Additionally, you will need to configure the ``default`` database configuration in your **config/app.php** file.
|
|
|
|
## Documentation
|
|
|
|
Full documentation of the plugin can be found on the [CakePHP Cookbook](https://book.cakephp.org/migrations/2/).
|