migration.md 11 KB
Newer Older
Alexander Makarov committed
1 2 3
Database Migration
==================

Alexander Makarov committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
Like source code, the structure of a database is evolving as we develop and maintain
a database-driven application. For example, during development, we may want to
add a new table; or after the application is put into production, we may realize
the need of adding an index on a column. It is important to keep track of these
structural database changes (called **migration**) like we do with our source
code. If the source code and the database are out of sync, it is very likely
the whole system may 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.

The following steps show how we can use database migration during development:

1. Tim creates a new migration (e.g. create a new table)
2. Tim commits the new migration into source control system (e.g. GIT, Mercurial)
3. Doug updates from source control system and receives the new migration
4. Doug applies the migration to his local development database


22
Yii supports database migration via the `yii migrate` command line tool. This
Alexander Makarov committed
23 24 25 26 27 28 29 30
tool supports creating new migrations, applying/reverting/redoing migrations, and
showing migration history and new migrations.

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

To create a new migration (e.g. create a news table), we run the following command:

31
```
32
yii migrate/create <name>
33
```
Alexander Makarov committed
34 35 36 37 38 39

The required `name` parameter specifies a very brief description of the migration
(e.g. `create_news_table`). As we will show in the following, the `name` parameter
is used as part of a PHP class name. Therefore, it should only contain letters,
digits and/or underscore characters.

40
```
41
yii migrate/create create_news_table
42
```
Alexander Makarov committed
43 44 45 46 47

The above command will create under the `protected/migrations` directory a new
file named `m101129_185401_create_news_table.php` which contains the following
initial code:

48
```php
Alexander Makarov committed
49 50 51 52 53 54 55 56 57 58 59 60
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;
	}
}
61
```
Alexander Makarov committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

Notice that the class name is the same as the file name which is of the pattern
`m<timestamp>_<name>`, where `<timestamp>` refers to the UTC timestamp (in the
format of `yymmdd_hhmmss`) when the migration is created, and `<name>` is taken
from the command's `name` parameter.

The `up()` method should contain the code implementing the actual database
migration, while the `down()` method may contain the code reverting what is
done in `up()`.

Sometimes, it is impossible to implement `down()`. For example, if we delete
table rows in `up()`, we will not be able to recover them in `down()`. In this
case, the migration is called irreversible, meaning we cannot roll back to
a previous state of the database. In the above generated code, the `down()`
method returns `false` to indicate that the migration cannot be reverted.

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

80
```php
Alexander Makarov committed
81 82 83 84
class m101129_185401_create_news_table extends \yii\db\Migration
{
	public function up()
	{
85
		$this->db->createCommand()->createTable('tbl_news', array(
Alexander Makarov committed
86
			'id' => 'pk',
87
			'title' => 'string(128) NOT NULL',
Alexander Makarov committed
88 89 90 91 92 93 94 95 96
			'content' => 'text',
		))->execute();
	}

	public function down()
	{
		$this->db->createCommand()->dropTable('tbl_news')->execute();
	}
}
97
```
Alexander Makarov committed
98 99 100 101

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.

102 103 104 105 106 107 108
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
109
define column types.
110 111


Alexander Makarov committed
112 113 114 115 116 117 118 119 120 121 122
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
DB transactions.

We could explicitly start a DB transaction and enclose the rest of the DB-related
code within the transaction, like the following:

123
```php
Alexander Makarov committed
124 125 126 127 128 129 130
class m101129_185401_create_news_table extends \yii\db\Migration
{
	public function up()
	{
		$transaction=$this->getDbConnection()->beginTransaction();
		try
		{
131
			$this->db->createCommand()->createTable('tbl_news', array(
Alexander Makarov committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
				'id' => 'pk',
				'title' => 'string NOT NULL',
				'content' => 'text',
			))->execute();
			$transaction->commit();
		}
		catch(Exception $e)
		{
			echo "Exception: ".$e->getMessage()."\n";
			$transaction->rollback();
			return false;
		}
	}

	// ...similar code for down()
}
148
```
Alexander Makarov committed
149 150 151 152 153 154 155 156 157 158 159 160 161

> 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:

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

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:

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

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:

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

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:

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

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:

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

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.

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

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.

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

260
This command is very similar to `yii migrate/to` command, except that it only
Alexander Makarov committed
261 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
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

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

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:

308
```
309
yii migrate/up --migrationPath=ext.forum.migrations
310
```
Alexander Makarov committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326


### 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
TBD
```

Now if we run the `migrate` command, the above configurations will take effect
without requiring us to enter the command line options every time.