Class craft\migrations\Install

Inheritance: craft\migrations\Install » craft\db\Migration » yii\db\Migration » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable, yii\db\MigrationInterface
Uses Traits: yii\db\SchemaBuilderTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/migrations/Install.php

Installation Migration

Public Properties
Property	Type	Description	Defined By
`$compact`	boolean	Indicates whether the console output should be compacted.	yii\db\Migration
`$db`	yii\db\Connection, array, string	The DB connection object or the application component ID of the DB connection that this migration should work with.	yii\db\Migration
`$email`	string, null	The admin user’s email	craft\migrations\Install
`$maxSqlOutputLength`	integer	Max number of characters of the SQL outputted.	yii\db\Migration
`$password`	string, null	The admin user’s password	craft\migrations\Install
`$site`	craft\models\Site, null	The default site	craft\migrations\Install
`$username`	string, null	The admin user’s username	craft\migrations\Install

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`addColumn()`	Builds and executes a SQL statement for adding a new DB column.	yii\db\Migration
`addCommentOnColumn()`	Builds and execute a SQL statement for adding comment to column.	yii\db\Migration
`addCommentOnTable()`	Builds a SQL statement for adding comment to table.	yii\db\Migration
`addForeignKey()`	Builds a SQL statement for adding a foreign key constraint to an existing table.	craft\db\Migration
`addForeignKeys()`	Adds the foreign keys.	craft\migrations\Install
`addPrimaryKey()`	Builds and executes a SQL statement for creating a primary key.	craft\db\Migration
`alterColumn()`	Builds and executes a SQL statement for changing the definition of a column.	yii\db\Migration
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`batchInsert()`	Creates and executes an batch INSERT SQL statement.	craft\db\Migration
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`bigInteger()`	Creates a bigint column.	yii\db\SchemaBuilderTrait
`bigPrimaryKey()`	Creates a big primary key column.	yii\db\SchemaBuilderTrait
`binary()`	Creates a binary column.	yii\db\SchemaBuilderTrait
`boolean()`	Creates a boolean column.	yii\db\SchemaBuilderTrait
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`char()`	Creates a char column.	yii\db\SchemaBuilderTrait
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`createIndex()`	Builds and executes a SQL statement for creating a new index.	craft\db\Migration
`createIndexes()`	Creates the indexes.	craft\migrations\Install
`createTable()`	Builds and executes a SQL statement for creating a new DB table.	yii\db\Migration
`createTables()`	Creates the tables.	craft\migrations\Install
`date()`	Creates a date column.	yii\db\SchemaBuilderTrait
`dateTime()`	Creates a datetime column.	yii\db\SchemaBuilderTrait
`decimal()`	Creates a decimal column.	yii\db\SchemaBuilderTrait
`delete()`	Creates and executes a DELETE SQL statement.	yii\db\Migration
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`double()`	Creates a double column.	yii\db\SchemaBuilderTrait
`down()`	This method contains the logic to be executed when removing this migration.	craft\db\Migration
`dropColumn()`	Builds and executes a SQL statement for dropping a DB column.	yii\db\Migration
`dropCommentFromColumn()`	Builds and execute a SQL statement for dropping comment from column.	yii\db\Migration
`dropCommentFromTable()`	Builds a SQL statement for dropping comment from table.	yii\db\Migration
`dropForeignKey()`	Builds a SQL statement for dropping a foreign key constraint.	yii\db\Migration
`dropIndex()`	Builds and executes a SQL statement for dropping an index.	yii\db\Migration
`dropPrimaryKey()`	Builds and executes a SQL statement for dropping a primary key.	yii\db\Migration
`dropTable()`	Builds and executes a SQL statement for dropping a DB table.	yii\db\Migration
`dropTableIfExists()`	Creates and executes a SQL statement for dropping a DB table, if it exists.	craft\db\Migration
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`enum()`	Creates an enum column for MySQL and PostgreSQL, or a string column with a check constraint for others.	craft\db\Migration
`execute()`	Executes a SQL statement.	yii\db\Migration
`float()`	Creates a float column.	yii\db\SchemaBuilderTrait
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`insert()`	Creates and executes an INSERT SQL statement.	craft\db\Migration
`insertDefaultData()`	Populates the DB with the default data.	craft\migrations\Install
`integer()`	Creates an integer column.	yii\db\SchemaBuilderTrait
`json()`	Creates a JSON column.	yii\db\SchemaBuilderTrait
`longText()`	Creates a longtext column for MySQL, or text column for others.	craft\db\Migration
`mediumText()`	Creates a mediumtext column for MySQL, or text column for others.	craft\db\Migration
`money()`	Creates a money column.	yii\db\SchemaBuilderTrait
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`primaryKey()`	Creates a primary key column.	yii\db\SchemaBuilderTrait
`renameColumn()`	Builds and executes a SQL statement for renaming a column.	yii\db\Migration
`renameSequence()`	Creates and executes a SQL statement for renaming a DB sequence.	craft\db\Migration
`renameTable()`	Builds and executes a SQL statement for renaming a DB table.	yii\db\Migration
`replace()`	Creates and executes a SQL statement for replacing some text with other text in a given table column.	craft\db\Migration
`safeDown()`	This method contains the logic to be executed when removing this migration.	craft\migrations\Install
`safeUp()`	This method contains the logic to be executed when applying this migration.	craft\migrations\Install
`smallInteger()`	Creates a smallint column.	yii\db\SchemaBuilderTrait
`string()`	Creates a string column.	yii\db\SchemaBuilderTrait
`text()`	Creates a text column.	yii\db\SchemaBuilderTrait
`time()`	Creates a time column.	yii\db\SchemaBuilderTrait
`timestamp()`	Creates a timestamp column.	yii\db\SchemaBuilderTrait
`tinyInteger()`	Creates a tinyint column. If tinyint is not supported by the DBMS, smallint will be used.	yii\db\SchemaBuilderTrait
`tinyText()`	Creates a tinytext column for MySQL, or text column for others.	craft\db\Migration
`trigger()`	Triggers an event.	yii\base\Component
`truncateTable()`	Builds and executes a SQL statement for truncating a DB table.	yii\db\Migration
`uid()`	Shortcut for creating a uid column	craft\db\Migration
`up()`	This method contains the logic to be executed when applying this migration.	craft\db\Migration
`update()`	Creates and executes an UPDATE SQL statement.	craft\db\Migration
`upsert()`	Creates and executes a command to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.	craft\db\Migration

Protected Methods
Method	Description	Defined By
`beginCommand()`	Prepares for a command to be executed, and outputs to the console.	yii\db\Migration
`endCommand()`	Finalizes after the command has been executed, and outputs to the console the time elapsed.	yii\db\Migration
`getDb()`		yii\db\SchemaBuilderTrait

Property Details

`$email` public property #

The admin user’s email

public string, null $email = null

`$password` public property #

The admin user’s password

public string, null $password = null

`$site` public property #

The default site

public craft\models\Site, null $site = null

`$username` public property #

The admin user’s username

public string, null $username = null

Method Details

`addForeignKeys()` public method #

Adds the foreign keys.

public void addForeignKeys ( )

`createIndexes()` public method #

Creates the indexes.

public void createIndexes ( )

`createTables()` public method #

Creates the tables.

public void createTables ( )

`insertDefaultData()` public method #

Populates the DB with the default data.

public void insertDefaultData ( )

`safeDown()` public method #

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

This method differs from down() in that the DB logic implemented here will be enclosed within a DB transaction. Child classes may implement this method instead of down() if the DB logic needs to be within a transaction.

Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples, please refer to implicit commit.

public boolean safeDown ( )

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

`safeUp()` public method #

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

This method differs from up() in that the DB logic implemented here will be enclosed within a DB transaction. Child classes may implement this method instead of up() if the DB logic needs to be within a transaction.

Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples, please refer to implicit commit.

public boolean safeUp ( )

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

Property Details

$email public property #

$password public property #

$site public property #

$username public property #

Method Details

addForeignKeys() public method #

createIndexes() public method #

createTables() public method #

insertDefaultData() public method #

safeDown() public method #

safeUp() public method #