Laravel 數據遷移文件常用方法速查表
一、存儲引擎、字符編碼相關操作
命令 | 描述 |
---|---|
$table->engine = ‘InnoDB‘; |
指定表的存儲引擎(MySQL) |
$table->charset = ‘utf8‘; |
指定數據表的默認字符集(MySQL) |
$table->collation = ‘utf8_unicode_ci‘; |
指定數據表的字符序(MySQL) |
$table->temporary(); |
創建臨時表(除SQL Server) |
二、可用的數據列類型
命令 | 描述 |
---|---|
$table->bigIncrements(‘id‘); |
等同於自增 UNSIGNED BIGINT(主鍵)列 |
$table->bigInteger(‘votes‘); |
等同於 BIGINT 類型列 |
$table->binary(‘data‘); |
等同於 BLOB 類型列 |
$table->boolean(‘confirmed‘); |
等同於 BOOLEAN 類型列 |
$table->char(‘name‘, 4); |
等同於 CHAR 類型列 |
$table->date(‘created_at‘); |
等同於 DATE 類型列 |
$table->dateTime(‘created_at‘); |
等同於 DATETIME 類型列 |
$table->dateTimeTz(‘created_at‘); |
等同於 DATETIME 類型(帶時區)列 |
$table->decimal(‘amount‘, 5, 2); |
等同於 DECIMAL 類型列,帶精度和範圍 |
$table->double(‘column‘, 15, 8); |
等同於 DOUBLE 類型列,帶精度, 總共15位數字,小數點後8位 |
$table->enum(‘level‘, [‘easy‘, ‘hard‘]); |
等同於 ENUM 類型列 |
$table->float(‘amount‘, 8, 2); |
等同於 FLOAT 類型列,帶精度和總位數 |
$table->geometry(‘positions‘); |
等同於 GEOMETRY 類型列 |
$table->geometryCollection(‘positions‘); |
等同於 GEOMETRYCOLLECTION 類型列 |
$table->increments(‘id‘); |
等同於自增 UNSIGNED INTEGER (主鍵)類型列 |
$table->integer(‘votes‘); |
等同於 INTEGER 類型列 |
$table->ipAddress(‘visitor‘); |
等同於 IP 地址類型列 |
$table->json(‘options‘); |
等同於 JSON 類型列 |
$table->jsonb(‘options‘); |
等同於 JSONB 類型列 |
$table->lineString(‘positions‘); |
等同於 LINESTRING 類型列 |
$table->longText(‘description‘); |
等同於 LONGTEXT 類型列 |
$table->macAddress(‘device‘); |
等同於 MAC 地址類型列 |
$table->mediumIncrements(‘id‘); |
等同於自增 UNSIGNED MEDIUMINT 類型列(主鍵) |
$table->mediumInteger(‘numbers‘); |
等同於 MEDIUMINT 類型列 |
$table->mediumText(‘description‘); |
等同於 MEDIUMTEXT 類型列 |
$table->morphs(‘taggable‘); |
添加一個 UNSIGNED INTEGER 類型的 taggable_id 列和一個 VARCHAR 類型的 taggable_type 列 |
$table->multiLineString(‘positions‘); |
等同於 MULTILINESTRING 類型列 |
$table->multiPoint(‘positions‘); |
等同於 MULTIPOINT 類型列 |
$table->multiPolygon(‘positions‘); |
等同於 MULTIPOLYGON 類型列 |
$table->nullableMorphs(‘taggable‘); |
morphs() 列的 nullable 版本 |
$table->nullableTimestamps(); |
timestamps() 的別名 |
$table->point(‘position‘); |
等同於 POINT 類型列 |
$table->polygon(‘positions‘); |
等同於 POLYGON 類型列 |
$table->rememberToken(); |
等同於添加一個允許為空的 remember_token VARCHAR(100) 列 |
$table->smallIncrements(‘id‘); |
等同於自增 UNSIGNED SMALLINT (主鍵)類型列 |
$table->smallInteger(‘votes‘); |
等同於 SMALLINT 類型列 |
$table->softDeletes(); |
新增一個允許為空的 deleted_at TIMESTAMP 列用於軟刪除 |
$table->softDeletesTz(); |
新增一個允許為空的 deleted_at TIMESTAMP (帶時區)列用於軟刪除 |
$table->string(‘name‘, 100); |
等同於 VARCHAR 類型列,帶一個可選長度參數 |
$table->text(‘description‘); |
等同於 TEXT 類型列 |
$table->time(‘sunrise‘); |
等同於 TIME 類型列 |
$table->timeTz(‘sunrise‘); |
等同於 TIME 類型(帶時區) |
$table->timestamp(‘added_on‘); |
等同於 TIMESTAMP 類型列 |
$table->timestampTz(‘added_on‘); |
等同於 TIMESTAMP 類型(帶時區)列 |
$table->timestamps(); |
添加允許為空的 created_at 和 updated_at TIMESTAMP 類型列 |
$table->timestampsTz(); |
添加允許為空的 created_at 和 updated_at TIMESTAMP 類型列(帶時區) |
$table->tinyIncrements(‘numbers‘); |
等同於自增的 UNSIGNED TINYINT 類型列(主鍵) |
$table->tinyInteger(‘numbers‘); |
等同於 TINYINT 類型列 |
$table->unsignedBigInteger(‘votes‘); |
等同於無符號的 BIGINT 類型列 |
$table->unsignedDecimal(‘amount‘, 8, 2); |
等同於 UNSIGNED DECIMAL 類型列,帶有總位數和精度 |
$table->unsignedInteger(‘votes‘); |
等同於無符號的 INTEGER 類型列 |
$table->unsignedMediumInteger(‘votes‘); |
等同於無符號的 MEDIUMINT 類型列 |
$table->unsignedSmallInteger(‘votes‘); |
等同於無符號的 SMALLINT 類型列 |
$table->unsignedTinyInteger(‘votes‘); |
等同於無符號的 TINYINT 類型列 |
$table->uuid(‘id‘); |
等同於 UUID 類型列 |
$table->year(‘birth_year‘); |
等同於 YEAR 類型列 |
三、列修改器(不包含索引修改器)
修改器 | 描述 |
---|---|
->after(‘column‘) |
將該列置於另一個列之後 (MySQL) |
->autoIncrement() |
設置 INTEGER 列為自增主鍵 |
->charset(‘utf8‘) |
指定數據列字符集(MySQL) |
->collation(‘utf8_unicode_ci‘) |
指定數據列字符序(MySQL/SQL Server) |
->comment(‘my comment‘) |
添加註釋信息 |
->default($value) |
指定列的默認值 |
->first() |
將該列置為表中第一個列 (MySQL) |
->nullable($value = true) |
允許該列的值為 NULL |
->storedAs($expression) |
創建一個存儲生成列(MySQL) |
->unsigned() |
設置 INTEGER 列為 UNSIGNED(MySQL) |
->useCurrent() |
設置 TIMESTAMP 列使用 CURRENT_TIMESTAMP 作為默認值 |
->virtualAs($expression) |
創建一個虛擬生成列(MySQL) |
四、可用索引類型
命令 | 描述 |
---|---|
$table->primary(‘id‘); |
添加主鍵索引 |
$table->primary([‘id‘, ‘parent_id‘]); |
添加組合索引 |
$table->unique(‘email‘); |
添加唯一索引 |
$table->index(‘state‘); |
添加普通索引 |
$table->spatialIndex(‘location‘); |
添加空間索引(不支持SQLite) |
五、修改數據列
先決條件
在修改列之前,確保已經將 doctrine/dbal
依賴添加到 composer.json
文件,Doctrine DBAL 庫用於判斷列的當前狀態並創建對列進行指定調整所需的 SQL 語句:
composer require doctrine/dbal
更新列屬性
change
方法允許你修改已存在的列為新的類型,或者修改列的屬性。例如,你可能想要增加 字符串類型列的尺寸,下面讓我們將 name
列的尺寸從 25 增加到 50:
Schema::table(‘users‘, function (Blueprint $table) { $table->string(‘name‘, 50)->change(); });
我們還可以修改該列允許 NULL 值:
Schema::table(‘users‘, function (Blueprint $table) { $table->string(‘name‘, 50)->nullable()->change(); });
註:只有以下數據列類型能修改:bigInteger
, binary
, boolean
, date
, dateTime
, dateTimeTz
, decimal
, integer
, json
, longText
, mediumText
, smallInteger
, string
, text
, time
, unsignedBigInteger
, unsignedInteger
和 unsignedSmallInteger
。
重命名列
要重命名一個列,可以使用表結構構建器上的 renameColumn
方法,在重命名一個列之前,確保 doctrine/dbal
依賴已經添加到 composer.json
文件並且已經運行了 composer update
命令:
Schema::table(‘users‘, function (Blueprint $table) { $table->renameColumn(‘from‘, ‘to‘); });
註:暫不支持 enum
類型的列的修改和重命名。
刪除數據列
要刪除一個列,使用 Schema 構建器上的 dropColumn
方法,同樣,在此之前,確保已經安裝了 doctrine/dbal
依賴:
Schema::table(‘users‘, function (Blueprint $table) { $table->dropColumn(‘votes‘); });
你可以通過傳遞列名數組到 dropColumn
方法以便可以一次從數據表中刪除多個列:
Schema::table(‘users‘, function (Blueprint $table) { $table->dropColumn([‘votes‘, ‘avatar‘, ‘location‘]); });
註:SQLite 數據庫暫不支持在單個遷移中刪除或修改多個列。
有效的命令別名
命令 | 描述 |
---|---|
$table->dropRememberToken(); |
刪除 remember_token 列 |
$table->dropSoftDeletes(); |
刪除 deleted_at 列 |
$table->dropSoftDeletesTz(); |
dropSoftDeletes() 方法別名 |
$table->dropTimestamps(); |
刪除 created_at 和 updated_at 列 |
$table->dropTimestampsTz(); |
dropTimestamps() 方法別名 |
重命名索引
要重命名一個索引,可以使用 renameIndex
方法,這個方法接收當前索引名作為第一個參數以及修改後的索引名作為第二個參數:
$table->renameIndex(‘from‘, ‘to‘);
刪除索引
要刪除索引,必須指定索引名。默認情況下,Laravel 自動分配適當的名稱給索引 —— 連接表名、列名和索引類型。
命令 | 描述 |
---|---|
$table->dropPrimary(‘users_id_primary‘); |
從 “users” 表中刪除主鍵索引 |
$table->dropUnique(‘users_email_unique‘); |
從 “users” 表中刪除唯一索引 |
$table->dropIndex(‘geo_state_index‘); |
從 “geo” 表中刪除普通索引 |
$table->dropSpatialIndex(‘geo_location_spatialindex‘); |
從 “geo” 表中刪除空間索引(不支持SQLite) |
如果要傳遞數據列數組到刪除索引方法,那麽相應的索引名稱將會通過數據表名、列和鍵類型來自動生成:
Schema::table(‘geo‘, function (Blueprint $table) { $table->dropIndex([‘state‘]); // Drops index ‘geo_state_index‘ });
六、其他操作
檢查表/列是否存在
使用 hasTable
和 hasColumn
方法檢查表或列是否存在:
if (Schema::hasTable(‘users‘)) { // } if (Schema::hasColumn(‘users‘, ‘email‘)) { // }
數據庫連接 & 表選項
想要在一個數據庫連接上執行表結構操作,而該數據庫連接並不是默認數據庫連接,可以使用 connection
方法:
Schema::connection(‘foo‘)->create(‘users‘, function (Blueprint $table) { $table->increments(‘id‘); });
重命名/刪除表
要重命名一個已存在的數據表,使用 rename
方法:
Schema::rename($from, $to);
要刪除一個已存在的數據表,可以使用 drop
或 dropIfExists
方法:
Schema::drop(‘users‘);
Schema::dropIfExists(‘users‘);
Laravel 數據遷移文件常用方法速查表