데이터베이스: 마이그레이션

• 시작하기
• 마이그레이션 파일 생성하기
  • 스쿼싱 마이그레이션
• 마이그레이션의 구조
• 마이그레이션 실행하기
  • 마이그레이션 되돌리기-롤백
• 테이블
  • 테이블 생성하기
  • 테이블 수정하기
  • 테이블의 이름변경 / 제거
• Columns
  • 컬럼 생성하기
  • 사용가능한 컬럼의 타입들
  • 컬럼 수정자
  • 컬럼 수정하기
  • 컬럼 삭제하기
• 인덱스
  • 인덱스 생성하기
  • 인덱스 이름 변경하기
  • 인덱스 없애기
  • 외래키 제약조건
• 이벤트

시작하기

마이그레이션은 데이터베이스의 버전 컨트롤과 같으므로 팀에서 애플리케이션의 데이터베이스 스키마 정의를 정의하고 공유할 수 있습니다. 소스 제어에서 변경 사항을 가져온 후 팀원에게 수동으로 로컬 데이터베이스 스키마에 컬럼을 추가하도록 지시해야 하는 경우 데이터베이스 마이그레이션이 해결하는 문제에 직면해 있는 것입니다.

라라벨의 Schema 파사드는 라라벨에서 지원하는 모든 데이터베이스 시스템에서 테이블을 생성하고 조작하기 위한 데이터베이스 광범위한 지원을 제공합니다. 일반적으로 마이그레이션은 이 파사드를 사용하여 데이터베이스 테이블과 컬럼을 만들고 수정합니다.

마이그레이션 파일 생성하기

마이그레이션 파일을 생성하기 위해서는 make:migration 아티즌 명령어를 사용합니다. 새로운 마이그레이션 파일은 database/migrations 디렉토리에 생성됩니다. 각 마이그레이션 파일 이름에는 Laravel이 마이그레이션 순서를 결정할 수 있는 타임스탬프가 포함되어 있습니다.

php artisan make:migration create_flights_table

라라벨은 마이그레이션 이름을 사용하여 테이블 이름을 추측하고 마이그레이션이 새 테이블을 생성할지 여부를 추측합니다. 라라벨이 마이그레이션 이름에서 테이블 이름을 결정할 수 있다면 라라벨은 생성된 마이그레이션 파일을 지정된 테이블로 미리 채울 것입니다. 그렇지 않으면 마이그레이션 파일에 테이블을 수동으로 지정할 수 있습니다.

생성된 마이그레이션에 대한 사용자 지정 경로를 지정하려면 make:migration 명령을 실행할 때 --path 옵션을 사용할 수 있습니다. 주어진 경로는 애플리케이션의 기본 경로에 상대적이어야 합니다.

{tip} stub publishing를 통해서 마이그레이션 stubs을 커스트마이징 할 수 있습니다.

스쿼싱 마이그레이션

애플리케이션을 빌드하면서 시간이 지남에 따라 더 많은 마이그레이션이 누적될 수 있습니다. 이로 인해 database/migrations 디렉토리가 잠재적으로 수백 번의 마이그레이션으로 비대해질 수 있습니다. 원하는 경우 마이그레이션을 단일 SQL 파일로 "squash" 할 수 있습니다. 시작하려면 schema:dump 명령을 실행하세요:

php artisan schema:dump

// Dump the current database schema and prune all existing migrations...
php artisan schema:dump --prune

이 명령을 실행하면 라라벨은 database/schema 폴더에 "schema" 파일을 작성합니다. 이제 데이터베이스 마이그레이션을 시도하고 다른 마이그레이션이 실행되지 않은 경우 라라벨은 스키마 파일의 SQL 문을 먼저 실행합니다. 스키마 파일의 명령문을 실행한 후 라라벨은 스키마 덤프의 일부가 아닌 나머지 마이그레이션을 실행합니다.

여러분은 팀의 다른 새로운 개발자가 애플리케이션의 초기 데이터베이스 구조를 빠르게 만들 수 있도록 데이터베이스 스키마 파일을 소스 컨트롤에 커밋해야 합니다.

{note} 마이그레이션 스쿼싱은 MySQL, PostgreSQL 및 SQLite 데이터베이스에서만 사용할 수 있으며 데이터베이스의 명령줄 클라이언트를 활용합니다. 스키마 덤프는 메모리 내 SQLite 데이터베이스로 복원되지 않을 수 있습니다.

마이그레이션의 구조

마이그레이션 클래스에는 up 및 down의 두 가지 방법이 있습니다. up 메소드는 데이터베이스에 새 테이블, 열 또는 인덱스를 추가하는 데 사용되는 반면, down 방법은 up 방법이 수행하는 작업을 반대로 해야 합니다.

이 두 메소드 모두에서 라라벨 스키마 빌더를 사용하여 테이블을 다양한 방법을 통해서 생성하고 변경할 수 있습니다. Schema 빌더에서 사용할 수 있는 모든 메소드에 대해 알아보려면 문서를 확인하세요. 예를 들어 다음 마이그레이션은 flights 테이블을 생성합니다.

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('airline');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('flights');
    }
}

익명 마이그레이션

위의 예에서 알 수 있듯이 라라벨은 make:migration 명령을 사용하여 생성하는 모든 마이그레이션에 클래스 이름을 자동으로 할당합니다. 그러나 원하는 경우 마이그레이션 파일에서 익명 클래스를 반환할 수 있습니다. 이는 애플리케이션이 많은 마이그레이션을 쌓여있을때 그 중 두 개에 클래스 이름 충돌이 있는 경우에 주로 유용합니다.

<?php

use Illuminate\Database\Migrations\Migration;

return new class extends Migration
{
    //
};

마이그레이션 연결 설정

마이그레이션이 애플리케이션의 기본 데이터베이스 연결 이외의 데이터베이스 연결과 상호 작용하는 경우 마이그레이션의 $connection 속성을 설정해야 합니다.

/**
 * The database connection that should be used by the migration.
 *
 * @var string
 */
protected $connection = 'pgsql';

/**
 * Run the migrations.
 *
 * @return void
 */
public function up()
{
    //
}

마이그레이션 실행하기

아직 실행된적이 없는 모든 마이그레이션을 실행하려면, migrate 아티즌 명령어를 실행하면 됩니다.

php artisan migrate

지금까지 어떤 마이그레이션이 실행되었는지 확인하려면 migrate:status 아티즌 명령을 사용할 수 있습니다.

php artisan migrate:status

실제 production 서버에서 강제로 마이그레이션 실행하기

일부 마이그레이션 작업은 구조의 변경이 있을 수 있으며 데이터 손실이 발생할 수 있습니다. production 서버의 데이터베이스에 대해 이러한 명령을 실행하지 못하도록 보호하기 위해 명령을 실행하기 전에 확인 메시지가 표시됩니다. 확인 메시지 없이 명령을 강제 실행하려면 --force 플래그를 사용하세요:

php artisan migrate --force

마이그레이션 되돌리기-롤백

가장 최근의 마이그레이션 작업(operation)을 되돌리려면 rollback 명령어를 사용하면 됩니다. 이 명령어는 가장 최근에 실행된 마이그레이션의 "모음(batch)", 즉 여러개의 마이그레이션 파일에 대해서 되돌릴 수 있습니다.

php artisan migrate:rollback

rollback 명령어에 step 옵션을 전달하여 제한된 숫자의 마이그레이션만 되돌릴 수 있습니다. 예를 들어 다음의 명령어는 최근 5개의 마이그레이션만 되돌립니다.

php artisan migrate:rollback --step=5

migrate:reset 커맨드는 애플리케이션의 모든 마이그레이션을 되돌립니다.

php artisan migrate:reset

하나의 명령어로 롤백과 마이그레이트 함께 실행 하기

migrate:refresh 명령어는 모든 마이그레이션을 되돌리고, migrate 명령어를 실행합니다. 이 명령어는 전체 데이터베이스를 효과적으로 재생성합니다.

php artisan migrate:refresh

// Refresh the database and run all database seeds...
php artisan migrate:refresh --seed

refresh 명령어에 step 옵션을 전달하여 제한된 숫자의 마이그레이션만 되돌리고 다시 마이그레이션을 수행할 수 있습니다. 예를들어 다음의 명령어는 최근 5개의 마이그레이션만 되돌리고 마이그레이션을 다시 실행합니다.

php artisan migrate:refresh --step=5

모든 테이블과 마이그레이션 Drop

migrate:fresh 명령어는 migrate 명령이 실행될 때 데이터베이스의 모든 테이블을 drop 합니다.

php artisan migrate:fresh

php artisan migrate:fresh --seed

{note} migrate:fresh 명령은 접두어에 관계없이 모든 데이터베이스 테이블을 삭제합니다. 이 명령은 다른 응용 프로그램과 공유되는 데이터베이스에서 개발할 때 주의해서 사용해야 합니다.

테이블

테이블 생성하기

새로운 데이터베이스 테이블을 생성하려면 Schema 파사드에 create 메소드를 사용하면 됩니다. create 메소드는 두개의 인자를 전달 받습니다. 첫번째 인자는 테이블의 이름이고, 두번째 인자는 새로운 테이블을 정의하는 사용되는 Blueprint 객체를 받는 Closure입니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email');
    $table->timestamps();
});

테이블을 생성할 때, 테이블의 컬럼을 정의하기 위하여 자유롭게 스키마 빌더의 컬럼 메소드를 사용할 수 있습니다.

테이블 / 컬럼이 존재하는지 확인하기

hasTable와 hasColumn 메소드를 사용해 테이블이나 컬럼의 존재 유무를 확인할 수 있습니다.

if (Schema::hasTable('users')) {
    // The "users" table exists...
}

if (Schema::hasColumn('users', 'email')) {
    // The "users" table exists and has an "email" column...
}

데이터베이스 커넥션-connection & 테이블 옵션

기본 커넥션-connection이 아닌 다른 데이터베이스 커넥션-connection에 스키마 작업을 수행하려면 connection 메소드를 사용하면 됩니다.

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

또한 몇 가지 다른 속성과 메소드를 사용하여 테이블 생성의 다른 측면을 정의할 수 있습니다. engine 속성은 MySQL을 사용할 때 테이블의 스토리지 엔진을 지정하는 데 사용할 수 있습니다.

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

    // ...
});

charset 및 collation 속성은 MySQL을 사용할 때 생성된 테이블에 대한 문자 집합 및 데이터 정렬을 지정하는 데 사용할 수 있습니다.

Schema::create('users', function (Blueprint $table) {
    $table->charset = 'utf8mb4';
    $table->collation = 'utf8mb4_unicode_ci';

    // ...
});

temporary 메소드는 테이블이 "temporary"이여야 함을 나타내는 데 사용할 수 있습니다. 임시 테이블은 현재 연결의 데이터베이스 세션에서만 볼 수 있으며 연결이 닫힐 때 자동으로 삭제됩니다.

Schema::create('calculations', function (Blueprint $table) {
    $table->temporary();

    // ...
});

테이블 수정하기

Schema 파사드의 table 메소드는 기존 테이블을 수정하는 데 사용할 수 있습니다. create 메소드와 마찬가지로 table 메소드는 테이블 이름과 테이블에 컬럼이나 인덱스를 추가하는 데 사용할 수 있는 Blueprint 인스턴스를 받는 클로저의 두 가지 인수를 허용합니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

테이블 이름 변경 / 제거하기

이미 존재하는 테이블의 이름을 바꾸려면 rename 메소드를 이용하십시오:

use Illuminate\Support\Facades\Schema;

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

이미 존재하는 테이블을 제거하려면 drop이나 dropIfExists 메소드를 사용하세요:

Schema::drop('users');

Schema::dropIfExists('users');

외래 키를 가진 테이블의 이름 변경

테이블의 이름 변경하기 전에, 마이그레이션 파일에서 라라벨의 규약(Convention)에 따르는 기본 이름으로 지정되지 않고 고유한 이름을 붙인 외래 키 제약 조건이 존재하지 않는지 확인하십시오. 그렇지 않다면 외래 키 제약의 이름이 기존 테이블 이름을 참고하게 됩니다.

컬럼

컬럼 생성하기

이미 존재하는 테이블을 변경하기 하는데, Schema 파사드의 table 메소드를 사용할 수 있습니다. create 메소드와 같이 table 메소드도 두개의 인자를 전달 받습니다. 하나는 테이블의 이름이고, 다른 하나는 테이블에 컬럼을 추가하는데 사용할 수 있는 Blueprint 인스턴스를 받는 Closure입니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

사용가능한 컬럼의 타입들

스키마 빌더 청사진(blueprint)은 데이터베이스 테이블에 추가할 수 있는 다양한 유형의 컬럼에 해당하는 다양한 방법을 제공합니다. 사용 가능한 각 방법은 아래 표에 나열되어 있습니다.

bigIncrements bigInteger binary boolean char dateTimeTz dateTime date decimal double enum float foreignId foreignIdFor foreignUuid geometryCollection geometry id increments integer ipAddress json jsonb lineString longText macAddress mediumIncrements mediumInteger mediumText morphs multiLineString multiPoint multiPolygon nullableMorphs nullableTimestamps nullableUuidMorphs point polygon rememberToken set smallIncrements smallInteger softDeletesTz softDeletes string text timeTz time timestampTz timestamp timestampsTz timestamps tinyIncrements tinyInteger tinyText unsignedBigInteger unsignedDecimal unsignedInteger unsignedMediumInteger unsignedSmallInteger unsignedTinyInteger uuidMorphs uuid year

bigIncrements() {.collection-method .first-collection-method}

bigIncrements 메소드는 자동 증가하는 UNSIGNED BIGINT(기본 키)에 해당하는 컬럼을 생성합니다.

$table->bigIncrements('id');

bigInteger() {.collection-method}

bigInteger 메소드는 BIGINT에 해당하는 컬럼을 생성합니다.

$table->bigInteger('votes');

binary() {.collection-method}

binary 메소드는 BLOB에 해당하는 컬럼을 생성합니다.

$table->binary('photo');

boolean() {.collection-method}

boolean 메소드는 BOOLEAN에 해당하는 컬럼을 생성합니다.

$table->boolean('confirmed');

char() {.collection-method}

char 메소드는 주어진 길이의 CHAR에 해당하는 컬럼을 생성합니다.

$table->char('name', 100);

dateTimeTz() {.collection-method}

dateTimeTz 메소드는 선택적 정밀도(총 자릿수)를 사용하여 DATETIME(시간대 포함)에 해당하는 컬럼을 생성합니다.

$table->dateTimeTz('created_at', $precision = 0);

dateTime() {.collection-method}

dateTime 메소드는 선택적 정밀도(총 자릿수)를 사용하여 DATETIME에 해당하는 컬럼을 생성합니다.

$table->dateTime('created_at', $precision = 0);

date() {.collection-method}

date 메소드는 DATE에 해당하는 컬럼을 생성합니다.

$table->date('created_at');

decimal() {.collection-method}

decimal 메소드는 주어진 정밀도(총 자릿수) 및 스케일(십진 자릿수)을 사용하여 DECIMAL에 해당하는 컬럼을 생성합니다.

$table->decimal('amount', $precision = 8, $scale = 2);

double() {.collection-method}

double 메소드는 주어진 정밀도(총 자릿수)와 스케일(십진수)을 사용하여 DOUBLE에 해당하는 컬럼을 생성합니다.

$table->double('amount', 8, 2);

enum() {.collection-method}

enum 메소드는 주어진 유효한 값으로 ENUM에 해당하는 컬럼을 생성합니다.

$table->enum('difficulty', ['easy', 'hard']);

float() {.collection-method}

float 메소드는 주어진 정밀도(총 자릿수)와 스케일(십진수)로 FLOAT에 해당하는 컬럼을 생성합니다.

$table->float('amount', 8, 2);

foreignId() {.collection-method}

foreignId 메소드는 UNSIGNED BIGINT에 해당하는 컬럼을 생성합니다.

$table->foreignId('user_id');

foreignIdFor() {.collection-method}

foreignIdFor 메소드는 주어진 모델 클래스에 대해 {column}_id UNSIGNED BIGINT에 해당하는 컬럼을 추가합니다.

$table->foreignIdFor(User::class);

foreignUuid() {.collection-method}

foreignUuid 메소드는 UUID에 해당하는 컬럼을 생성합니다.

$table->foreignUuid('user_id');

geometryCollection() {.collection-method}

geometryCollection 메소드는 GEOMETRYCOLLECTION에 해당하는 컬럼을 생성합니다.

$table->geometryCollection('positions');

geometry() {.collection-method}

geometry 메소드는 GEOMETRY에 해당하는 컬럼을 생성합니다.

$table->geometry('positions');

id() {.collection-method}

id 메소드는 bigIncrements 메소드의 별칭입니다. 기본적으로 이 메소드는 id 컬럼을 생성합니다. 그러나 컬럼에 다른 이름을 지정하려면 컬럼 이름을 전달할 수 있습니다.

$table->id();

increments() {.collection-method}

increments 메소드는 기본 키로 자동 증가하는 UNSIGNED INTEGER에 해당하는 컬럼을 생성합니다.

$table->increments('id');

integer() {.collection-method}

integer 메소드는 INTEGER에 해당하는 컬럼을 생성합니다.

$table->integer('votes');

ipAddress() {.collection-method}

ipAddress 메소드는 VARCHAR에 해당하는 컬럼을 생성합니다.

$table->ipAddress('visitor');

json() {.collection-method}

json 메소드는 JSON에 해당하는 컬럼을 생성합니다.

$table->json('options');

jsonb() {.collection-method}

jsonb 메소드는 JSONB에 해당하는 컬럼을 생성합니다.

$table->jsonb('options');

lineString() {.collection-method}

lineString 메소드는 LINESTRING에 해당하는 컬럼을 생성합니다.

$table->lineString('positions');

longText() {.collection-method}

longText 메소드는 LONGTEXT에 해당하는 컬럼을 생성합니다.

$table->longText('description');

macAddress() {.collection-method}

macAddress 메소드는 맥어드레스를 담기 위한 컬럼을 생성합니다. PostgreSQL과 같은 일부 데이터베이스 시스템에는 이러한 유형의 데이터에 대한 전용 컬럼 유형이 있습니다. 다른 데이터베이스 시스템은 문자열에 해당하는 컬럼을 사용합니다.

$table->macAddress('device');

mediumIncrements() {.collection-method}

mediumIncrements 메소드는 기본 키로 자동 증가하는 UNSIGNED MEDIUMINT에 해당하는 컬럼을 생성합니다.

$table->mediumIncrements('id');

mediumInteger() {.collection-method}

mediumInteger 메소드는 MEDIUMINT에 해당하는 컬럼을 생성합니다.

$table->mediumInteger('votes');

mediumText() {.collection-method}

mediumText 메소드는 MEDIUMTEXT에 해당하는 컬럼을 생성합니다.

$table->mediumText('description');

morphs() {.collection-method}

morphs 메소드는 {column}_id UNSIGNED BIGINT에 해당하는 컬럼과 {column}_type VARCHAR에 해당하는 컬럼을 추가하는 편리한 메소드입니다.

이 방법은 다형성 Relationships - 관계에 필요한 컬럼을 정의할 때 사용하기 위한 것입니다. 다음 예에서는 taggable_id 및 taggable_type 컬럼이 생성됩니다.

$table->morphs('taggable');

multiLineString() {.collection-method}

multiLineString 메소드는 MULTILINESTRING에 해당하는 컬럼을 생성합니다.

$table->multiLineString('positions');

multiPoint() {.collection-method}

multiPoint 메소드는 MULTIPOINT에 해당하는 컬럼을 생성합니다.

$table->multiPoint('positions');

multiPolygon() {.collection-method}

multiPolygon 메소드는 MULTIPOLYGON에 해당하는 컬럼을 생성합니다.

$table->multiPolygon('positions');

nullableTimestamps() {.collection-method}

nullableTimestamps 메소드는 timestamps 메소드의 별칭입니다.

$table->nullableTimestamps(0);

nullableMorphs() {.collection-method}

이 방법은 morphs 방법과 유사합니다. 그러나 생성되는 컬럼은 "nullable"이 됩니다.

$table->nullableMorphs('taggable');

nullableUuidMorphs() {.collection-method}

이 방법은 uuidMorphs 방법과 유사합니다. 그러나 생성되는 컬럼은 "nullable"이 됩니다.

$table->nullableUuidMorphs('taggable');

point() {.collection-method}

point 메소드는 POINT에 해당하는 컬럼을 생성합니다.

$table->point('position');

polygon() {.collection-method}

polygon 메소드는 POLYGON에 해당하는 컬럼을 생성합니다.

$table->polygon('position');

rememberToken() {.collection-method}

rememberToken 메소드는 현재 "remember me"authentication token를 저장하기 위한 null 허용 VARCHAR(100) 컬럼을 생성합니다.

$table->rememberToken();

set() {.collection-method}

set 메소드는 유효한 값의 주어진 목록으로 SET에 해당하는 컬럼을 생성합니다.

$table->set('flavors', ['strawberry', 'vanilla']);

smallIncrements() {.collection-method}

smallIncrements 메소드는 기본 키로 자동 증가하는 UNSIGNED SMALLINT에 해당하는 컬럼을 생성합니다.

$table->smallIncrements('id');

smallInteger() {.collection-method}

smallInteger 메소드는 SMALLINT에 해당하는 컬럼을 생성합니다.

$table->smallInteger('votes');

softDeletesTz() {.collection-method}

softDeletesTz 메소드는 선택적 정밀도(총 자릿수)가 있는 nullable deleted_at TIMESTAMP(시간대 포함) 해당 컬럼을 추가합니다. 이 컬럼은 Eloquent의 "soft delete" 기능에 필요한 deleted_at 타임스탬프를 저장하기 위한 것입니다.

$table->softDeletesTz($column = 'deleted_at', $precision = 0);

softDeletes() {.collection-method}

softDeletes 메소드는 선택적 정밀도(총 자릿수)를 사용하여 nullable deleted_at TIMESTAMP에 해당하는 컬럼을 추가합니다. 이 컬럼은 Eloquent의 "soft delete" 기능에 필요한 deleted_at 타임스탬프를 저장하기 위한 것입니다.

$table->softDeletes($column = 'deleted_at', $precision = 0);

string() {.collection-method}

string 메소드는 주어진 길이의 VARCHAR에 해당하는 컬럼을 생성합니다.

$table->string('name', 100);

text() {.collection-method}

text 메소드는 TEXT에 해당하는 컬럼을 생성합니다.

$table->text('description');

timeTz() {.collection-method}

timeTz 메소드는 선택적 정밀도(총 자릿수)를 사용하여 TIME(시간대 포함)에 해당하는 컬럼을 생성합니다.

$table->timeTz('sunrise', $precision = 0);

time() {.collection-method}

time 메소드는 선택적 정밀도(총 자릿수)를 사용하여 TIME에 해당하는 컬럼을 생성합니다.

$table->time('sunrise', $precision = 0);

timestampTz() {.collection-method}

timestampTz 메소드는 선택적 정밀도(총 자릿수)를 사용하여 TIMESTAMP(시간대 포함)에 해당하는 컬럼을 생성합니다.

$table->timestampTz('added_at', $precision = 0);

timestamp() {.collection-method}

timestamp 메소드는 선택적 정밀도(총 자릿수)를 사용하여 TIMESTAMP에 해당하는 컬럼을 생성합니다.

$table->timestamp('added_at', $precision = 0);

timestampsTz() {.collection-method}

timestampsTz 메소드는 선택적 정밀도(총 자릿수)를 사용하여 created_at 및 updated_at TIMESTAMP(시간대 포함)에 해당하는 컬럼을 생성합니다.

$table->timestampsTz($precision = 0);

timestamps() {.collection-method}

timestamps 메소드는 선택적 정밀도(총 자릿수)를 사용하여 created_at 및 updated_at TIMESTAMP에 해당하는 컬럼을 생성합니다.

$table->timestamps($precision = 0);

tinyIncrements() {.collection-method}

tinyIncrements 메소드는 기본 키로 자동 증가하는 UNSIGNED TINYINT에 해당하는 컬럼을 생성합니다.

$table->tinyIncrements('id');

tinyInteger() {.collection-method}

tinyInteger 메소드는 TINYINT에 해당하는 컬럼을 생성합니다.

$table->tinyInteger('votes');

tinyText() {.collection-method}

tinyText 메소드는 TINYTEXT에 해당하는 컬럼을 생성합니다.

$table->tinyText('notes');

unsignedBigInteger() {.collection-method}

The unsignedBigInteger method creates an UNSIGNED BIGINT equivalent column:

$table->unsignedBigInteger('votes');

unsignedDecimal() {.collection-method}

The unsignedDecimal method creates an UNSIGNED DECIMAL equivalent column with an optional precision (total digits) and scale (decimal digits):

$table->unsignedDecimal('amount', $precision = 8, $scale = 2);

unsignedInteger() {.collection-method}

unsignedInteger 메소드는 UNSIGNED INTEGER에 해당하는 컬럼을 생성합니다.

$table->unsignedInteger('votes');

unsignedMediumInteger() {.collection-method}

unsignedMediumInteger 메소드는 UNSIGNED MEDIUMINT에 해당하는 컬럼을 생성합니다.

$table->unsignedMediumInteger('votes');

unsignedSmallInteger() {.collection-method}

unsignedSmallInteger 메소드는 UNSIGNED SMALLINT에 해당하는 컬럼을 생성합니다.

$table->unsignedSmallInteger('votes');

unsignedTinyInteger() {.collection-method}

unsignedTinyInteger 메소드는 UNSIGNED TINYINT에 해당하는 컬럼을 생성합니다.

$table->unsignedTinyInteger('votes');

uuidMorphs() {.collection-method}

uuidMorphs 메소드는 {column}_id CHAR(36)에 해당하는 컬럼과 {column}_type VARCHAR에 해당하는 컬럼을 추가하는 편리한 메소드입니다.

이 방법은 UUID 식별자를 사용하는 다형성 Relationships - 관계에 필요한 컬럼을 정의할 때 사용하기 위한 것입니다. 다음 예에서는 taggable_id 및 taggable_type 컬럼이 생성됩니다.

$table->uuidMorphs('taggable');

uuid() {.collection-method}

uuid 메소드는 UUID에 해당하는 컬럼을 생성합니다.

$table->uuid('id');

year() {.collection-method}

year 메소드는 YEAR에 해당하는 컬럼을 생성합니다.

$table->year('birth_year');

Column Modifiers

위에 나열된 컬럼 유형 외에도 데이터베이스 테이블에 컬럼을 추가할 때 사용할 수 있는 여러 컬럼 "수정자-modifier"가 있습니다. 예를 들어 컬럼을 "nullable"로 만들려면 nullable 메서드를 사용할 수 있습니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

다음 표에는 사용 가능한 모든 컬럼 수정자가 포함되어 있습니다. 이 목록에는 인덱스 생성하기가 포함되어 있지 않습니다.

기본 표현식

default 수정자-modifier는 값 또는 \Illuminate\Database\Query\Expression 인스턴스를 허용합니다. Expression 인스턴스를 사용하면 라라벨이 값을 따옴표로 묶는 것을 방지하고 데이터베이스 별 함수를 사용할 수 있습니다. 이것이 특히 유용한 상황 중 하나는 JSON 컬럼에 기본값을 할당하는 것입니다.

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Query\Expression;
use Illuminate\Database\Migrations\Migration;

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->json('movies')->default(new Expression('(JSON_ARRAY())'));
            $table->timestamps();
        });
    }
}

{note} 기본 표현식 지원은 데이터베이스 드라이버, 데이터베이스 버전 및 필드 유형에 따라 다릅니다. 데이터베이스의 설명서를 참조하십시오.

컬럼 순서

MySQL 데이터베이스를 사용할 때 after 메서드를 사용하여 스키마의 기존 컬럼 뒤에 컬럼을 추가할 수 있습니다.

$table->after('password', function ($table) {
    $table->string('address_line1');
    $table->string('address_line2');
    $table->string('city');
});

컬럼 수정

전제 조건

열을 수정하기 전에 Composer 패키지 관리자를 사용하여 doctrine/dbal 패키지를 설치해야 합니다. Doctrine DBAL 라이브러리는 컬럼의 현재 상태를 확인하고 컬럼에 요청된 변경을 수행하는 데 필요한 SQL 쿼리를 만드는 데 사용됩니다.

composer require doctrine/dbal

timestamp 메소드를 사용하여 생성된 컬럼을 수정하려는 경우 애플리케이션의 config/database.php 구성 파일에 다음 구성도 추가해야 합니다.

use Illuminate\Database\DBAL\TimestampType;

'dbal' => [
    'types' => [
        'timestamp' => TimestampType::class,
    ],
],

{참고} 응용 프로그램이 Microsoft SQL Server를 사용하는 경우 doctrine/dbal:^3.0을 설치해야 합니다.

컬럼의 속성 변경하기

change 메소드는 이미 존재하는 컬럼 타입을 유형과 속성을 변경합니다. 예를 들어, string 컬럼의 사이즈를 늘이고 싶을 수 있습니다. change 메소드가 어떻게 작동하는지 name 컬럼 사이즈를 25에서 50으로 늘여서 확인해 보겠습니다. 이를 수행하기 위해 컬럼의 새 상태를 정의한 다음 change 메서드를 호출하기만 하면 됩니다.

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

컬럼을 nullable로 수정할 수도 있습니다.

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

{note} 수정할 수 있는 컬럼 유형은 bigInteger, binary, boolean, date, dateTime, dateTimeTz, decimal, integer, json, longText입니다., mediumText, smallInteger, string, text, time, unsignedBigInteger, unsignedInteger, unsignedSmallInteger 및 uuid. timestamp 컬럼 유형을 수정하려면 Doctrine 타입 등록 필요.

인덱스 이름 변경하기

컬럼의 이름을 바꾸려면 스키마 빌더 청사진(blueprint)에서 제공하는 renameColumn 메서드를 사용할 수 있습니다. 컬럼 이름을 바꾸기 전에 Composer 패키지 관리자를 통해 doctrine/dbal 라이브러리를 설치했는지 확인하세요:

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

{note} enum 컬럼의 이름을 바꾸는 것은 현재 지원되지 않습니다.

Dropping Columns

컬럼을 삭제하려면 스키마 빌더 청사진(blueprint)에서 dropColumn 메서드를 사용할 수 있습니다. 애플리케이션이 SQLite 데이터베이스를 사용하는 경우 dropColumn 메소드를 사용하기 전에 Composer 패키지 관리자를 통해 doctrine/dbal 패키지를 설치해야 합니다.

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

컬럼 이름의 배열을 dropColumn 메서드에 전달하여 테이블에서 여러 컬럼을 삭제할 수 있습니다.

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

{note} SQLite 데이터베이스를 사용하는 동안 단일 마이그레이션 내에서 여러 컬럼을 삭제하거나 수정하는 것은 지원되지 않습니다.

사용가능한 명령어 alias(별칭)

라라벨은 일반적인 유형의 컬럼 삭제와 관련된 몇 가지 편리한 방법을 제공합니다. 이러한 각 방법은 아래 표에 설명되어 있습니다.

인덱스

인덱스 생성하기

Laravel 스키마 빌더는 여러 타입의 인덱스를 지원합니다. 다음에서 새로운 email 컬럼을 만들고 해당 값을 고유 값을 가지도록 만들어 보겠습니다. 인덱스를 생성하려면 컬럼의 정의에서 unique 메소드를 체이닝 하면 됩니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

또는 컬럼을 정의한 후 인덱스를 생성할 수 있습니다. 그렇게 하려면 스키마 빌더 청사진(blueprint)에서 unique 메서드를 호출해야 합니다. 이 메서드는 고유 인덱스를 받아야 하는 컬럼의 이름을 수락합니다.

$table->unique('email');

인덱스 메소드에 컬럼의 배열을 전달하여 결합(복합) 인덱스를 생성할 수도 있습니다.

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

인덱스를 생성할 때, 라라벨은 자동으로 테이블, 컬럼 이름, 인덱스 타입을 기반으로 인덱스 이름을 생성하지만, 인덱스 이름을 지정하기 위해 두 번째 인자를 메소드에 전달할 수도 있습니다.

$table->unique('email', 'unique_email');

라라벨은 테이블, 컬럼 이름 및 인덱스 유형을 기반으로 인덱스 이름을 자동으로 생성하지만 메소드의 두번째 인자로 인덱스 이름을 지정할 수도 있습니다.

사용가능한 인덱스 타입

라라벨의 스키마 빌더 청사진(blueprint) 클래스는 라라벨이 지원하는 각 유형의 인덱스를 생성하기 위한 메소드를 제공합니다. 각 인덱스 메서드는 인덱스 이름을 지정하기 위해 선택적 두 번째 인수를 허용합니다. 생략하면 이름은 인덱스 유형뿐만 아니라 인덱스에 사용된 테이블 및 컬럼의 이름에서 파생됩니다. 사용 가능한 각 인덱스 방법은 아래 표에 설명되어 있습니다.

인덱스 길이 & MySQL / MariaDB

기본적으로 라라벨은 utf8mb4 캐릭터셋을 사용합니다. 5.7.7 릴리스 이전의 MySQL 또는 10.2.2 릴리스 이전의 MariaDB를 실행 중인 경우 MySQL이 해당 인덱스를 생성하도록 마이그레이션에 의해 생성된 기본 문자열 길이를 수동으로 구성해야 할 수 있습니다. App\Providers\AppServiceProvider 클래스의 boot 메소드 내에서 Schema::defaultStringLength 메소드를 호출하여 기본 문자열 길이를 구성할 수 있습니다.

use Illuminate\Support\Facades\Schema;

/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Schema::defaultStringLength(191);
}

또는 데이터베이스에 innodb_large_prefix 옵션을 활성화 할 수도 있습니다. 이 옵션을 제대로 사용하는 방법은 데이터베이스 매뉴얼을 참고하십시오.

인덱스 이름 변경하기

인덱스의 이름을 변경하기 위해서는 renameIndex 메소드를 사용하면 됩니다. 이 메소드는 현재의 인덱스 이름을 첫번째 인자로, 변경하고자 하는 새이름을 두번째 인자로 전달받습니다.

$table->renameIndex('from', 'to')

인덱스 삭제하기

인덱스를 삭제하기 위해서는 인덱스의 이름을 지정해야 합니다. 기본적으로 라라벨은 테이블 이름, 인덱스된 컬럼의 이름, 그리고 인덱스 타입을 기반으로 자동으로 인덱스의 이름을 부여하도록 설정되어 있습니다. 다음은 몇 개의 예제 입니다.

인덱스들을 삭제하기 위해서 메소드에 컬럼의 배열을 전달하게 되면 인덱스의 이름은 테이블명, 컬럼명 그리고 키의 타입을 기반으로 컨벤션에 의해서 인덱스 이름을 추정할 것입니다.

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

외래키 제약조건(Constraints)

라라벨은 데이터베이스에서 또한 참조 무결성을 강제하는 외래 키 제약조건을 생성하는 것을 제공합니다. 예를 들어 users 테이블의 id 컬럼을 참조하는 posts 테이블에 user_id 컬럼을 정의해보겠습니다.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::table('posts', function (Blueprint $table) {
    $table->unsignedBigInteger('user_id');

    $table->foreign('user_id')->references('id')->on('users');
});

이 구문은 다소 장황하기 때문에 라라벨은 더 나은 개발자 경험을 제공하기 위해 규칙을 사용하는 간결한 추가 메서드를 제공합니다. foreignId 메소드를 사용하여 컬럼을 생성할 때 위의 예는 다음과 같이 다시 작성할 수 있습니다.

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained();
});

foreignId 메서드는 UNSIGNED BIGINT에 해당하는 컬럼을 생성하는 반면, constrained 메서드는 규칙을 사용하여 참조되는 테이블과 컬럼 이름을 결정합니다. 테이블 이름이 라라벨의 규칙과 일치하지 않으면 constrained 메소드에 인수로 전달하여 테이블 이름을 지정할 수 있습니다.

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained('users');
});

제약조건(constraint)의 "on delete"와 "on update" 속성에 원하는 동작을 지정할 수도 있습니다.

$table->foreignId('user_id')
      ->constrained()
      ->onUpdate('cascade')
      ->onDelete('cascade');

다음 작업에 대한 대안적인 표현 구문도 제공됩니다.

모든 추가 컬럼 수정자-modifiers는 constrained 메서드보다 먼저 호출되어야 합니다.

$table->foreignId('user_id')
      ->nullable()
      ->constrained();

외래 키 삭제

외래 키를 삭제하려면 삭제할 외래 키 제약 조건의 이름을 인수로 전달하여 dropForeign 메서드를 사용할 수 있습니다. 외래 키 제약 조건은 인덱스와 동일한 명명 규칙을 사용합니다. 즉, 외래 키 제약 조건 이름은 테이블 이름과 제약 조건에 있는 컬럼을 기반으로 하며 그 뒤에 "_foreign" 접미사가 붙습니다.

$table->dropForeign('posts_user_id_foreign');

또는 외래 키를 포함하는 컬럼 이름을 포함하는 배열을 dropForeign 메서드에 전달할 수 있습니다. 배열은 라라벨의 제약 조건 명명 규칙을 사용하여 외래 키 제약 조건 이름으로 변환됩니다.

$table->dropForeign(['user_id']);

외래 키 제약 조건 토글

다음 방법을 사용하여 마이그레이션 내에서 외래 키 제약 조건을 활성화하거나 비활성화할 수 있습니다.

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

{note} SQLite는 기본적으로 외래 키 제약 조건을 비활성화합니다. SQLite를 사용하는 경우 마이그레이션에서 생성을 시도하기 전에 데이터베이스 구성에서 외래 키 지원 활성화를 확인하십시오. 또한 SQLite는 테이블 생성 시에만 외래 키를 지원하며 테이블이 변경되는 경우는 지원하지 않음.

이벤트

편의를 위해 각 마이그레이션 작업은 이벤트를 전달합니다. 다음의 모든 이벤트는 기본 Illuminate\Database\Events\MigrationEvent 클래스를 확장합니다.

Database: Migrations

• Introduction
• Generating Migrations
  • Squashing Migrations
• Migration Structure
• Running Migrations
  • Rolling Back Migrations
• Tables
  • Creating Tables
  • Updating Tables
  • Renaming / Dropping Tables
• Columns
  • Creating Columns
  • Available Column Types
  • Column Modifiers
  • Modifying Columns
  • Dropping Columns
• Indexes
  • Creating Indexes
  • Renaming Indexes
  • Dropping Indexes
  • Foreign Key Constraints
• Events

Introduction

Migrations are like version control for your database, allowing your team to define and share the application's database schema definition. If you have ever had to tell a teammate to manually add a column to their local database schema after pulling in your changes from source control, you've faced the problem that database migrations solve.

The Laravel Schema facade provides database agnostic support for creating and manipulating tables across all of Laravel's supported database systems. Typically, migrations will use this facade to create and modify database tables and columns.

Generating Migrations

You may use the make:migration Artisan command to generate a database migration. The new migration will be placed in your database/migrations directory. Each migration filename contains a timestamp that allows Laravel to determine the order of the migrations:

php artisan make:migration create_flights_table

Laravel will use the name of the migration to attempt to guess the name of the table and whether or not the migration will be creating a new table. If Laravel is able to determine the table name from the migration name, Laravel will pre-fill the generated migration file with the specified table. Otherwise, you may simply specify the table in the migration file manually.

If you would like to specify a custom path for the generated migration, you may use the --path option when executing the make:migration command. The given path should be relative to your application's base path.

{tip} Migration stubs may be customized using stub publishing.

Squashing Migrations

As you build your application, you may accumulate more and more migrations over time. This can lead to your database/migrations directory becoming bloated with potentially hundreds of migrations. If you would like, you may "squash" your migrations into a single SQL file. To get started, execute the schema:dump command:

php artisan schema:dump

// Dump the current database schema and prune all existing migrations...
php artisan schema:dump --prune

When you execute this command, Laravel will write a "schema" file to your application's database/schema directory. Now, when you attempt to migrate your database and no other migrations have been executed, Laravel will execute the schema file's SQL statements first. After executing the schema file's statements, Laravel will execute any remaining migrations that were not part of the schema dump.

You should commit your database schema file to source control so that other new developers on your team may quickly create your application's initial database structure.

{note} Migration squashing is only available for the MySQL, PostgreSQL, and SQLite databases and utilizes the database's command-line client. Schema dumps may not be restored to in-memory SQLite databases.

Migration Structure

A migration class contains two methods: up and down. The up method is used to add new tables, columns, or indexes to your database, while the down method should reverse the operations performed by the up method.

Within both of these methods, you may use the Laravel schema builder to expressively create and modify tables. To learn about all of the methods available on the Schema builder, check out its documentation. For example, the following migration creates a flights table:

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('airline');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('flights');
    }
}

Anonymous Migrations

As you may have noticed in the example above, Laravel will automatically assign a class name to all of the migrations that you generate using the make:migration command. However, if you wish, you may return an anonymous class from your migration file. This is primarily useful if your application accumulates many migrations and two of them have a class name collision:

<?php

use Illuminate\Database\Migrations\Migration;

return new class extends Migration
{
    //
};

Setting The Migration Connection

If your migration will be interacting with a database connection other than your application's default database connection, you should set the $connection property of your migration:

/**
 * The database connection that should be used by the migration.
 *
 * @var string
 */
protected $connection = 'pgsql';

/**
 * Run the migrations.
 *
 * @return void
 */
public function up()
{
    //
}

Running Migrations

To run all of your outstanding migrations, execute the migrate Artisan command:

php artisan migrate

If you would like to see which migrations have run thus far, you may use the migrate:status Artisan command:

php artisan migrate:status

Forcing Migrations To Run In Production

Some migration operations are destructive, which means they may cause you to lose data. In order to protect you from running these commands against your production database, you will be prompted for confirmation before the commands are executed. To force the commands to run without a prompt, use the --force flag:

php artisan migrate --force

Rolling Back Migrations

To roll back the latest migration operation, you may use the rollback Artisan command. This command rolls back the last "batch" of migrations, which may include multiple migration files:

php artisan migrate:rollback

You may roll back a limited number of migrations by providing the step option to the rollback command. For example, the following command will roll back the last five migrations:

php artisan migrate:rollback --step=5

The migrate:reset command will roll back all of your application's migrations:

php artisan migrate:reset

Roll Back & Migrate Using A Single Command

The migrate:refresh command will roll back all of your migrations and then execute the migrate command. This command effectively re-creates your entire database:

php artisan migrate:refresh

// Refresh the database and run all database seeds...
php artisan migrate:refresh --seed

You may roll back and re-migrate a limited number of migrations by providing the step option to the refresh command. For example, the following command will roll back and re-migrate the last five migrations:

php artisan migrate:refresh --step=5

Drop All Tables & Migrate

The migrate:fresh command will drop all tables from the database and then execute the migrate command:

php artisan migrate:fresh

php artisan migrate:fresh --seed

{note} The migrate:fresh command will drop all database tables regardless of their prefix. This command should be used with caution when developing on a database that is shared with other applications.

Tables

Creating Tables

To create a new database table, use the create method on the Schema facade. The create method accepts two arguments: the first is the name of the table, while the second is a closure which receives a Blueprint object that may be used to define the new table:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email');
    $table->timestamps();
});

When creating the table, you may use any of the schema builder's column methods to define the table's columns.

Checking For Table / Column Existence

You may check for the existence of a table or column using the hasTable and hasColumn methods:

if (Schema::hasTable('users')) {
    // The "users" table exists...
}

if (Schema::hasColumn('users', 'email')) {
    // The "users" table exists and has an "email" column...
}

Database Connection & Table Options

If you want to perform a schema operation on a database connection that is not your application's default connection, use the connection method:

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

In addition, a few other properties and methods may be used to define other aspects of the table's creation. The engine property may be used to specify the table's storage engine when using MySQL:

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

    // ...
});

The charset and collation properties may be used to specify the character set and collation for the created table when using MySQL:

Schema::create('users', function (Blueprint $table) {
    $table->charset = 'utf8mb4';
    $table->collation = 'utf8mb4_unicode_ci';

    // ...
});

The temporary method may be used to indicate that the table should be "temporary". Temporary tables are only visible to the current connection's database session and are dropped automatically when the connection is closed:

Schema::create('calculations', function (Blueprint $table) {
    $table->temporary();

    // ...
});

Updating Tables

The table method on the Schema facade may be used to update existing tables. Like the create method, the table method accepts two arguments: the name of the table and a closure that receives a Blueprint instance you may use to add columns or indexes to the table:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

Renaming / Dropping Tables

To rename an existing database table, use the rename method:

use Illuminate\Support\Facades\Schema;

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

To drop an existing table, you may use the drop or dropIfExists methods:

Schema::drop('users');

Schema::dropIfExists('users');

Renaming Tables With Foreign Keys

Before renaming a table, you should verify that any foreign key constraints on the table have an explicit name in your migration files instead of letting Laravel assign a convention based name. Otherwise, the foreign key constraint name will refer to the old table name.

Columns

Creating Columns

The table method on the Schema facade may be used to update existing tables. Like the create method, the table method accepts two arguments: the name of the table and a closure that receives an Illuminate\Database\Schema\Blueprint instance you may use to add columns to the table:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

Available Column Types

The schema builder blueprint offers a variety of methods that correspond to the different types of columns you can add to your database tables. Each of the available methods are listed in the table below:

bigIncrements() {.collection-method .first-collection-method}

The bigIncrements method creates an auto-incrementing UNSIGNED BIGINT (primary key) equivalent column:

$table->bigIncrements('id');

bigInteger() {.collection-method}

The bigInteger method creates a BIGINT equivalent column:

$table->bigInteger('votes');

binary() {.collection-method}

The binary method creates a BLOB equivalent column:

$table->binary('photo');

boolean() {.collection-method}

The boolean method creates a BOOLEAN equivalent column:

$table->boolean('confirmed');

char() {.collection-method}

The char method creates a CHAR equivalent column with of a given length:

$table->char('name', 100);

dateTimeTz() {.collection-method}

The dateTimeTz method creates a DATETIME (with timezone) equivalent column with an optional precision (total digits):

$table->dateTimeTz('created_at', $precision = 0);

dateTime() {.collection-method}

The dateTime method creates a DATETIME equivalent column with an optional precision (total digits):

$table->dateTime('created_at', $precision = 0);

date() {.collection-method}

The date method creates a DATE equivalent column:

$table->date('created_at');

decimal() {.collection-method}

The decimal method creates a DECIMAL equivalent column with the given precision (total digits) and scale (decimal digits):

$table->decimal('amount', $precision = 8, $scale = 2);

double() {.collection-method}

The double method creates a DOUBLE equivalent column with the given precision (total digits) and scale (decimal digits):

$table->double('amount', 8, 2);

enum() {.collection-method}

The enum method creates a ENUM equivalent column with the given valid values:

$table->enum('difficulty', ['easy', 'hard']);

float() {.collection-method}

The float method creates a FLOAT equivalent column with the given precision (total digits) and scale (decimal digits):

$table->float('amount', 8, 2);

foreignId() {.collection-method}

The foreignId method creates an UNSIGNED BIGINT equivalent column:

$table->foreignId('user_id');

foreignIdFor() {.collection-method}

The foreignIdFor method adds a {column}_id UNSIGNED BIGINT equivalent column for a given model class:

$table->foreignIdFor(User::class);

foreignUuid() {.collection-method}

The foreignUuid method creates a UUID equivalent column:

$table->foreignUuid('user_id');

geometryCollection() {.collection-method}

The geometryCollection method creates a GEOMETRYCOLLECTION equivalent column:

$table->geometryCollection('positions');

geometry() {.collection-method}

The geometry method creates a GEOMETRY equivalent column:

$table->geometry('positions');

id() {.collection-method}

The id method is an alias of the bigIncrements method. By default, the method will create an id column; however, you may pass a column name if you would like to assign a different name to the column:

$table->id();

increments() {.collection-method}

The increments method creates an auto-incrementing UNSIGNED INTEGER equivalent column as a primary key:

$table->increments('id');

integer() {.collection-method}

The integer method creates an INTEGER equivalent column:

$table->integer('votes');

ipAddress() {.collection-method}

The ipAddress method creates a VARCHAR equivalent column:

$table->ipAddress('visitor');

json() {.collection-method}

The json method creates a JSON equivalent column:

$table->json('options');

jsonb() {.collection-method}

The jsonb method creates a JSONB equivalent column:

$table->jsonb('options');

lineString() {.collection-method}

The lineString method creates a LINESTRING equivalent column:

$table->lineString('positions');

longText() {.collection-method}

The longText method creates a LONGTEXT equivalent column:

$table->longText('description');

macAddress() {.collection-method}

The macAddress method creates a column that is intended to hold a MAC address. Some database systems, such as PostgreSQL, have a dedicated column type for this type of data. Other database systems will use a string equivalent column:

$table->macAddress('device');

mediumIncrements() {.collection-method}

The mediumIncrements method creates an auto-incrementing UNSIGNED MEDIUMINT equivalent column as a primary key:

$table->mediumIncrements('id');

mediumInteger() {.collection-method}

The mediumInteger method creates a MEDIUMINT equivalent column:

$table->mediumInteger('votes');

mediumText() {.collection-method}

The mediumText method creates a MEDIUMTEXT equivalent column:

$table->mediumText('description');

morphs() {.collection-method}

The morphs method is a convenience method that adds a {column}_id UNSIGNED BIGINT equivalent column and a {column}_type VARCHAR equivalent column.

This method is intended to be used when defining the columns necessary for a polymorphic Eloquent relationship. In the following example, taggable_id and taggable_type columns would be created:

$table->morphs('taggable');

multiLineString() {.collection-method}

The multiLineString method creates a MULTILINESTRING equivalent column:

$table->multiLineString('positions');

multiPoint() {.collection-method}

The multiPoint method creates a MULTIPOINT equivalent column:

$table->multiPoint('positions');

multiPolygon() {.collection-method}

The multiPolygon method creates a MULTIPOLYGON equivalent column:

$table->multiPolygon('positions');

nullableTimestamps() {.collection-method}

The nullableTimestamps method is an alias of the timestamps method:

$table->nullableTimestamps(0);

nullableMorphs() {.collection-method}

The method is similar to the morphs method; however, the columns that are created will be "nullable":

$table->nullableMorphs('taggable');

nullableUuidMorphs() {.collection-method}

The method is similar to the uuidMorphs method; however, the columns that are created will be "nullable":

$table->nullableUuidMorphs('taggable');

point() {.collection-method}

The point method creates a POINT equivalent column:

$table->point('position');

polygon() {.collection-method}

The polygon method creates a POLYGON equivalent column:

$table->polygon('position');

rememberToken() {.collection-method}

The rememberToken method creates a nullable, VARCHAR(100) equivalent column that is intended to store the current "remember me" authentication token:

$table->rememberToken();

set() {.collection-method}

The set method creates a SET equivalent column with the given list of valid values:

$table->set('flavors', ['strawberry', 'vanilla']);

smallIncrements() {.collection-method}

The smallIncrements method creates an auto-incrementing UNSIGNED SMALLINT equivalent column as a primary key:

$table->smallIncrements('id');

smallInteger() {.collection-method}

The smallInteger method creates a SMALLINT equivalent column:

$table->smallInteger('votes');

softDeletesTz() {.collection-method}

The softDeletesTz method adds a nullable deleted_at TIMESTAMP (with timezone) equivalent column with an optional precision (total digits). This column is intended to store the deleted_at timestamp needed for Eloquent's "soft delete" functionality:

$table->softDeletesTz($column = 'deleted_at', $precision = 0);

softDeletes() {.collection-method}

The softDeletes method adds a nullable deleted_at TIMESTAMP equivalent column with an optional precision (total digits). This column is intended to store the deleted_at timestamp needed for Eloquent's "soft delete" functionality:

$table->softDeletes($column = 'deleted_at', $precision = 0);

string() {.collection-method}

The string method creates a VARCHAR equivalent column of the given length:

$table->string('name', 100);

text() {.collection-method}

The text method creates a TEXT equivalent column:

$table->text('description');

timeTz() {.collection-method}

The timeTz method creates a TIME (with timezone) equivalent column with an optional precision (total digits):

$table->timeTz('sunrise', $precision = 0);

time() {.collection-method}

The time method creates a TIME equivalent column with an optional precision (total digits):

$table->time('sunrise', $precision = 0);

timestampTz() {.collection-method}

The timestampTz method creates a TIMESTAMP (with timezone) equivalent column with an optional precision (total digits):

$table->timestampTz('added_at', $precision = 0);

timestamp() {.collection-method}

The timestamp method creates a TIMESTAMP equivalent column with an optional precision (total digits):

$table->timestamp('added_at', $precision = 0);

timestampsTz() {.collection-method}

The timestampsTz method creates created_at and updated_at TIMESTAMP (with timezone) equivalent columns with an optional precision (total digits):

$table->timestampsTz($precision = 0);

timestamps() {.collection-method}

The timestamps method creates created_at and updated_at TIMESTAMP equivalent columns with an optional precision (total digits):

$table->timestamps($precision = 0);

tinyIncrements() {.collection-method}

The tinyIncrements method creates an auto-incrementing UNSIGNED TINYINT equivalent column as a primary key:

$table->tinyIncrements('id');

tinyInteger() {.collection-method}

The tinyInteger method creates a TINYINT equivalent column:

$table->tinyInteger('votes');

tinyText() {.collection-method}

The tinyText method creates a TINYTEXT equivalent column:

$table->tinyText('notes');

unsignedBigInteger() {.collection-method}

The unsignedBigInteger method creates an UNSIGNED BIGINT equivalent column:

$table->unsignedBigInteger('votes');

unsignedDecimal() {.collection-method}

The unsignedDecimal method creates an UNSIGNED DECIMAL equivalent column with an optional precision (total digits) and scale (decimal digits):

$table->unsignedDecimal('amount', $precision = 8, $scale = 2);

unsignedInteger() {.collection-method}

The unsignedInteger method creates an UNSIGNED INTEGER equivalent column:

$table->unsignedInteger('votes');

unsignedMediumInteger() {.collection-method}

The unsignedMediumInteger method creates an UNSIGNED MEDIUMINT equivalent column:

$table->unsignedMediumInteger('votes');

unsignedSmallInteger() {.collection-method}

The unsignedSmallInteger method creates an UNSIGNED SMALLINT equivalent column:

$table->unsignedSmallInteger('votes');

unsignedTinyInteger() {.collection-method}

The unsignedTinyInteger method creates an UNSIGNED TINYINT equivalent column:

$table->unsignedTinyInteger('votes');

uuidMorphs() {.collection-method}

The uuidMorphs method is a convenience method that adds a {column}_id CHAR(36) equivalent column and a {column}_type VARCHAR equivalent column.

This method is intended to be used when defining the columns necessary for a polymorphic Eloquent relationship that use UUID identifiers. In the following example, taggable_id and taggable_type columns would be created:

$table->uuidMorphs('taggable');

uuid() {.collection-method}

The uuid method creates a UUID equivalent column:

$table->uuid('id');

year() {.collection-method}

The year method creates a YEAR equivalent column:

$table->year('birth_year');

Column Modifiers

In addition to the column types listed above, there are several column "modifiers" you may use when adding a column to a database table. For example, to make the column "nullable", you may use the nullable method:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

The following table contains all of the available column modifiers. This list does not include index modifiers:

Default Expressions

The default modifier accepts a value or an Illuminate\Database\Query\Expression instance. Using an Expression instance will prevent Laravel from wrapping the value in quotes and allow you to use database specific functions. One situation where this is particularly useful is when you need to assign default values to JSON columns:

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Query\Expression;
use Illuminate\Database\Migrations\Migration;

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->json('movies')->default(new Expression('(JSON_ARRAY())'));
            $table->timestamps();
        });
    }
}

{note} Support for default expressions depends on your database driver, database version, and the field type. Please refer to your database's documentation.

Column Order

When using the MySQL database, the after method may be used to add columns after an existing column in the schema:

$table->after('password', function ($table) {
    $table->string('address_line1');
    $table->string('address_line2');
    $table->string('city');
});

Modifying Columns

Prerequisites

Before modifying a column, you must install the doctrine/dbal package using the Composer package manager. The Doctrine DBAL library is used to determine the current state of the column and to create the SQL queries needed to make the requested changes to your column:

composer require doctrine/dbal

If you plan to modify columns created using the timestamp method, you must also add the following configuration to your application's config/database.php configuration file:

use Illuminate\Database\DBAL\TimestampType;

'dbal' => [
    'types' => [
        'timestamp' => TimestampType::class,
    ],
],

{note} If your application is using Microsoft SQL Server, please ensure that you install doctrine/dbal:^3.0.

Updating Column Attributes

The change method allows you to modify the type and attributes of existing columns. For example, you may wish to increase the size of a string column. To see the change method in action, let's increase the size of the name column from 25 to 50. To accomplish this, we simply define the new state of the column and then call the change method:

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

We could also modify a column to be nullable:

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

{note} The following column types can be modified: bigInteger, binary, boolean, date, dateTime, dateTimeTz, decimal, integer, json, longText, mediumText, smallInteger, string, text, time, unsignedBigInteger, unsignedInteger, unsignedSmallInteger, and uuid. To modify a timestamp column type a Doctrine type must be registered.

Renaming Columns

To rename a column, you may use the renameColumn method provided by the schema builder blueprint. Before renaming a column, ensure that you have installed the doctrine/dbal library via the Composer package manager:

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

{note} Renaming an enum column is not currently supported.

Dropping Columns

To drop a column, you may use the dropColumn method on the schema builder blueprint. If your application is utilizing an SQLite database, you must install the doctrine/dbal package via the Composer package manager before the dropColumn method may be used:

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

You may drop multiple columns from a table by passing an array of column names to the dropColumn method:

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

{note} Dropping or modifying multiple columns within a single migration while using an SQLite database is not supported.

Available Command Aliases

Laravel provides several convenient methods related to dropping common types of columns. Each of these methods is described in the table below:

Indexes

Creating Indexes

The Laravel schema builder supports several types of indexes. The following example creates a new email column and specifies that its values should be unique. To create the index, we can chain the unique method onto the column definition:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

Alternatively, you may create the index after defining the column. To do so, you should call the unique method on the schema builder blueprint. This method accepts the name of the column that should receive a unique index:

$table->unique('email');

You may even pass an array of columns to an index method to create a compound (or composite) index:

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

When creating an index, Laravel will automatically generate an index name based on the table, column names, and the index type, but you may pass a second argument to the method to specify the index name yourself:

$table->unique('email', 'unique_email');

Available Index Types

Laravel's schema builder blueprint class provides methods for creating each type of index supported by Laravel. Each index method accepts an optional second argument to specify the name of the index. If omitted, the name will be derived from the names of the table and column(s) used for the index, as well as the index type. Each of the available index methods is described in the table below:

Index Lengths & MySQL / MariaDB

By default, Laravel uses the utf8mb4 character set. If you are running a version of MySQL older than the 5.7.7 release or MariaDB older than the 10.2.2 release, you may need to manually configure the default string length generated by migrations in order for MySQL to create indexes for them. You may configure the default string length by calling the Schema::defaultStringLength method within the boot method of your App\Providers\AppServiceProvider class:

use Illuminate\Support\Facades\Schema;

/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Schema::defaultStringLength(191);
}

Alternatively, you may enable the innodb_large_prefix option for your database. Refer to your database's documentation for instructions on how to properly enable this option.

Renaming Indexes

To rename an index, you may use the renameIndex method provided by the schema builder blueprint. This method accepts the current index name as its first argument and the desired name as its second argument:

$table->renameIndex('from', 'to')

Dropping Indexes

To drop an index, you must specify the index's name. By default, Laravel automatically assigns an index name based on the table name, the name of the indexed column, and the index type. Here are some examples:

If you pass an array of columns into a method that drops indexes, the conventional index name will be generated based on the table name, columns, and index type:

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

Foreign Key Constraints

Laravel also provides support for creating foreign key constraints, which are used to force referential integrity at the database level. For example, let's define a user_id column on the posts table that references the id column on a users table:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::table('posts', function (Blueprint $table) {
    $table->unsignedBigInteger('user_id');

    $table->foreign('user_id')->references('id')->on('users');
});

Since this syntax is rather verbose, Laravel provides additional, terser methods that use conventions to provide a better developer experience. When using the foreignId method to create your column, the example above can be rewritten like so:

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained();
});

The foreignId method creates an UNSIGNED BIGINT equivalent column, while the constrained method will use conventions to determine the table and column name being referenced. If your table name does not match Laravel's conventions, you may specify the table name by passing it as an argument to the constrained method:

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained('users');
});

You may also specify the desired action for the "on delete" and "on update" properties of the constraint:

$table->foreignId('user_id')
      ->constrained()
      ->onUpdate('cascade')
      ->onDelete('cascade');

An alternative, expressive syntax is also provided for these actions:

Any additional column modifiers must be called before the constrained method:

$table->foreignId('user_id')
      ->nullable()
      ->constrained();

Dropping Foreign Keys

To drop a foreign key, you may use the dropForeign method, passing the name of the foreign key constraint to be deleted as an argument. Foreign key constraints use the same naming convention as indexes. In other words, the foreign key constraint name is based on the name of the table and the columns in the constraint, followed by a "_foreign" suffix:

$table->dropForeign('posts_user_id_foreign');

Alternatively, you may pass an array containing the column name that holds the foreign key to the dropForeign method. The array will be converted to a foreign key constraint name using Laravel's constraint naming conventions:

$table->dropForeign(['user_id']);

Toggling Foreign Key Constraints

You may enable or disable foreign key constraints within your migrations by using the following methods:

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

{note} SQLite disables foreign key constraints by default. When using SQLite, make sure to enable foreign key support in your database configuration before attempting to create them in your migrations. In addition, SQLite only supports foreign keys upon creation of the table and not when tables are altered.

Events

For convenience, each migration operation will dispatch an event. All of the following events extend the base Illuminate\Database\Events\MigrationEvent class: