W3cubDocs

/Yii 2.0

Interface yii\db\MigrationInterface

Implemented by yii\db\Migration, yii\mongodb\Migration
Available since version 2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/MigrationInterface.php

The MigrationInterface defines the minimum set of methods to be implemented by a database migration.

Each migration class should provide the up() method containing the logic for "upgrading" the database and the down() method for the "downgrading" logic.

Public Methods

Method Description Defined By
down() This method contains the logic to be executed when removing this migration. yii\db\MigrationInterface
up() This method contains the logic to be executed when applying this migration. yii\db\MigrationInterface

Method Details

down() public abstract method

This method contains the logic to be executed when removing this migration.

The default implementation throws an exception indicating the migration cannot be removed.

public abstract boolean down ( )
return boolean

Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds.

up() public abstract method

This method contains the logic to be executed when applying this migration.

public abstract boolean up ( )
return boolean

Return a false value to indicate the migration fails and should not proceed further. All other return values mean the migration succeeds.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-migrationinterface.html