데이터베이스: 시딩

소개

Laravel은 시드 클래스를 사용하여 데이터베이스에 데이터를 시딩할 수 있는 기능을 제공합니다. 모든 시드 클래스는 database/seeders 디렉터리에 저장됩니다. 기본적으로 DatabaseSeeder 클래스가 정의되어 있습니다. 이 클래스에서 call 메서드를 사용하여 다른 시드 클래스를 실행할 수 있으며, 이를 통해 시딩 순서를 제어할 수 있습니다.

NOTE

데이터베이스 시딩 중에는 대량 할당 보호가 자동으로 비활성화됩니다.

시더 작성하기

시더를 생성하려면 make:seeder Artisan 명령어를 실행하세요. 프레임워크에서 생성된 모든 시더는 database/seeders 디렉터리에 위치하게 됩니다:

php artisan make:seeder UserSeeder

시더 클래스는 기본적으로 하나의 메서드만 포함합니다: run. 이 메서드는 db:seed Artisan 명령어가 실행될 때 호출됩니다. run 메서드 내에서 원하는 방식으로 데이터베이스에 데이터를 삽입할 수 있습니다. 쿼리 빌더를 사용하여 수동으로 데이터를 삽입하거나, Eloquent 모델 팩토리를 사용할 수 있습니다.

예를 들어, 기본 DatabaseSeeder 클래스를 수정하여 run 메서드에 데이터베이스 삽입 구문을 추가해보겠습니다:

<?php

namespace Database\Seeders;

use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;

class DatabaseSeeder extends Seeder
{
    /**
     * 데이터베이스 시더 실행.
     */
    public function run(): void
    {
        DB::table('users')->insert([
            'name' => Str::random(10),
            'email' => Str::random(10).'@example.com',
            'password' => Hash::make('password'),
        ]);
    }
}

NOTE

run 메서드의 시그니처에 필요한 의존성을 타입힌트로 지정할 수 있습니다. 이들은 Laravel 서비스 컨테이너를 통해 자동으로 주입됩니다.

모델 팩토리 사용하기

물론, 각 모델 시드의 속성을 수동으로 지정하는 것은 번거로운 일입니다. 대신, 모델 팩토리를 사용하여 대량의 데이터베이스 레코드를 편리하게 생성할 수 있습니다. 먼저, 모델 팩토리 문서를 참고하여 팩토리를 정의하는 방법을 확인하세요.

예를 들어, 각각 하나의 관련 포스트를 가진 사용자 50명을 생성해보겠습니다:

use App\Models\User;

/**
 * 데이터베이스 시더 실행.
 */
public function run(): void
{
    User::factory()
        ->count(50)
        ->hasPosts(1)
        ->create();
}

추가 시더 호출하기

DatabaseSeeder 클래스 내에서 call 메서드를 사용하여 추가 시드 클래스를 실행할 수 있습니다. call 메서드를 사용하면 데이터베이스 시딩을 여러 파일로 분리할 수 있어, 하나의 시더 클래스가 너무 커지지 않도록 할 수 있습니다. call 메서드는 실행할 시더 클래스의 배열을 인수로 받습니다:

/**
 * 데이터베이스 시더 실행.
 */
public function run(): void
{
    $this->call([
        UserSeeder::class,
        PostSeeder::class,
        CommentSeeder::class,
    ]);
}

모델 이벤트 비활성화

시드를 실행하는 동안 모델이 이벤트를 디스패치하지 않도록 하고 싶을 수 있습니다. 이를 위해 WithoutModelEvents 트레이트를 사용할 수 있습니다. 이 트레이트를 사용하면, call 메서드를 통해 추가 시드 클래스가 실행되더라도 어떤 모델 이벤트도 디스패치되지 않습니다:

<?php

namespace Database\Seeders;

use Illuminate\Database\Seeder;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;

class DatabaseSeeder extends Seeder
{
    use WithoutModelEvents;

    /**
     * 데이터베이스 시더 실행.
     */
    public function run(): void
    {
        $this->call([
            UserSeeder::class,
        ]);
    }
}

시더 실행하기

db:seed Artisan 명령어를 실행하여 데이터베이스를 시딩할 수 있습니다. 기본적으로 db:seed 명령어는 Database\Seeders\DatabaseSeeder 클래스를 실행하며, 이 클래스에서 다른 시드 클래스를 호출할 수 있습니다. 하지만, --class 옵션을 사용하여 특정 시더 클래스를 개별적으로 실행할 수도 있습니다:

php artisan db:seed

php artisan db:seed --class=UserSeeder

또한, migrate:fresh 명령어와 --seed 옵션을 조합하여 데이터베이스를 시딩할 수 있습니다. 이 명령어는 모든 테이블을 삭제하고 모든 마이그레이션을 다시 실행합니다. 데이터베이스를 완전히 재구성할 때 유용합니다. --seeder 옵션을 사용하여 특정 시더를 지정할 수도 있습니다:

php artisan migrate:fresh --seed

php artisan migrate:fresh --seed --seeder=UserSeeder

프로덕션 환경에서 시더 강제 실행

일부 시딩 작업은 데이터를 변경하거나 손실시킬 수 있습니다. 프로덕션 데이터베이스에서 시딩 명령어를 실행하는 것을 방지하기 위해, production 환경에서 시더가 실행되기 전에 확인 메시지가 표시됩니다. 프롬프트 없이 시더를 강제로 실행하려면 --force 플래그를 사용하세요:

php artisan db:seed --force