https://github.com/cakephp/migrations

CakePHP database migrations plugin
https://github.com/cakephp/migrations

cakephp cakephp-plugin database-migrations php

Last synced: 2 months ago
JSON representation

CakePHP database migrations plugin

• Host: GitHub
• URL: https://github.com/cakephp/migrations
• Owner: cakephp
• License: other
• Created: 2014-08-23T17:40:26.000Z (over 10 years ago)
• Default Branch: 4.x
• Last Pushed: 2024-04-13T22:34:07.000Z (9 months ago)
• Last Synced: 2024-04-14T00:23:13.374Z (9 months ago)
• Topics: cakephp, cakephp-plugin, database-migrations, php
• Language: PHP
• Homepage:
• Size: 2.26 MB
• Stars: 133
• Watchers: 35
• Forks: 115
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-cakephp - Migrations plugin - (DB) Migration plugin. (Migration)

README

        
# Migrations plugin for CakePHP

[![CI](https://github.com/cakephp/migrations/actions/workflows/ci.yml/badge.svg)](https://github.com/cakephp/migrations/actions/workflows/ci.yml)

[![Coverage Status](https://img.shields.io/codecov/c/github/cakephp/migrations/3.x.svg?style=flat-square)](https://app.codecov.io/github/cakephp/migrations/tree/3.x)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)

[![Total Downloads](https://img.shields.io/packagist/dt/cakephp/migrations.svg?style=flat-square)](https://packagist.org/packages/cakephp/migrations)

This is a Database Migrations system for CakePHP.

The plugin consists of a CakePHP CLI wrapper for the [Phinx](https://book.cakephp.org/phinx/0/en/index.html) migrations library.

This branch is for use with CakePHP **5.x**. See [version map](https://github.com/cakephp/migrations/wiki#version-map) for details.

## Installation

You can install this plugin into your CakePHP application using [Composer](https://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(): void

{

    parent::bootstrap();

    $this->addPlugin('Migrations');

}

```

### Enabling the builtin backend

In a future release, migrations will be switching to a new backend based on the CakePHP ORM. We're aiming

to be compatible with as many existing migrations as possible, and could use your feedback. Enable the

new backend with:

```php

// in app/config/app_local.php

$config = [

    // Other configuration

    'Migrations' => ['backend' => 'builtin'],

];

```

## Documentation

Full documentation of the plugin can be found on the [CakePHP Cookbook](https://book.cakephp.org/migrations/4/).