Skip to content

MigrationHelper ​

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\MigrationHelper
Since
3.0.0

Migration utility methods.

View source

Public Methods ​

MethodDescription
doesForeignKeyExist()Returns whether a foreign key exists.
doesIndexExist()Returns whether an index exists.
dropAllForeignKeysOnTable()Drops all the foreign keys on a table.
dropAllForeignKeysToTable()Drops all the foreign keys that reference a table.
dropAllIndexesOnTable()Drops all the indexes on a table.
dropAllUniqueIndexesOnTable()Drops all the unique indexes on a table.
dropForeignKey()Drops a foreign key.
dropForeignKeyIfExists()Drops a foreign key if it exists.
dropIndex()Drops an index.
dropIndexIfExists()Drops an index if it exists.
dropTable()Drops a table, its own foreign keys, and any foreign keys referencing it.
findForeignKey()Returns whether a foreign key exists.
findForeignKeysTo()Returns a list of all the foreign keys that point to a given table/column.
renameColumn()Renames a column, while also updating any index and FK names that use the column.
renameTable()Renames a table, while also updating its sequence, index, and FK names, as well as any other FK names pointing to the table.
restoreForeignKey()Restores a foreign key.
restoreIndex()Restores an index.

doesForeignKeyExist() ​

Returns whether a foreign key exists.

View source

Arguments ​

Returns ​

boolean

doesIndexExist() ​

Returns whether an index exists.

View source

Arguments ​

Returns ​

boolean

dropAllForeignKeysOnTable() ​

Drops all the foreign keys on a table.

View source

Arguments ​

Returns ​

array – An array of the foreign keys that were just dropped.

dropAllForeignKeysToTable() ​

Drops all the foreign keys that reference a table.

View source

Arguments ​

Throws ​

dropAllIndexesOnTable() ​

Drops all the indexes on a table.

View source

Arguments ​

Returns ​

array – An array of the indexes that were just dropped.

dropAllUniqueIndexesOnTable() ​

DEPRECATED

Deprecated in 3.1.0

Drops all the unique indexes on a table.

View source

Arguments ​

dropForeignKey() ​

Drops a foreign key.

View source

Arguments ​

dropForeignKeyIfExists() ​

Drops a foreign key if it exists.

View source

Arguments ​

dropIndex() ​

DEPRECATED

Deprecated in 3.1.0. Use dropIndexIfExists() instead.

Drops an index.

View source

Arguments ​

dropIndexIfExists() ​

Drops an index if it exists.

View source

Arguments ​

dropTable() ​

Drops a table, its own foreign keys, and any foreign keys referencing it.

View source

Arguments ​

findForeignKey() ​

Since
3.0.27

Returns whether a foreign key exists.

View source

Arguments ​

Returns ​

string, null – The foreign key name, or null if it doesn't exist

Throws ​

findForeignKeysTo() ​

Returns a list of all the foreign keys that point to a given table/column.

View source

Arguments ​

  • $tableName (string) – The table the foreign keys should point to.
  • $column (string) – The column the foreign keys should point to. Defaults to 'id'.

Returns ​

array – A list of the foreign keys pointing to that table/column.

renameColumn() ​

Renames a column, while also updating any index and FK names that use the column.

View source

Arguments ​

renameTable() ​

Renames a table, while also updating its sequence, index, and FK names, as well as any other FK names pointing to the table.

View source

Arguments ​

Throws ​

restoreForeignKey() ​

DEPRECATED

Deprecated in 3.1.0

Restores a foreign key.

View source

Arguments ​

restoreIndex() ​

DEPRECATED

Deprecated in 3.1.0

Restores an index.

View source

Arguments ​