CakePHP Migrations

https://github.com/cakephp/migrations
Admin
CakePHP Migrations is a database migration plugin that allows developers to track schema changes as...
Tokens:163,818
Snippets:1,368
Trust Score:9.3
License:MIT
Update:4 days ago
Show doc for...
Tokens:
Raw
### Decimal column definitions with precision and scale

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Examples of decimal columns where the length includes precision and scale, with an optional nullable marker.

```text
amount:decimal[5,2]
```

```text
amount:decimal?[5,2]
```

--------------------------------

### Apply Migrations with CLI

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/installation-and-overview.md

Run this command to apply the migration file once it has been created in the config/Migrations folder.

```bash
bin/cake migrations migrate
```

--------------------------------

### Run Seeds with Verbose Output

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Uses the '-v' parameter to get more output verbosity when running seeds.

```bash
bin/cake seeds run -v
```

--------------------------------

### Valid email field definitions

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Examples of valid column definitions for email fields, showing optional length, nullable marker, unique index, and custom index name.

```text
email:string?
```

```text
email:string:unique
```

```text
email:string?[50]
```

```text
email:string:unique:EMAIL_INDEX
```

```text
email:string[120]:unique:EMAIL_INDEX
```

--------------------------------

### Install Migrations plugin with Composer

Source: https://github.com/cakephp/migrations/blob/5.x/README.md

Run this command to install the cakephp/migrations plugin into your CakePHP application using Composer.

```sh
composer require cakephp/migrations
```

--------------------------------

### Default value types for columns

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Examples of supported default value types: booleans, integers, floats, strings, null, and SQL expressions like CURRENT_TIMESTAMP.

```text
active:boolean:default[true]
```

```text
count:integer:default[0]
```

```text
rate:decimal:default[1.5]
```

```text
status:string:default['pending']
```

```text
description:text?:default[null]
```

```text
created_at:datetime:default[CURRENT_TIMESTAMP]
```

--------------------------------

### Execute and Query Methods with Prepared Statements

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/executing-queries.md

Use execute() to get affected row count and query() to get a PDOStatement. Both accept an optional $params array to use prepared statements. The example shows DELETE and SELECT queries with and without parameters.

```php
<?php

use Migrations\BaseMigration;

class MyNewMigration extends BaseMigration
{
    /**
     * Migrate Up.
     */
    public function up(): void
    {
        // execute()
        $count = $this->execute('DELETE FROM users'); // returns the number of affected rows

        // query()
        $stmt = $this->query('SELECT * FROM users'); // returns PDOStatement
        $rows = $stmt->fetchAll(); // returns the result as an array

        // using prepared queries
        $count = $this->execute('DELETE FROM users WHERE id = ?', [5]);
        $stmt = $this->query('SELECT * FROM users WHERE id > ?', [5]); // returns PDOStatement
        $rows = $stmt->fetchAll();
    }

    /**
     * Migrate Down.
     */
    public function down(): void
    {

    }
}
```

--------------------------------

### Use BaseMigration::index() fluent builder (4.6.0+)

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

As of 4.6.0, you can use BaseMigration::index() to get a fluent builder for defining index options. This example sets type, name, and order fluently.

```php
$this->table('users')
    ->addIndex(
        $this->index(['email', 'username'])
            ->setType('unique')
            ->setName('idx_users_email')
            ->setOrder(['email' => 'DESC', 'username' => 'ASC'])
    )
    ->save();
```

--------------------------------

### Fetching Rows with fetchRow and fetchAll

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/executing-queries.md

Use fetchRow() to get a single row and fetchAll() to get multiple rows. Both methods accept raw SQL as their only parameter.

```php
<?php

use Migrations\BaseMigration;

class MyNewMigration extends BaseMigration
{
    /**
     * Migrate Up.
     */
    public function up(): void
    {
        // fetch a user
        $row = $this->fetchRow('SELECT * FROM users');

        // fetch an array of messages
        $rows = $this->fetchAll('SELECT * FROM messages');
    }

    /**
     * Migrate Down.
     */
    public function down(): void
    {

    }
}
```

--------------------------------

### Load Migrations plugin for CLI only

Source: https://github.com/cakephp/migrations/blob/5.x/README.md

Use this shell command to load the Migrations plugin only for CLI usage, which is recommended when not using the PendingMigrations middleware.

```shell
bin/cake plugin load Migrations --only-cli
```

--------------------------------

### Load Migrations plugin with PendingMigrations middleware

Source: https://github.com/cakephp/migrations/blob/5.x/README.md

Use this shell command to load the Migrations plugin when you are using the PendingMigrations middleware, which requires the plugin to be loaded in all contexts.

```shell
bin/cake plugin load Migrations
```

--------------------------------

### Load Migrations Plugin in Application.php

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/installation-and-overview.md

Alternatively, load the plugin in src/Application.php by adding this line to the bootstrap method.

```php
$this->addPlugin('Migrations');
```

--------------------------------

### Run migrations from non-shell environment using Migrations class

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use the Migrations\Migrations class to run migrations outside the command line, e.g., in a plugin installer. The methods migrate, rollback, markMigrated, status, and seed correspond to shell commands.

```php
use Migrations\Migrations;

$migrations = new Migrations();

$status = $migrations->status();
$migrate = $migrations->migrate();
$rollback = $migrations->rollback();
$markMigrated = $migrations->markMigrated(20150804222900);
$seeded = $migrations->seed();
```

--------------------------------

### Configure feature flags in config/app.php

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Set Migrations feature flags via Configure in config/app.php. These flags are disabled by default; the example enables unsigned_primary_keys, unsigned_ints, and column_null_default. Note that unsigned_primary_keys and unsigned_ints only affect MySQL databases.

```text
'Migrations' => [
    'unsigned_primary_keys' => true,
    'unsigned_ints' => true,
    'column_null_default' => true,
],
```

--------------------------------

### Create SP-GiST index on inet column

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use the 'spgist' type for data with natural clustering, such as IP addresses or phone numbers. The example indexes an inet column 'client_ip'.

```php
$this->table('access_logs')
    ->addColumn('client_ip', 'inet')
    ->addIndex('client_ip', ['type' => 'spgist'])
    ->create();
```

--------------------------------

### Run migrations in tests/bootstrap.php with Migrator

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use the Migrator class in tests/bootstrap.php to build schema for tests. It uses existing schema if current, otherwise drops all tables and reruns migrations from the beginning. Supports simple setup, non-test connections, and plugin migrations.

```php
// in tests/bootstrap.php
use Migrations\TestSuite\Migrator;

$migrator = new Migrator();

// Simple setup with no plugins
$migrator->run();

// Run a non-test database
$migrator->run(['connection' => 'test_other']);

// Run migrations for plugins
$migrator->run(['plugin' => 'Contacts']);

// Run the Documents migrations on the test_docs connection
$migrator->run(['plugin' => 'Documents', 'connection' => 'test_docs']);
```

--------------------------------

### Insert or Skip with insertOrSkip()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Use this method to insert rows while silently skipping any that violate a unique constraint. The example defines a CurrencySeed class that inserts currency data without erroring on conflicts.

```php
<?php

use Migrations\BaseSeed;

class CurrencySeed extends BaseSeed
{
    public function run(): void
    {
        $data = [
            ['code' => 'USD', 'name' => 'US Dollar'],
            ['code' => 'EUR', 'name' => 'Euro'],
        ];

        $this->table('currencies')
            ->insertOrSkip($data)
            ->saveData();
    }
}
```

--------------------------------

### Checking and Dropping a Check Constraint

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Shows how to use hasCheckConstraint() to check if a constraint exists and dropCheckConstraint() to remove it. The example checks for 'price_positive' on the 'products' table and drops it if present.

```php
$table = $this->table('products');
if ($table->hasCheckConstraint('price_positive')) {
    $table->dropCheckConstraint('price_positive')
        ->save();
}
```

--------------------------------

### Select fields to export with --fields

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Restricts the fields included in the seed file when using --data. Takes a comma-separated list of field names. This example exports only id, title, and excerpt.

```bash
# Will only export the fields `id`, `title` and `excerpt`
bin/cake bake seed --data --fields id,title,excerpt Articles
```

--------------------------------

### Create Products Table Migration

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/installation-and-overview.md

A migration file that creates a 'products' table with columns for name, description, created, and modified. The 'id' column is added implicitly as an integer primary key. Migrations are not automatically applied; use CLI commands to apply them.

```php
<?php
use Migrations\BaseMigration;

class CreateProducts extends BaseMigration
{
    public function change(): void
    {
        $table = $this->table('products');
        $table->addColumn('name', 'string', [
            'default' => null,
            'limit' => 255,
            'null' => false,
        ]);
        $table->addColumn('description', 'text', [
            'default' => null,
            'null' => false,
        ]);
        $table->addColumn('created', 'datetime', [
            'default' => null,
            'null' => false,
        ]);
        $table->addColumn('modified', 'datetime', [
            'default' => null,
            'null' => false,
        ]);
        $table->create();
    }
}
```

--------------------------------

### Create GiST index with opclass for trigram similarity

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use the 'gist' type with an 'opclass' option for trigram similarity searches. Requires the pg_trgm extension. The example indexes a string column 'name' with gist_trgm_ops.

```php
$this->table('products')
    ->addColumn('name', 'string')
    ->addIndex('name', [
        'type' => 'gist',
        'opclass' => ['name' => 'gist_trgm_ops'],
    ])
    ->create();
```

--------------------------------

### Create GIN index on JSONB column

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use the 'gin' type option to create a GIN index for full-text search, arrays, or JSONB columns. The example adds a JSONB column 'tags' and indexes it with GIN.

```php
$this->table('articles')
    ->addColumn('tags', 'jsonb')
    ->addIndex('tags', ['type' => 'gin'])
    ->create();
```

--------------------------------

### Get a Column List with getColumns()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/schema-introspection-and-platform-limitations.md

Retrieves all column names for a table by creating a table object and calling getColumns(). Schema is inspected when the migration runs. Use this to conditionally make changes or read data based on the current schema.

```php
<?php

use Migrations\BaseMigration;

class ColumnListMigration extends BaseMigration
{
    public function up(): void
    {
        $columns = $this->table('users')->getColumns();
    }
}

```

--------------------------------

### Create BRIN index on timestamp column

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use the 'brin' type for large, naturally-ordered tables like time-series data. BRIN indexes are smaller than B-tree but require physical ordering by the indexed column. The example indexes 'recorded_at'.

```php
$this->table('sensor_readings')
    ->addColumn('recorded_at', 'timestamp')
    ->addColumn('value', 'decimal')
    ->addIndex('recorded_at', ['type' => 'brin'])
    ->create();
```

--------------------------------

### Check all plugins with migrations status --all

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use migrations status --all to check the app and every loaded plugin in a single call. The command prints a compact per-section summary and exits non-zero when anything is pending, making it suitable for CI steps.

```bash
bin/cake migrations status --all
```

--------------------------------

### Check all plugins at once with status --all

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/running-and-managing-migrations.md

Prints status for the app and every loaded plugin that ships migrations in a single call. The default output is a compact summary; add -v for full per-section tables. Exit code is 0 when clean, 3 (CODE_STATUS_DOWN) when pending, 2 (CODE_STATUS_MISSING) when tracking entries lack files. Cannot be combined with --plugin or --cleanup.

```bash
bin/cake migrations status --all
```

```text
Summary: 2 of 3 sections require action:
  - APP: 2 pending
  - Migrator: 1 pending
```

--------------------------------

### Run migrations status and migrate with --plugin option

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use the --plugin (or -p) option to scope migration commands to a specific plugin. Replace PluginName with the actual plugin name.

```bash
bin/cake migrations status -p PluginName
bin/cake migrations migrate -p PluginName
```

--------------------------------

### Migrations::migrate()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Runs migrations. Accepts an array of parameters matching shell command options.

```APIDOC
## [PHP] Migrations::migrate()

### Description
Runs migrations. Accepts an array of parameters matching shell command options.

### Method
`migrate(array $options = [])`

### Parameters
- `$options` (array) - Optional - Array of parameters matching shell command options (e.g., `connection`, `source`).

### Example
```php
use Migrations\Migrations;

$migrations = new Migrations();
$migrate = $migrations->migrate();
```
```

--------------------------------

### Selecting Fields with select()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Demonstrates adding fields to the SELECT clause using an array of field names, aliases, or a closure. The closure receives the builder and returns the fields.

```php
<?php
$builder->select(['id', 'title', 'body']);

// Results in SELECT id AS pk, title AS aliased_title, body ...
$builder->select(['pk' => 'id', 'aliased_title' => 'title', 'body']);

// Use a closure
$builder->select(function ($builder) {
    return ['id', 'title', 'body'];
});
```

--------------------------------

### Create a table with bake migration

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Use `bin/cake bake migration` with column definitions to generate a migration that creates a table. The command accepts column names and types as arguments.

```bash
bin/cake bake migration CreateProducts name:string description:text created modified
```

--------------------------------

### Bake migration AddNameIndexToProducts with index

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Run this command to generate a migration that adds a string column 'name' with an index to the 'products' table. The 'index' suffix in the column definition triggers index creation.

```bash
bin/cake bake migration AddNameIndexToProducts name:string:index
```

--------------------------------

### migrations status --all

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Checks the app and every loaded plugin in a single call. Prints a compact per-section summary and exits non-zero when anything is pending, suitable for CI steps.

```APIDOC
## [CLI] migrations status --all

### Description
Checks the app and every loaded plugin in a single call. Prints a compact per-section summary and exits non-zero when anything is pending, suitable for CI steps.

### Command
`bin/cake migrations status --all`

### Example
```bash
bin/cake migrations status --all
```
```

--------------------------------

### Migrations::seed()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Runs seeders. Accepts an array of parameters matching shell command options.

```APIDOC
## [PHP] Migrations::seed()

### Description
Runs seeders. Accepts an array of parameters matching shell command options.

### Method
`seed(array $options = [])`

### Parameters
- `$options` (array) - Optional - Array of parameters matching shell command options (e.g., `connection`, `source`).

### Example
```php
use Migrations\Migrations;

$migrations = new Migrations();
$seeded = $migrations->seed();
```
```

--------------------------------

### Bake migration AddPriceToProducts with decimal column

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Run this command to generate a migration that adds a decimal column 'price' to the 'products' table. The migration file is created automatically with the specified precision and scale.

```bash
bin/cake bake migration AddPriceToProducts price:decimal[5,2]
```

--------------------------------

### Column syntax pattern

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Pattern for defining columns on the command line. The length is optional and must be in brackets; a question mark after the field type makes the column nullable.

```text
fieldName:fieldType?[length]:default[value]:indexType:indexName
```

--------------------------------

### Run multiple migration sets with runMany()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use runMany() to execute multiple migration sets in one call. Each array entry specifies a plugin and optionally a connection, as shown for Contacts and Documents.

```php
$migrator->runMany([
    ['plugin' => 'Contacts'],
    ['plugin' => 'Documents', 'connection' => 'test_docs'],
]);
```

--------------------------------

### Remove index by columns and by name

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use removeIndex() with a list of columns, or removeIndexByName() if the index was named. The example removes an index on 'email' and then removes a named index 'idx_users_email'.

```php
$table = $this->table('users');
$table->removeIndex(['email'])
    ->save();

$table->removeIndexByName('idx_users_email')
    ->save();
```

--------------------------------

### Generated CreateProducts migration class

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

The generated migration file defines a `CreateProducts` class extending `Migrations\BaseMigration`. The `change()` method creates the `products` table with columns for name, description, created, and modified, using default null values and non-null constraints.

```php
<?php
use Migrations\BaseMigration;

class CreateProducts extends BaseMigration
{
    /**
     * Change Method.
     *
     * More information on this method is available here:
     * https://book.cakephp.org/migrations/5/guides/writing-migrations/migration-methods.html#the-change-method
     * @return void
     */
    public function change(): void
    {
        $table = $this->table('products');
        $table->addColumn('name', 'string', [
            'default' => null,
            'limit' => 255,
            'null' => false,
        ]);
        $table->addColumn('description', 'text', [
            'default' => null,
            'null' => false,
        ]);
        $table->addColumn('created', 'datetime', [
            'default' => null,
            'null' => false,
        ]);
        $table->addColumn('modified', 'datetime', [
            'default' => null,
            'null' => false,
        ]);
        $table->create();
    }
}

```

--------------------------------

### Pass options array to Migrations methods

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Methods accept an array of parameters matching shell command options. Here, status is called with custom connection and source. markMigrated() is the exception: it expects the version number as first argument and options array as second.

```php
use Migrations\Migrations;

$migrations = new Migrations();
$status = $migrations->status([
    'connection' => 'custom',
    'source' => 'MyMigrationsFolder',
]);
```

--------------------------------

### Limit exported rows with --limit

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Limits the number of rows exported when using --data. By default all rows are exported. This example exports only the first 10 rows.

```bash
# Will only export the first 10 rows found
bin/cake bake seed --data --limit 10 Articles
```

--------------------------------

### create()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Creates the table and runs pending changes. Use this method when working with the Table object in a change() method.

```APIDOC
## create()

### Description
Creates the table and runs pending changes. Use this method when working with the Table object in a change() method.

### Method
create()

### Usage
$this->table('table_name')->create();
```

--------------------------------

### Create empty migration file

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Creates an empty migration file for full control over the executed SQL by omitting column definitions.

```bash
bin/cake migrations create MyCustomMigration
```

--------------------------------

### Set default value with Literal expression

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Uses a Literal to set a column default to an expression without quoting or escaping. Example uses uuid_generate_v4() for a UUID column.

```php
use Migrations\BaseMigration;
use Migrations\Db\Literal;

class AddSomeColumns extends BaseMigration
{
    public function change(): void
    {
        $this->table('users')
              ->addColumn('uniqid', 'uuid', [
                  'default' => Literal::from('uuid_generate_v4()'),
              ])
              ->create();
    }
}
```

--------------------------------

### Conditional logic in change() using isMigratingUp()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/migration-methods.md

Uses $this->isMigratingUp() inside change() to run irreversible operations only when migrating up. This prevents IrreversibleMigrationException when migrating down. The example inserts data only during the up migration.

```php
<?php

use Migrations\BaseMigration;

class CreateUserLoginsTable extends BaseMigration
{
    public function change(): void
    {
        // create the table
        $table = $this->table('user_logins');
        $table->addColumn('user_id', 'integer')
              ->addColumn('created', 'datetime')
              ->create();
        if ($this->isMigratingUp()) {
            $table->insert([['user_id' => 1, 'created' => '2020-01-19 03:14:07']])
                  ->save();
        }
    }
}
```

--------------------------------

### Generated migration for AddPriceToProducts

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

This is the generated migration file for adding a decimal column 'price' to the 'products' table. It uses the Migrations\BaseMigration class and defines the column with default null and not null constraints.

```php
<?php
use Migrations\BaseMigration;

class AddPriceToProducts extends BaseMigration
{
    public function change(): void
    {
        $table = $this->table('products');
        $table->addColumn('price', 'decimal', [
            'default' => null,
            'null' => false,
            'precision' => 5,
            'scale' => 2,
        ]);
        $table->update();
    }
}
```

--------------------------------

### Migrations constructor

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Creates a new Migrations instance. Optionally accepts default parameters that will be used for all subsequent method calls.

```APIDOC
## [PHP] Migrations::__construct()

### Description
Creates a new Migrations instance. Optionally accepts default parameters that will be used for all subsequent method calls.

### Method
`__construct(array $options = [])`

### Parameters
- `$options` (array) - Optional - Default parameters (e.g., `connection`, `source`).

### Example
```php
use Migrations\Migrations;

$migrations = new Migrations([
    'connection' => 'custom',
    'source' => 'MyMigrationsFolder',
]);
```
```

--------------------------------

### Retrieve Table object in up() method

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/migration-methods.md

Shows how to get a Table instance using $this->table('tableName') inside the up() method. The returned object allows manipulation of the database table using PHP code.

```php
<?php

use Migrations\BaseMigration;

class MyNewMigration extends BaseMigration
{
    public function up(): void
    {
        $table = $this->table('tableName');
    }

    public function down(): void
    {
    }
}
```

--------------------------------

### Inserting Data with Table Object

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Use the table() method to get a Table instance and insert data with insert() and saveData(). Note: saveData() must be called to commit data; Migrations buffers data until then.

```php
<?php

use Migrations\BaseSeed;

class PostsSeed extends BaseSeed
{
    public function run() : void
    {
        $data = [
            [
                'body'    => 'foo',
                'created' => date('Y-m-d H:i:s'),
            ],[ 
                'body'    => 'bar',
                'created' => date('Y-m-d H:i:s'),
            ]
        ];

        $posts = $this->table('posts');
        $posts->insert($data)
              ->saveData();
    }
}
```

--------------------------------

### Complex Conditions with Closures and Expression Objects

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Shows how to build complex conditions using a closure that receives an expression object. Conditions are tied with AND by default. The generated SQL is shown.

```php
<?php
// Coditions are tied together with AND by default
$builder
    ->select('*')
    ->from('articles')
    ->where(function ($exp) {
        return $exp
            ->eq('author_id', 2)
            ->eq('published', true)
            ->notEq('spam', true)
            ->gt('view_count', 10);
    });
```

```sql
SELECT * FROM articles
WHERE
    author_id = 2
    AND published = 1
    AND spam != 1
    AND view_count > 10
```

--------------------------------

### Run a seed with dependencies via CLI

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Command to run a seed that has dependencies. The system automatically executes any unexecuted dependencies first, unless they are already recorded in the cake_seeds table or the --force flag is used.

```bash
bin/cake seeds run ShoppingCartSeed
```

--------------------------------

### Check if a table exists with hasTable()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Use hasTable() to determine whether a table exists before performing operations. The example checks for the 'users' table and executes code inside the if block when it exists.

```php
if ($this->hasTable('users')) {
    // do something
}
```

--------------------------------

### func()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Creates SQL function expressions for use in queries. Supports common functions like count, sum, avg, min, max, concat, coalesce, dateDiff, and now.

```APIDOC
## func()

### Description
Creates SQL function expressions for use in queries. Supports common functions like count, sum, avg, min, max, concat, coalesce, dateDiff, and now.

### Method
func()

### Parameters
- **functionName** (string) - Required - The name of the SQL function to create (e.g., 'count', 'sum', 'avg', 'min', 'max', 'concat', 'coalesce', 'dateDiff', 'now').
- **args** (array) - Optional - Arguments for the function. Can be literal values or bound parameters. Use 'literal' key to mark a value as a literal.

### Return Value
Returns a function expression object that can be used in query builder methods like select().

### Example
```php
<?php
// Results in SELECT COUNT(*) count FROM ...
$builder->select(['count' => $builder->func()->count('*')]);
```

```php
<?php
// Generates:
// SELECT CONCAT(title, ' NEW') ...;
$concat = $builder->func()->concat([
    'title' => 'literal',
    ' NEW'
]);
$query->select(['title' => $concat]);
```
```

--------------------------------

### Combining Expressions with or_ and not

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Demonstrates combining expression objects using or_() and not() to create complex conditions. The generated SQL is shown.

```php
<?php
$builder
    ->select('*')
    ->from('articles')
    ->where(function ($exp) {
        $orConditions = $exp->or_(['author_id' => 2])
            ->eq('author_id', 5);
        return $exp
            ->not($orConditions)
            ->lte('view_count', 10);
    });
```

```sql
SELECT *
FROM articles
WHERE
    NOT (author_id = 2 OR author_id = 5)
    AND view_count <= 10
```

--------------------------------

### Get a Column by Name with getColumn()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/schema-introspection-and-platform-limitations.md

Retrieves a single column definition by name using getColumn(). Schema is inspected when the migration runs. Use this to conditionally make changes or read data based on the current schema.

```php
<?php

use Migrations\BaseMigration;

class ColumnListMigration extends BaseMigration
{
    public function up(): void
    {
        $column = $this->table('users')->getColumn('email');
    }
}

```

--------------------------------

### init()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

The init() method is run by Migrations before the run method if it exists. It can be used to initialize properties of the Seed class before using run.

```APIDOC
## init()

### Description
The `init()` method is run by Migrations before the run method if it exists. This can be used to initialize properties of the Seed class before using run.

### Method
init()

### Endpoint
N/A (Seed class method)
```

--------------------------------

### Create hash index on string column

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/indexes-and-constraints.md

Use the 'hash' type for simple equality comparisons. Rarely needed because B-tree handles equality efficiently. The example indexes a string column 'session_id' with a limit of 64.

```php
$this->table('sessions')
    ->addColumn('session_id', 'string', ['limit' => 64])
    ->addIndex('session_id', ['type' => 'hash'])
    ->create();
```

--------------------------------

### Create a migration with bin/cake bake migration

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Use this command to generate a new migration file in the config/Migrations directory. The file name is prefixed with a timestamp in the format YYYYMMDDHHMMSS_MigrationName.php. After creation, apply the migration with bin/cake migrations migrate.

```bash
bin/cake bake migration CreateProducts
```

--------------------------------

### Preview the upgrade with --dry-run

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/upgrades/upgrading-to-builtin-backend.md

Runs a dry run of the migration upgrade to preview changes without applying them.

```bash
bin/cake migrations upgrade --dry-run
```

--------------------------------

### Basic Where Conditions

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Shows how to add WHERE conditions using equality and comparison operators. Operators are placed after the field name with a space, e.g., 'id >'.

```php
// WHERE id = 1
$builder->where(['id' => 1]);

// WHERE id > 1
$builder->where(['id >' => 1]);
```

--------------------------------

### Multiple Where Conditions with andWhere and OR

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Illustrates combining multiple conditions using andWhere() or an array with multiple keys, and using the 'OR' key for OR conditions.

```php
<?php
$builder->where(['id >' => 1])->andWhere(['title' => 'My Title']);

// Equivalent to
$builder->where(['id >' => 1, 'title' => 'My title']);

// WHERE id > 1 OR title = 'My title'
$builder->where(['OR' => ['id >' => 1, 'title' => 'My title']]);
```

--------------------------------

### Apply migrations with bin/cake migrations migrate

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/running-and-managing-migrations.md

Runs all pending migrations or targets a specific version, custom source, connection, or plugin. Use the -t, -s, -c, and -p options to control the migration scope.

```bash
# Run all the migrations
bin/cake migrations migrate

# Migrate to a specific version using the --target option
bin/cake migrations migrate -t 20150103081132

# Run migrations from a custom source directory
bin/cake migrations migrate -s Alternate

# Run migrations against a different connection
bin/cake migrations migrate -c my_custom_connection

# Run migrations for a plugin
bin/cake migrations migrate -p MyAwesomePlugin
```

--------------------------------

### Create an Insert Query with Multiple Values

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Builds an insert query using getQueryBuilder('insert'), specifying columns, table, and multiple value sets, then executes it.

```php
<?php
$builder = $this->getQueryBuilder('insert');
$builder
    ->insert(['first_name', 'last_name'])
    ->into('users')
    ->values(['first_name' => 'Steve', 'last_name' => 'Jobs'])
    ->values(['first_name' => 'Jon', 'last_name' => 'Snow'])
    ->execute();
```

--------------------------------

### Create an Update Query

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Builds an update query using getQueryBuilder('update'), setting a column value and applying a where condition, then executes it.

```php
<?php
$builder = $this->getQueryBuilder('update');
$builder
    ->update('users')
    ->set('fname', 'Snow')
    ->where(['fname' => 'Jon'])
    ->execute();
```

--------------------------------

### Migrations::status()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Returns the status of migrations. Accepts an array of parameters matching shell command options.

```APIDOC
## [PHP] Migrations::status()

### Description
Returns the status of migrations. Accepts an array of parameters matching shell command options.

### Method
`status(array $options = [])`

### Parameters
- `$options` (array) - Optional - Array of parameters matching shell command options (e.g., `connection`, `source`).

### Example
```php
use Migrations\Migrations;

$migrations = new Migrations();
$status = $migrations->status();
```
```

--------------------------------

### Run the migration upgrade

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/upgrades/upgrading-to-builtin-backend.md

Executes the upgrade to migrate from phinxlog tables to the unified cake_migrations table.

```bash
bin/cake migrations upgrade
```

--------------------------------

### migrations migrate -p PluginName

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Scopes the migrations migrate command to a specific plugin.

```APIDOC
## [CLI] migrations migrate -p PluginName

### Description
Scopes the migrations migrate command to a specific plugin.

### Command
`bin/cake migrations migrate -p PluginName`

### Parameters
- `-p` (string) - Required - Plugin name to scope the command to.

### Example
```bash
bin/cake migrations migrate -p PluginName
```
```

--------------------------------

### Generate initial migration snapshot

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/snapshots-and-diffs.md

Creates a migration file named YYYYMMDDHHMMSS_Initial.php with create statements for all tables in the default connection. The snapshot is automatically marked as migrated unless --generate-only is used.

```bash
bin/cake bake migration_snapshot Initial
```

--------------------------------

### Add PendingMigrationsMiddleware to alert about missing migrations

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use Migrations.PendingMigrations middleware in local development to alert developers about unapplied migrations. Optionally include a list of plugins with migrations to check; add 'app' config key set to false to check only plugin migrations. Temporarily disable the check by adding skip-migration-check=1 to the URL query string.

```php
use Migrations\Middleware\PendingMigrationsMiddleware;

$config = [
    'plugins' => [
        // Optionally include a list of plugins with migrations to check.
    ],
];

$middlewareQueue
    // ErrorHandler middleware
    ->add(new PendingMigrationsMiddleware($config));
```

--------------------------------

### Accessing the Query Builder with getQueryBuilder

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Shows how to obtain a query builder instance via getQueryBuilder('select') and execute a SELECT query. The builder is provided by cakephp/database and supports 'select', 'insert', 'update', and 'delete' types.

```php
<?php

use Migrations\BaseMigration;

class MyNewMigration extends BaseMigration
{
    /**
     * Migrate Up.
     */
    public function up(): void
    {
        $builder = $this->getQueryBuilder('select');
        $statement = $builder->select('*')->from('users')->execute();
        var_dump($statement->fetchAll());
    }
}
```

--------------------------------

### Delete query using getQueryBuilder('delete')

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Builds and executes a DELETE query on the 'users' table where 'accepted_gdpr' is false. Uses the query builder obtained from getQueryBuilder('delete').

```php
<?php
$builder = $this->getQueryBuilder('delete');
$builder
    ->delete('users')
    ->where(['accepted_gdpr' => false])
    ->execute();
```

--------------------------------

### Seed bake options: --table, --plugin, --connection, --data

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Shows various options for the bake seed command. Use --table to specify the table name, --plugin to bake into a plugin, --connection for an alternative connection, and --data to include data from the table.

```bash
# you specify the name of the table the seed files will alter by using the ``--table`` option
bin/cake bake seed articles --table my_articles_table
# You can specify a plugin to bake into
bin/cake bake seed Articles --plugin PluginName

# You can specify an alternative connection when generating a seed.
bin/cake bake seed Articles --connection connection

# Include data from the Articles table in your seed.
bin/cake bake seed --data Articles
```

--------------------------------

### migrations status -p PluginName

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Scopes the migrations status command to a specific plugin.

```APIDOC
## [CLI] migrations status -p PluginName

### Description
Scopes the migrations status command to a specific plugin.

### Command
`bin/cake migrations status -p PluginName`

### Parameters
- `-p` (string) - Required - Plugin name to scope the command to.

### Example
```bash
bin/cake migrations status -p PluginName
```
```

--------------------------------

### Migrations::rollback()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Rolls back migrations. Accepts an array of parameters matching shell command options.

```APIDOC
## [PHP] Migrations::rollback()

### Description
Rolls back migrations. Accepts an array of parameters matching shell command options.

### Method
`rollback(array $options = [])`

### Parameters
- `$options` (array) - Optional - Array of parameters matching shell command options (e.g., `connection`, `source`).

### Example
```php
use Migrations\Migrations;

$migrations = new Migrations();
$rollback = $migrations->rollback();
```
```

--------------------------------

### fetchAll()

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/executing-queries.md

Fetches multiple rows from a SQL query. Accepts raw SQL as its only parameter.

```APIDOC
## fetchAll()

### Description
Fetches multiple rows from a SQL query. Accepts raw SQL as its only parameter.

### Method
`fetchAll()`

### Parameters
- **$sql** (string) - Required - The SQL query to execute.

### Returns
- **array** - An array of fetched rows.

### Request Example
```php
$rows = $this->fetchAll('SELECT * FROM messages');
```
```

--------------------------------

### Mark migrations as migrated with bin/cake migrations mark_migrated

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/running-and-managing-migrations.md

Marks migrations as migrated without running them. Use --target to mark up to a version, --exclude to skip the target, --only to mark just the target, or pass a version number or 'all' as a positional argument. Supports --source, --connection, and --plugin options.

```bash
bin/cake migrations mark_migrated
```

```bash
bin/cake migrations mark_migrated --target=20151016204000
```

```bash
bin/cake migrations mark_migrated --target=20151016204000 --exclude
```

```bash
bin/cake migrations mark_migrated --target=20151016204000 --only
```

```bash
bin/cake migrations mark_migrated 20150420082532
```

```bash
bin/cake migrations mark_migrated all
```

--------------------------------

### View migration status with bin/cake migrations status

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/running-and-managing-migrations.md

Prints a list of all migrations and their current status. Use --format json for JSON output. Supports --source, --connection, and --plugin options.

```bash
bin/cake migrations status
```

```bash
bin/cake migrations status --format json
```

--------------------------------

### Bake migration AddStatusToOrders with default and unique

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/creating-migrations.md

Run this command to generate a migration that adds a string column 'status' with a default value of 'pending' and a unique index to the 'orders' table. Combine default values with other options like nullable and indexes.

```bash
bin/cake bake migration AddStatusToOrders status:string:default['pending']:unique
```

--------------------------------

### KEY Partitioning with TYPE_KEY (MySQL only)

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Creates a partitioned 'cache' table using KEY partitioning on 'cache_key' with 16 partitions. Uses MySQL's internal hashing function; only available in MySQL.

```php
<?php
use Migrations\BaseMigration;
use Migrations\Db\Table\Partition;

class CreatePartitionedCache extends BaseMigration
{
    public function change(): void
    {
        $table = $this->table('cache', [
            'id' => false,
            'primary_key' => ['cache_key'],
        ]);
        $table->addColumn('cache_key', 'string', ['limit' => 255])
              ->addColumn('value', 'binary')
              ->partitionBy(Partition::TYPE_KEY, 'cache_key', ['count' => 16])
              ->create();
    }
}
```

--------------------------------

### Generate snapshot for a plugin

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/snapshots-and-diffs.md

Bakes a snapshot for a plugin using the --plugin option. Only tables with a Table object model class are added, and migration files are created in the plugin's config/Migrations directory.

```bash
bin/cake bake migration_snapshot Initial --plugin MyPlugin
```

--------------------------------

### Iterate Query Results and Fetch All Rows

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/using-the-query-builder.md

Shows two ways to retrieve rows from a query builder object: iterating directly with foreach and fetching all results as an associative array via execute()->fetchAll('assoc').

```php
<?php
// Iterate the query
foreach ($builder as $row) {
    echo $row['title'];
}

// Get the statement and fetch all results
$results = $builder->execute()->fetchAll('assoc');
```

--------------------------------

### Partitioning with Expressions using Literal

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Creates a partitioned 'events' table using RANGE partitioning with an expression YEAR(created_at) via the Literal class. Adds partitions for years 2022-2023 and a MAXVALUE partition.

```php
<?php
use Migrations\BaseMigration;
use Migrations\Db\Literal;
use Migrations\Db\Table\Partition;

class CreatePartitionedEvents extends BaseMigration
{
    public function change(): void
    {
        $table = $this->table('events', [
            'id' => false,
            'primary_key' => ['id', 'created_at'],
        ]);
        $table->addColumn('id', 'integer', ['identity' => true])
              ->addColumn('created_at', 'datetime')
              ->partitionBy(Partition::TYPE_RANGE, Literal::from('YEAR(created_at)'))
              ->addPartition('p2022', 2023)
              ->addPartition('p2023', 2024)
              ->addPartition('pmax', 'MAXVALUE')
              ->create();
    }
}
```

--------------------------------

### Old and new seed command syntax

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/upgrades/upgrading-to-builtin-backend.md

Shows the command structure changes for seeds between migrations 4.x and 5.x. The old phinx wrapper commands are replaced with new names; use the new commands for 5.x and later.

```bash
# Old (4.x and earlier)
bin/cake migrations seed
bin/cake migrations seed --seed Articles

# New (5.x and later)
bin/cake seeds run
bin/cake seeds run Articles
```

--------------------------------

### LIST Partitioning with TYPE_LIST_COLUMNS

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/writing-migrations/columns-and-table-operations.md

Creates a partitioned 'customers' table using LIST COLUMNS partitioning on the 'region' column. Requires MySQL; partition columns must be in the primary key. Adds partitions for Americas, Europe, and Asia regions.

```php
<?php
use Migrations\BaseMigration;
use Migrations\Db\Table\Partition;

class CreatePartitionedCustomers extends BaseMigration
{
    public function change(): void
    {
        $table = $this->table('customers', [
            'id' => false,
            'primary_key' => ['id', 'region'],
        ]);
        $table->addColumn('id', 'integer', ['identity' => true])
              ->addColumn('region', 'string', ['limit' => 20])
              ->addColumn('name', 'string')
              ->partitionBy(Partition::TYPE_LIST_COLUMNS, 'region')
              ->addPartition('p_americas', ['US', 'CA', 'MX', 'BR'])
              ->addPartition('p_europe', ['UK', 'DE', 'FR', 'IT'])
              ->addPartition('p_asia', ['JP', 'CN', 'IN', 'KR'])
              ->create();
    }
}
```

--------------------------------

### Run All Seeds with seeds run Command

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Executes all available seed classes using the 'seeds run' command. This is the default behavior when no seed name is provided.

```bash
bin/cake seeds run
```

--------------------------------

### Run a Specific Seed with Short or Full Name

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Runs a specific seed by passing its name as an argument. Both the short name (without the 'Seed' suffix) and the full name work identically.

```bash
bin/cake seeds run User
# or
bin/cake seeds run UserSeed
```

--------------------------------

### Set default parameters in Migrations constructor

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Pass default parameters to the Migrations constructor to apply them to all subsequent method calls. Here, connection and source are set as defaults for status() and migrate().

```php
use Migrations\Migrations;

$migrations = new Migrations([
    'connection' => 'custom',
    'source' => 'MyMigrationsFolder',
]);

$status = $migrations->status();
$migrate = $migrations->migrate();
```

--------------------------------

### Run Multiple Seeds with Comma-Separated Names

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/guides/seeding.md

Runs multiple seeds by separating their names with commas. Both short and full names are supported.

```bash
bin/cake seeds run User,Permission,Log
# or with full names
bin/cake seeds run UserSeed,PermissionSeed,LogSeed
```

--------------------------------

### Skip schema.lock generation with --no-lock

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/advanced/integration-and-deployment.md

Use the --no-lock option to skip generating the schema.lock file during migrate, rollback, or bake migration_snapshot commands. This is useful for production deployments.

```bash
bin/cake migrations migrate --no-lock
bin/cake migrations rollback --no-lock
bin/cake bake migration_snapshot MyMigration --no-lock
```

--------------------------------

### Generate snapshot from a different connection

Source: https://github.com/cakephp/migrations/blob/5.x/docs/en/getting-started/snapshots-and-diffs.md

Uses the --connection option to bake a snapshot from a datasource other than the default connection.

```bash
bin/cake bake migration_snapshot Initial --connection my_other_connection
```
Tokens:
Raw