console-migrate.md 11.7 KB
Newer Older
Alexander Makarov committed
1 2 3
Database Migration
==================

Larry Ullman committed
4 5
Like source code, the structure of a database evolves as a database-driven application is developed and maintained. For example, during development, a new table may be added; Or, after the application goes live, it may be discovered that an additional index is required. It is important to keep track of these structural database changes (called **migration**), just as changes to the source code is tracked using version control. If the source code and the database become out of sync, bugs will occur, or the whole application might break. For this reason, Yii provides a database migration
tool that can keep track of database migration history, apply new migrations, or revert existing ones.
Alexander Makarov committed
6

Larry Ullman committed
7
The following steps show how database migration is used by a team during development:
Alexander Makarov committed
8

Larry Ullman committed
9 10 11 12
1. Tim creates a new migration (e.g. creates a new table, changes a column definition, etc.).
2. Tim commits the new migration into the source control system (e.g. Git, Mercurial).
3. Doug updates his repository from the source control system and receives the new migration.
4. Doug applies the migration to his local development database, thereby syncing his database to reflect the changes Tim made.
Alexander Makarov committed
13

Larry Ullman committed
14
Yii supports database migration via the `yii migrate` command line tool. This tool supports:
Alexander Makarov committed
15

Larry Ullman committed
16 17 18
* Creating new migrations
* Applying, reverting, and redoing migrations
* Showing migration history and new migrations
Alexander Makarov committed
19 20 21 22

Creating Migrations
-------------------

Larry Ullman committed
23
To create a new migration, run the following command:
Alexander Makarov committed
24

25
```
26
yii migrate/create <name>
27
```
Alexander Makarov committed
28

Larry Ullman committed
29
The required `name` parameter specifies a very brief description of the migration. For example, if the migration creates a new table named *news*, you'd use the command:
Alexander Makarov committed
30

31
```
32
yii migrate/create create_news_table
33
```
Alexander Makarov committed
34

Larry Ullman committed
35 36 37 38 39 40
As you'll shortly see, the `name` parameter
is used as part of a PHP class name in the migration. Therefore, it should only contain letters,
digits and/or underscore characters.

The above command will create a new
file named `m101129_185401_create_news_table.php`. This file will be created within the `protected/migrations` directory. Initially, the migration file will be generated with the following code:
Alexander Makarov committed
41

42
```php
Alexander Makarov committed
43 44 45 46 47 48 49 50 51 52 53 54
class m101129_185401_create_news_table extends \yii\db\Migration
{
	public function up()
	{
	}

	public function down()
	{
		echo "m101129_185401_create_news_table cannot be reverted.\n";
		return false;
	}
}
55
```
Alexander Makarov committed
56

Larry Ullman committed
57 58 59 60 61 62
Notice that the class name is the same as the file name, and follows the pattern
`m<timestamp>_<name>`, where:

* `<timestamp>` refers to the UTC timestamp (in the
format of `yymmdd_hhmmss`) when the migration is created,
* `<name>` is taken from the command's `name` parameter.
Alexander Makarov committed
63

Larry Ullman committed
64 65
In the class, the `up()` method should contain the code implementing the actual database
migration. In other words, the `up()` method executes code that actually changes the database. The `down()` method may contain code that reverts the changes made by `up()`.
Alexander Makarov committed
66

Larry Ullman committed
67 68 69 70
Sometimes, it is impossible for the `down()` to undo the database migration. For example, if the migration deletes
table rows or an entire table, that data cannot be recovered in the `down()` method. In such
cases, the migration is called irreversible, meaning the database cannot be rolled back to
a previous state. When a migration is irreversible, as in the above generated code, the `down()`
Alexander Makarov committed
71 72 73 74
method returns `false` to indicate that the migration cannot be reverted.

As an example, let's show the migration about creating a news table.

75
```php
Mark committed
76 77 78

use yii\db\Schema;

Alexander Makarov committed
79 80 81 82
class m101129_185401_create_news_table extends \yii\db\Migration
{
	public function up()
	{
Mark committed
83
		$this->createTable('tbl_news', [
Alexander Makarov committed
84
			'id' => 'pk',
Mark committed
85 86 87
			'title' => Schema::TYPE_STRING . ' NOT NULL',
			'content' => Schema::TYPE_TEXT,
		]);
Alexander Makarov committed
88 89 90 91
	}

	public function down()
	{
Mark committed
92
		$this->dropTable('tbl_news');
Alexander Makarov committed
93
	}
Mark committed
94

Alexander Makarov committed
95
}
96
```
Alexander Makarov committed
97 98 99 100

The base class [\yii\db\Migration] exposes a database connection via `db`
property. You can use it for manipulating data and schema of a database.

101 102 103 104 105 106 107
The column types used in this example are abstract types that will be replaced
by Yii with the corresponding types depended on your database management system.
You can use them to write database independent migrations.
For example `pk` will be replaced by `int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY`
for MySQL and `integer PRIMARY KEY AUTOINCREMENT NOT NULL` for sqlite.
See documentation of [[QueryBuilder::getColumnType()]] for more details and a list
of available types. You may also use the constants defined in [[\yii\db\Schema]] to
108
define column types.
109 110


Alexander Makarov committed
111 112 113 114 115 116
Transactional Migrations
------------------------

While performing complex DB migrations, we usually want to make sure that each
migration succeed or fail as a whole so that the database maintains the
consistency and integrity. In order to achieve this goal, we can exploit
Mark committed
117
DB transactions. We could use special methods `safeUp` and `safeDown` for these purposes.
Alexander Makarov committed
118

119
```php
Mark committed
120 121 122

use yii\db\Schema;

Alexander Makarov committed
123 124
class m101129_185401_create_news_table extends \yii\db\Migration
{
Mark committed
125
	public function safeUp()
Alexander Makarov committed
126
	{
Mark committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
		$this->createTable('tbl_news', [
			'id' => 'pk',
			'title' => Schema::TYPE_STRING . ' NOT NULL',
			'content' => Schema::TYPE_TEXT,
		]);

		$this->createTable('tbl_user', [
			'id' => 'pk',
			'login' => Schema::TYPE_STRING . ' NOT NULL',
			'password' => Schema::TYPE_STRING . ' NOT NULL',
		]);
	}

	public function safeDown()
	{
		$this->dropTable('tbl_news);
		$this->dropTable('tbl_user');
Alexander Makarov committed
144 145 146
	}

}
147
```
Alexander Makarov committed
148

Mark committed
149 150
When your code uses more then one query it is recommended to use `safeUp` and `safeDown`.

Alexander Makarov committed
151 152 153 154 155 156 157 158 159 160 161 162
> Note: Not all DBMS support transactions. And some DB queries cannot be put
> into a transaction. In this case, you will have to implement `up()` and
> `down()`, instead. And for MySQL, some SQL statements may cause
> [implicit commit](http://dev.mysql.com/doc/refman/5.1/en/implicit-commit.html).


Applying Migrations
-------------------

To apply all available new migrations (i.e., make the local database up-to-date),
run the following command:

163
```
164
yii migrate
165
```
Alexander Makarov committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179

The command will show the list of all new migrations. If you confirm to apply
the migrations, it will run the `up()` method in every new migration class, one
after another, in the order of the timestamp value in the class name.

After applying a migration, the migration tool will keep a record in a database
table named `tbl_migration`. This allows the tool to identify which migrations
have been applied and which are not. If the `tbl_migration` table does not exist,
the tool will automatically create it in the database specified by the `db`
application component.

Sometimes, we may only want to apply one or a few new migrations. We can use the
following command:

180
```
181
yii migrate/up 3
182
```
Alexander Makarov committed
183 184 185 186 187 188

This command will apply the 3 new migrations. Changing the value 3 will allow
us to change the number of migrations to be applied.

We can also migrate the database to a specific version with the following command:

189
```
190
yii migrate/to 101129_185401
191
```
Alexander Makarov committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205

That is, we use the timestamp part of a migration name to specify the version
that we want to migrate the database to. If there are multiple migrations between
the last applied migration and the specified migration, all these migrations
will be applied. If the specified migration has been applied before, then all
migrations applied after it will be reverted (to be described in the next section).


Reverting Migrations
--------------------

To revert the last one or several applied migrations, we can use the following
command:

206
```
207
yii migrate/down [step]
208
```
Alexander Makarov committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222

where the optional `step` parameter specifies how many migrations to be reverted
back. It defaults to 1, meaning reverting back the last applied migration.

As we described before, not all migrations can be reverted. Trying to revert
such migrations will throw an exception and stop the whole reverting process.


Redoing Migrations
------------------

Redoing migrations means first reverting and then applying the specified migrations.
This can be done with the following command:

223
```
224
yii migrate/redo [step]
225
```
Alexander Makarov committed
226 227 228 229 230 231 232 233 234 235 236

where the optional `step` parameter specifies how many migrations to be redone.
It defaults to 1, meaning redoing the last migration.


Showing Migration Information
-----------------------------

Besides applying and reverting migrations, the migration tool can also display
the migration history and the new migrations to be applied.

237
```
238 239
yii migrate/history [limit]
yii migrate/new [limit]
240
```
Alexander Makarov committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

where the optional parameter `limit` specifies the number of migrations to be
displayed. If `limit` is not specified, all available migrations will be displayed.

The first command shows the migrations that have been applied, while the second
command shows the migrations that have not been applied.


Modifying Migration History
---------------------------

Sometimes, we may want to modify the migration history to a specific migration
version without actually applying or reverting the relevant migrations. This
often happens when developing a new migration. We can use the following command
to achieve this goal.

257
```
258
yii migrate/mark 101129_185401
259
```
Alexander Makarov committed
260

261
This command is very similar to `yii migrate/to` command, except that it only
Alexander Makarov committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
modifies the migration history table to the specified version without applying
or reverting the migrations.


Customizing Migration Command
-----------------------------

There are several ways to customize the migration command.

### Use Command Line Options

The migration command comes with four options that can be specified in command
line:

* `interactive`: boolean, specifies whether to perform migrations in an
  interactive mode. Defaults to true, meaning the user will be prompted when
  performing a specific migration. You may set this to false should the
  migrations be done in a background process.

* `migrationPath`: string, specifies the directory storing all migration class
  files. This must be specified in terms of a path alias, and the corresponding
  directory must exist. If not specified, it will use the `migrations`
  sub-directory under the application base path.

* `migrationTable`: string, specifies the name of the database table for storing
  migration history information. It defaults to `tbl_migration`. The table
  structure is `version varchar(255) primary key, apply_time integer`.

* `connectionID`: string, specifies the ID of the database application component.
  Defaults to 'db'.

* `templateFile`: string, specifies the path of the file to be served as the code
  template for generating the migration classes. This must be specified in terms
  of a path alias (e.g. `application.migrations.template`). If not set, an
  internal template will be used. Inside the template, the token `{ClassName}`
  will be replaced with the actual migration class name.

To specify these options, execute the migrate command using the following format

301
```
302
yii migrate/up --option1=value1 --option2=value2 ...
303
```
Alexander Makarov committed
304 305 306 307 308

For example, if we want to migrate for a `forum` module whose migration files
are located within the module's `migrations` directory, we can use the following
command:

309
```
Vladimir committed
310
yii migrate/up --migrationPath=@app/modules/forum/migrations
311
```
Alexander Makarov committed
312 313 314 315 316 317 318 319 320 321 322


### Configure Command Globally

While command line options allow us to configure the migration command
on-the-fly, sometimes we may want to configure the command once for all.
For example, we may want to use a different table to store the migration history,
or we may want to use a customized migration template. We can do so by modifying
the console application's configuration file like the following,

```php
Mark committed
323 324 325 326 327 328
'controllerMap' => [
    'migrate' => [
        'class' => 'yii\console\MigrateController',
        'migrationTable' => 'my_custom_migrate_table',
    ],
]
Alexander Makarov committed
329 330 331
```

Now if we run the `migrate` command, the above configurations will take effect
Mark committed
332 333
without requiring us to enter the command line options every time. Other command options
can be also configured this way.