laravel 使用schema構建器，新增構建表的列型別

helong3314發表於2021-02-27
Laravel型別

建立表

使用Schema門面上的create方法來建立新的資料表。create方法接收兩個引數，第一個是表名，第二個是獲取用於定義新表的Blueprint物件的閉包：

Schema::create('users', function ($table) {
    $table->increments('id');
});

當然，建立新表的時候，可以使用schema構建器中的任意列方法來定義資料表的列。

檢查表/列是否存在

你可以輕鬆地使用 hasTable 和 hasColumn 方法檢查表或列是否存在：

if (Schema::hasTable('users')) {
    //
}

if (Schema::hasColumn('users', 'email')) {
    //
}

連線&儲存引擎

如果你想要在一個資料庫連線上執行表結構操作，該資料庫連線並不是預設資料庫連線，使用connection方法：

Schema::connection('foo')->create('users', function ($table) {
    $table->increments('id');
});

要設定表的儲存引擎，在schema構建器上設定engine屬性：

Schema::create('users', function ($table) {
    $table->engine = 'InnoDB';
    $table->increments('id');
});

重新命名/刪除表

要重新命名一個已存在的資料表，使用rename方法：

Schema::rename($from, $to);

要刪除一個已存在的資料表，可以使用drop或dropIfExists方法：

Schema::drop('users');
Schema::dropIfExists('users');

透過外來鍵重新命名錶

在重新命名錶之前，需要驗證該表包含的外來鍵在遷移檔案中有明確的名字，而不是Laravel基於慣例分配的名字。否則，外來鍵約束名將會指向舊的資料表。

建立列

要更新一個已存在的表，使用Schema門面上的table方法，和create方法一樣，table方法接收兩個引數：表名和獲取用於新增列到表的Blueprint例項的閉包：

Schema::table('users', function ($table) {
    $table->string('email');
});

可用的列型別

當然，schema構建器包含一系列你可以用來構建表的列型別：

命令 描述

$table->bigIncrements('id');   自增ID，型別為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('choices', ['foo', 'bar']);   等同於資料庫中的 ENUM型別
$table->float('amount');   等同於資料庫中的 FLOAT 型別
$table->increments('id');  資料庫主鍵自增ID
$table->integer('votes');  等同於資料庫中的 INTEGER 型別
$table->ipAddress('visitor');  等同於資料庫中的 IP 地址
$table->json('options');   等同於資料庫中的 JSON 型別
$table->jsonb('options');  等同於資料庫中的 JSONB 型別
$table->longText('description');   等同於資料庫中的 LONGTEXT 型別
$table->macAddress('device');  等同於資料庫中的 MAC 地址
$table->mediumIncrements('id');    自增ID，型別為無符號的mediumint
$table->mediumInteger('numbers');  等同於資料庫中的 MEDIUMINT型別
$table->mediumText('description'); 等同於資料庫中的 MEDIUMTEXT型別
$table->morphs('taggable');    新增一個 INTEGER型別的 taggable_id 列和一個 STRING型別的 taggable_type列
$table->nullableTimestamps();  和 timestamps()一樣但允許 NULL值.
$table->rememberToken();   新增一個 remember_token 列： VARCHAR(100) NULL.
$table->smallIncrements('id'); 自增ID，型別為無符號的smallint
$table->smallInteger('votes'); 等同於資料庫中的 SMALLINT 型別
$table->softDeletes(); 新增一個 deleted_at 列 用於軟刪除.
$table->string('email');   等同於資料庫中的 VARCHAR 列  .
$table->string('name', 100);   等同於資料庫中的 VARCHAR，帶一個長度
$table->text('description');   等同於資料庫中的 TEXT 型別
$table->time('sunrise');   等同於資料庫中的 TIME型別
$table->timeTz('sunrise'); 等同於資料庫中的 TIME 型別（帶時區）
$table->tinyInteger('numbers');    等同於資料庫中的 TINYINT 型別
$table->timestamp('added_on'); 等同於資料庫中的 TIMESTAMP 型別
$table->timestampTz('added_on');   等同於資料庫中的 TIMESTAMP 型別（帶時區）
$table->timestamps();  新增 created_at 和 updated_at列
$table->timestampsTz();    新增 created_at 和 updated_at列（帶時區）
$table->unsignedBigInteger('votes');   等同於資料庫中無符號的 BIGINT 型別
$table->unsignedInteger('votes');  等同於資料庫中無符號的 INT 型別
$table->unsignedMediumInteger('votes');    等同於資料庫中無符號的 MEDIUMINT 型別
$table->unsignedSmallInteger('votes'); 等同於資料庫中無符號的 SMALLINT 型別
$table->unsignedTinyInteger('votes');  等同於資料庫中無符號的 TINYINT 型別
$table->uuid('id');    等同於資料庫的UUID

列修改器

除了上面列出的列型別之外，在新增列的時候還可以使用一些其它列“修改器”，例如，要使列預設為null，可以使用nullable方法：

Schema::table(‘users’, function (table) {table->string(‘email’)->nullable();
});
下面是所有可用的列修改器列表，該列表不包含索引修改器：

修改器 描述

->after('column')   將該列置於另一個列之後 (僅適用於MySQL)
->comment('my comment') 新增註釋資訊
->default($value)  指定列的預設值
->first()   將該列置為表中第一個列 (僅適用於MySQL)
->nullable()    允許該列的值為NULL
->storedAs($expression)    建立一個儲存生成列（只支援MySQL）
->unsigned()    設定 integer 列為 UNSIGNED
->virtualAs($expression)   建立一個虛擬生成列（只支援MySQL）

修改列

先決條件

在修改列之前，確保已經將doctrine/dbal依賴新增到composer.json檔案，Doctrine DBAL 庫用於判斷列的當前狀態並建立對列進行指定調整所需的SQL語句：

composer require doctrine/dbal

更新列屬性

change方法允許你修改已存在的列為新的型別，或者修改列的屬性。例如，你可能想要增加 string 型別列的尺寸，讓我們將name列的尺寸從 25 增加到 50：

Schema::table('users', function ($table) {
    $table->string('name', 50)->change();
});

我們還可以修改該列允許 NULL 值：

Schema::table('users', function ($table) {
    $table->string('name', 50)->nullable()->change();
});

重新命名列

要重新命名一個列，可以使用表結構構建器上的renameColumn方法，在重新命名一個列之前，確保doctrine/dbal依賴已經新增到composer.json檔案：

Schema::table('users', function ($table) {
    $table->renameColumn('from', 'to');
});

注：暫不支援enum型別的列的修改和重新命名。
刪除列

要刪除一個列，使用schema構建器上的dropColumn方法：

Schema::table('users', function ($table) {
    $table->dropColumn('votes');
});

你可以傳遞列名陣列到dropColumn方法從表中刪除多個列：

Schema::table('users', function ($table) {
    $table->dropColumn(['votes', 'avatar', 'location']);
});

注：在從SQLite資料庫刪除列之前，需要新增doctrine/dbal依賴到composer.json檔案並在終端中執行composer update命令來安裝該庫。此外，SQLite資料庫暫不支援在單個遷移中刪除或修改多個列。

建立索引

schema構建器支援多種型別的索引，首先，讓我們看一個指定列值為唯一索引的例子。要建立索引，可以使用unique方法：

$table->string('email')->unique();

此外，你可以在定義列之後建立索引，例如：

$table->unique('email');

你甚至可以傳遞列名陣列到索引方法來建立組合索引：

$table->index(['account_id', 'created_at']);

Laravel 會自動生成合理的索引名稱，但是你可以傳遞第二個引數到該方法用於指定索引名稱：

$table->index('email', 'my_index_name');

可用索引型別

> 命令 描述

$table->primary('id'); 新增主鍵索引
$table->primary(['first', 'last']);    新增混合索引
$table->unique('email');   新增唯一索引
$table->unique('state', 'my_index_name');  指定自定義索引名稱
$table->index('state');    新增普通索引

刪除索引

要刪除索引，必須指定索引名。預設情況下，Laravel 自動分配適當的名稱給索引——簡單連線表名、列名和索引型別。下面是一些例子：

命令 描述

table−>dropPrimary(‘usersidprimary′);從“users”表中刪除主鍵索引table->dropUnique(‘users_email_unique’); 從 “users”表中刪除唯一索引 
$table->dropIndex(‘geo_state_index’); 從 “geo”表中刪除普通索引

如果要傳遞列陣列到刪除索引方法，那麼相應的索引名稱將會透過資料表名、列和關鍵型別來自動生成：

Schema::table(‘geo’, function (table) {table->dropIndex([‘state’]); // Drops index ‘geo_state_index’ 
});

外來鍵約束

Laravel 還提供了建立外來鍵約束的支援，用於在資料庫層面強制引用完整性。例如，我們在posts表中定義了一個引用users表的id列的user_id列：


Schema::table(‘posts’, function (table) {table->integer(‘user_id’)->unsigned(); 
$table->foreign(‘user_id’)->references(‘id’)->on(‘users’); 
});

你還可以為約束的“on delete”和“on update”屬性指定期望的動作：

$table->foreign(‘user_id’) 
->references(‘id’)->on(‘users’) 
->onDelete(‘cascade’);

要刪除一個外來鍵，可以使用dropForeign方法。外來鍵約束和索引使用同樣的命名規則——連線表名、外來鍵名然後加上“_foreign”字尾：


$table->dropForeign(‘posts_user_id_foreign’);

或者，你還可以傳遞在刪除時會自動使用基於慣例的約束名數值陣列：

$table->dropForeign([‘user_id’]);

你可以在遷移時透過以下方法啟用或關閉外來鍵約束：

Schema::enableForeignKeyConstraints(); 
Schema::disableForeignKeyConstraints();
本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章