CakePHP 3 migration command

Table of Contents

I researched migration command in CakePHP 3.

Environment

PHP 5.5.9
cakephp/cakephp 3.0.9
cakephp/migrations 1.1.4

Task executed by bake

migration

Migration code is generated by the command like the following.

php bin/cake.php bake migration xxxx

1	php bin/cake.php bake migration xxxx

Command is defined in MigrationTask.php which inherits SimpleMigrationTask.php. Let’s look at options and predefined format.

/**
* Gets the option parser instance and configures it.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser()
{
$name = ($this->plugin ? $this->plugin . '.' : '') . $this->name;
$parser = new ConsoleOptionParser($name);
$bakeThemes = [];
foreach (Plugin::loaded() as $plugin) {
$path = Plugin::classPath($plugin);
if (is_dir($path . 'Template' . DS . 'Bake')) {
$bakeThemes[] = $plugin;
}
}
$parser->description(
'Bake migration class.'
)->addOption('plugin', [
'short' => 'p',
'help' => 'Plugin to bake into.'
])->addOption('force', [
'short' => 'f',
'boolean' => true,
'help' => 'Force overwriting existing files without prompting.'
])->addOption('connection', [
'short' => 'c',
'default' => 'default',
'help' => 'The datasource connection to get data from.'
])->addOption('theme', [
'short' => 't',
'help' => 'The theme to use when baking code.',
'choices' => $bakeThemes
]);
return $parser;
}

/**

* Gets the option parser instance and configures it.

* @return \Cake\Console\ConsoleOptionParser

public function getOptionParser()

{

$name = ($this->plugin ? $this->plugin . '.' : '') . $this->name;

$parser = new ConsoleOptionParser($name);

$bakeThemes = [];

foreach (Plugin::loaded() as $plugin) {

$path = Plugin::classPath($plugin);

if (is_dir($path . 'Template' . DS . 'Bake')) {

$bakeThemes[] = $plugin;

}

$parser->description(

'Bake migration class.'

)->addOption('plugin', [

'short' => 'p',

'help' => 'Plugin to bake into.'

])->addOption('force', [

'short' => 'f',

'boolean' => true,

'help' => 'Force overwriting existing files without prompting.'

])->addOption('connection', [

'short' => 'c',

'default' => 'default',

'help' => 'The datasource connection to get data from.'

])->addOption('theme', [

'short' => 't',

'help' => 'The theme to use when baking code.',

'choices' => $bakeThemes

]);

return $parser;

}

The same options were also defined SimpleBakeTask, parent class. Well, --plugin and -p is the same meaning, which specify plugin name.

Now, let’s look at predefined migration format.

/**
* Detects the action and table from the name of a migration
*
* @param string $name Name of migration
* @return array
**/
public function detectAction($name)
{
if (preg_match('/^(Create|Drop)(.*)/', $name, $matches)) {
$action = strtolower($matches[1]) . '_table';
$table = Inflector::tableize(Inflector::pluralize($matches[2]));
} elseif (preg_match('/^(Add).*(?:To)(.*)/', $name, $matches)) {
$action = 'add_field';
$table = Inflector::tableize(Inflector::pluralize($matches[2]));
} elseif (preg_match('/^(Remove).*(?:From)(.*)/', $name, $matches)) {
$action = 'drop_field';
$table = Inflector::tableize(Inflector::pluralize($matches[2]));
} elseif (preg_match('/^(Alter)(.*)/', $name, $matches)) {
$action = 'alter_table';
$table = Inflector::tableize(Inflector::pluralize($matches[2]));
} else {
return null;
}
return [$action, $table];
}

/**

* Detects the action and table from the name of a migration

* @param string $name Name of migration

* @return array

**/

public function detectAction($name)

{

if (preg_match('/^(Create|Drop)(.*)/', $name, $matches)) {

$action = strtolower($matches[1]) . '_table';

$table = Inflector::tableize(Inflector::pluralize($matches[2]));

} elseif (preg_match('/^(Add).*(?:To)(.*)/', $name, $matches)) {

$action = 'add_field';

$table = Inflector::tableize(Inflector::pluralize($matches[2]));

} elseif (preg_match('/^(Remove).*(?:From)(.*)/', $name, $matches)) {

$action = 'drop_field';

$table = Inflector::tableize(Inflector::pluralize($matches[2]));

} elseif (preg_match('/^(Alter)(.*)/', $name, $matches)) {

$action = 'alter_table';

$table = Inflector::tableize(Inflector::pluralize($matches[2]));

} else {

return null;

}

return [$action, $table];

}

From the above, it is clear that CreateTable, DropTable, AddColumnToTable, RemoveColumnFromTable and AlterTable patterns are predefined. If command doesn’t match any predefined format, blank migration file will be created, so you should add necessary procedure.

migration_snapshot

php bin/cake.php bake migration_snapshot snapshot_name generate a snapshot of table schemes as migration code.

Adding option require-table, generate snapshot for only tables with Table class. As default, generate snapshot for tables in the database.

It is clear if you try. Or, reading Template/Bake/config/snapshot.php helps your understanding.

Command available in migrations

Let’s see command used in the following.

php bin/cake.php migrations COMMAND

1	php bin/cake.php migrations COMMAND

It is defined by files in Command directory.

migrate

Execute migration. Specify migration version with target option, and only the specified version will be migrated.

rollback

Rollback the last executed migration or specified migration with target option.

status

List migrations with status which reveals being already migrated or not.

mark_migrated

Make migration with given version as executed.

php bin/cake.php migrations mark_migrated VERSION

1	php bin/cake.php migrations mark_migrated VERSION

Migration of CakePHP 3 is wrapper of phinx, so we should look into phinx to understand detail. It is really difficult.

The Life

CakePHP 3 migration command

Environment

Task executed by bake

migration

migration_snapshot

Command available in migrations

migrate

rollback

status

mark_migrated

Related Posts

Readers who viewed this page, also viewed:

A Life Summary of an Gypsy