스키마 빌더(Schema Builder)

• 소개
• 테이블 생성 & 삭제
• 컬럼 추가
• 컬럼 변경
• 컬럼 이름 변경
• 컬럼 삭제
• 존재 유무 확인
• 인덱스 추가
• 외래키
• 인덱스 삭제
• Timestamps와 Soft Deletes 컬럼 삭제
• 스토리지 엔진

소개

라라벨의 Schema 클래스는 데이터베이스에 의존하지 않는 테이블 조작 방법을 제공합니다. 이 기능은 라라벨이 지원하는 모든 데이터베이스에서 잘 동작하며 공통의 API를 가지고 있다는 것을 의미합니다.

테이블 생성 & 삭제

새로운 데이터베이스 테이블을 생성하기 위해서는 Schema::create 메소드를 사용합니다:

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

create 메소드의 첫 번째 인자는 테이블 이름을 나타내고 두 번째 인자는 새로운 테이블을 정의하는 데 사용되는 Blueprint 객체를받는 Closure입니다.

존재하는 데이터베이스 테이블 이름을 바꾸기 위해서는 rename 메소드를 사용하면 됩니다:

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

스키마 작업이 진행될 위치를 지정하고자 한다면 Schema::connection 메소드를 사용하면 됩니다:

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

테이블을 삭제하려면 Scheme::drop 메소드를 사용하면 됩니다:

Schema::drop('users');

Schema::dropIfExists('users');

컬럼 추가하기

존재하는 테이블을 수정하라면 Schema::table 메소드를 사용하게 될것입니다:

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

테이블 빌더에는 테이블을 만들 때 사용할 수 있는 다양한 컬럼의 종류들을 가지고 있습니다:

Mysql에서 After 사용하기

만약 MySQL 데이터베이스를 사용하고 있다면 컬럼의 순서지정을 위해서 after 메소드를 사용할 수 있습니다:

$table->string('name')->after('email');

컬럼 변경

주의: 컬럼을 변경하기 전에 composer.json에 doctrine/dbal 의존 패키지를 추가했는지 확인하십시오.

때로는 이미 생성된 컬럼을 수정해야 할 필요가 있습니다. 예를 들어, 문자열 컬럼의 사이즈를 늘리고자 할 경우가 그렇습니다. change 메소드가 이 역할을 수행합니다! 예를 들어, 다음 예제는 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 메소드를 사용하면 됩니다. 컬럼이름을 변경하기 전에 composer.json에 doctrine/dbal 의존성을 추가했는지 확인하십시오.

(역자주 컬럼 이름 변경을 사용하기 위해서는 composer.json의 require에 doctrine/dbal을 추가해서 composer를 업데이트 해준 상태여야 합니다.)

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

주의 : 현재 enum 컬럼 타입의 이름을 변경하는 것은 지원되지 않습니다.

컬럼 삭제

컬럼을 삭제하고자 한다면 스키마 빌더에서 dropColumn 메소드를 사용하면 됩니다. 앞서 컬럼 이름 변경과 마찬가지로 컬럼 삭제 작업을 수행하기 전에 composer.json에 doctrine/dbal 의존성을 추가해주어야 합니다.

데이터베이스 테이블에서 컬럼 삭제하기

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

데이터베이스 테이블에서 다수의 컬럼 삭제하기

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

존재 유무 확인

테이블이 존재하는지 확인하기

테이블이나 컬럼이 존재하는지 확인하는 것은 hasTable과 hasColumn 메소드르 사용하여 쉽게 확인할 수 있습니다:

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

컬럼이 존재하는지 확인하기

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

인덱스 추가하기

스키마 빌더는 여러 가지 타입의 인덱스들을 지원합니다. 인덱스를 추가하는 데에는 두 가지 방법이 있습니다. 첫 번째는 컬럼을 정의하면서 동시에 인덱스를 추가하는 것이고, 두 번째는 이를 분리해서 작업하는 것입니다: $table->string('email')->unique();

인덱스를 추가하는 것을 라인을 나눠서 할 수도 있습니다. 아래의 예는 사용할 수 있는 인덱스 타입들의 목록입니다:

외래키

라라벨은 테이블에 외래키 제약을 거는것도 지원합니다:

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

이 예에서 user_id 컬럼이users테이블에 id컬럼을 참조한다는 것을 선언 하고 있습니다. 외래키 컬럼을 먼저 생성하는것을 잊지 마십시오!

또한, 외래키 옵션인 "on delete”와 "on update"에 대한 처리를 지정할 수 있습니다:

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

외래키를 삭제하려면 dropForeign 메소드를 사용하면 됩니다. 다른 인덱스에서 사용되는 것과 유사한 인덱스 이름 명명 규칙이 외래 키에도 사용되고 있습니다:

$table->dropForeign('posts_user_id_foreign');

주의: 정수형 증분되는 값(incrementing integer)을 참조하여 외래키를 만들때 외래키 컬럼을 항상 unsigned로 만드는 것을 유의해야 합니다.

인덱스 삭제하기

인덱스를 삭제하려면 인덱스 이름을 지정해야 합니다. 라라벨은 기본적으로 인덱스에 자체적인 의미가 있는 이름을 할당한다. 간단하게 테이블 이름, 인덱스가 있는 컬럼의 이름, 인데스 타입을 연결한 것입니다. 몇 가지 예제입니다:

Timestamps와 softDeletes 컬럼 삭제

timestamps, nullableTimestamps, softDeletes타입의 컬럼을 삭제하려면 다음과 같은 메소드들을 사용합니다:

스토리지 엔진

테이블에 스토리지 엔진을 지정하려면 스키마 빌더에서 engine 속성을 지정하면 됩니다:

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

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

Schema Builder

• Introduction
• Creating & Dropping Tables
• Adding Columns
• Changing Columns
• Renaming Columns
• Dropping Columns
• Checking Existence
• Adding Indexes
• Foreign Keys
• Dropping Indexes
• Dropping Timestamps & Soft Deletes
• Storage Engines

Introduction

The Laravel Schema class provides a database agnostic way of manipulating tables. It works well with all of the databases supported by Laravel, and has a unified API across all of these systems.

Creating & Dropping Tables

To create a new database table, the Schema::create method is used:

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

The first argument passed to the create method is the name of the table, and the second is a Closure which will receive a Blueprint object which may be used to define the new table.

To rename an existing database table, the rename method may be used:

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

To specify which connection the schema operation should take place on, use the Schema::connection method:

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

To drop a table, you may use the Schema::drop method:

Schema::drop('users');

Schema::dropIfExists('users');

Adding Columns

To update an existing table, we will use the Schema::table method:

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

The table builder contains a variety of column types that you may use when building your tables:

Using After On MySQL

If you are using the MySQL database, you may use the after method to specify the order of columns:

$table->string('name')->after('email');

Changing Columns

Note: Before changing a column, be sure to add the doctrine/dbal dependency to your composer.json file.

Sometimes you may need to modify an existing column. For example, you may wish to increase the size of a string column. The change method makes it easy! For example, let's increase the size of the name column from 25 to 50:

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

We could also modify a column to be nullable:

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

Renaming Columns

To rename a column, you may use the renameColumn method on the Schema builder. Before renaming a column, be sure to add the doctrine/dbal dependency to your composer.json file.

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

Note: Renaming columns in a table with enum column is currently not supported.

Dropping Columns

To drop a column, you may use the dropColumn method on the Schema builder. Before dropping a column, be sure to add the doctrine/dbal dependency to your composer.json file.

Dropping A Column From A Database Table

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

Dropping Multiple Columns From A Database Table

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

Checking Existence

Checking For Existence Of Table

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

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

Checking For Existence Of Columns

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

Adding Indexes

The schema builder supports several types of indexes. There are two ways to add them. First, you may fluently define them on a column definition, or you may add them separately:

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

Or, you may choose to add the indexes on separate lines. Below is a list of all available index types:

Foreign Keys

Laravel also provides support for adding foreign key constraints to your tables:

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

In this example, we are stating that the user_id column references the id column on the users table. Make sure to create the foreign key column first!

You may also specify options for the "on delete" and "on update" actions of the constraint:

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

To drop a foreign key, you may use the dropForeign method. A similar naming convention is used for foreign keys as is used for other indexes:

$table->dropForeign('posts_user_id_foreign');

Note: When creating a foreign key that references an incrementing integer, remember to always make the foreign key column unsigned.

Dropping Indexes

To drop an index you must specify the index's name. Laravel assigns a reasonable name to the indexes by default. Simply concatenate the table name, the names of the column in the index, and the index type. Here are some examples:

Dropping Timestamps & SoftDeletes

To drop the timestamps, nullableTimestamps or softDeletes column types, you may use the following methods:

Storage Engines

To set the storage engine for a table, set the engine property on the schema builder:

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

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