Миграции

Введение

Миграции — что-то вроде системы контроля версий для вашей базы данных. Они позволяют вашей команде изменять структуру БД, в то же время оставаясь в курсе изменений других участников. Миграции обычно идут рука об руку с построителем структур для более простого обращения с архитектурой вашей базы данных. Если вы когда-нибудь просили коллегу вручную добавить столбец в его локальную БД, значит вы сталкивались с проблемой, которую решают миграции БД.

Фасад Laravel Schema обеспечивает поддержку создания и изменения таблиц в независимости от используемой СУБД из числа тех, что поддерживаются в Laravel.

Создание миграций

Для создания новой миграции используйте Artisan-команду shmake:migration:

shphp artisan make:migration create_users_table

Миграция будет помещена в папку database/migrations и будет содержать метку времени, которая позволяет фреймворку определять порядок применения миграций.

Можно также использовать параметры --table и --create для указания имени таблицы и того факта, что миграция будет создавать новую таблицу (а не изменять существующую — прим. пер.). Эти параметры просто заранее создают указанную таблицу в создаваемом файле-заглушке миграции:

shphp artisan make:migration create_users_table --create=users

php artisan make:migration add_votes_to_users_table --table=users

Если вы хотите указать свой путь для сохранения создаваемых миграций, используйте параметр --path при запуске команды shmake:migration. Этот путь должен быть указан относительно базового пути вашего приложения.

Структура миграций

Класс миграций содержит два метода: PHPup() и PHPdown(). Метод PHPup() используется для добавления новых таблиц, столбцов или индексов в вашу БД, а метод PHPdown() просто отменяет операции, выполненные методом PHPup().

В обоих методах вы можете использовать построитель структур Laravel для удобного создания и изменения таблиц. О всех доступных методах построителя структур читайте в его документации. Например, эта миграция создаёт таблицу flights:

<?php

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

class CreateFlightsTable extends Migration
{
  /**
   * Выполнение миграций.
   *
   * @return void
   */
  public function up()
  {
    Schema::create('flights', function (Blueprint $table) {
      $table->increments('id');
      $table->string('name');
      $table->string('airline');
      $table->timestamps();
    });
  }

  /**
   * Отмена миграций.
   *
   * @return void
   */
  public function down()
  {
    Schema::drop('flights');
  }
}

Выполнение миграций

Для запуска всех необходимых вам миграций используйте Artisan-команду shmigrate.

shphp artisan migrate

Если вы используете виртуальную машину Homestead, вам надо выполнить эту команду на ВМ.

Принудительные миграции в продакшне

Некоторые операции миграций разрушительны, значит они могут привести к потере ваших данных. Для предотвращения случайного запуска этих команд на вашей боевой БД перед их выполнением запрашивается подтверждение. Для принудительного запуска команд без подтверждения используйте ключ sh--force:

shphp artisan migrate --force

Откат миграций

Для отмены изменений, сделанных последней миграцией, используйте команду shrollback. Эта команда отменит результат последней «партии» миграций, которая может включать несколько файлов миграций:

shphp artisan migrate:rollback

shphp artisan migrate:rollback --step=5

Команда shmigrate:reset отменит изменения всех миграций вашего приложения:

shphp artisan migrate:reset

Откат всех миграций и их повторное применение одной командой

Команда shmigrate:refresh отменит изменения всех ваших миграций, а затем выполнит команду shmigrate. Эта команда эффективно создаёт заново всю вашу БД:

shphp artisan migrate:refresh

// Обновить БД и запустить заполнение БД начальными данными...
php artisan migrate:refresh --seed

shphp artisan migrate:refresh --step=5

Таблицы

Создание таблиц

Для создания новой таблицы БД используйте метод PHPcreate() фасада Schema. Метод PHPcreate() принимает два аргумента. Первый — имя таблицы, второй — замыкание, которое получает объект Blueprint, который можно использовать для определения новой таблицы:

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

Само собой, при создании таблицы вы можете использовать любые методы для работы со столбцами построителя структур.

Проверка существования таблицы/столбца

Вы можете легко проверить существование таблицы или столбца при помощи методов PHPhasTable() и PHPhasColumn():

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

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

Подключение и подсистема хранения данных

Если вы хотите выполнить операции над структурой через подключение к БД, которое не является вашим основным подключением, используйте метод PHPconnection():

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

Используйте свойство engine построителя структур, чтобы задать подсистему хранения данных для таблицы:

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

  $table->increments('id');
});

Переименование/удаление таблиц

Для переименования существующей таблицы используйте метод PHPrename():

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

Для удаления существующей таблицы используйте методы PHPdrop() и PHPdropIfExists():

Schema::drop('users');

Schema::dropIfExists('users');

Столбцы

Создание столбцов

Для изменения существующей таблицы мы будем использовать метод PHPtable() фасада Schema. Как и метод PHPcreate(), метод PHPtable() принимает два аргумента: имя таблицы и замыкание, которое получает экземпляр Blueprint, который можно использовать для добавления столбцов в таблицу:

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

Доступные типы столбцов

Разумеется, построитель структур содержит различные типы столбцов, которые вы можете указывать при построении ваших таблиц:

Модификаторы столбцов

Вдобавок к перечисленным типам столбцов существует несколько «модификаторов» столбцов, которые вы можете использовать при добавлении столбцов в таблицу. Например, чтобы сделать столбец «обнуляемым», используйте метод PHPnullable():

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

Ниже перечислены все доступные модификаторы столбцов. В этом списке отсутствуют модификаторы индексов:

Изменение столбцов

Требования

Перед изменением столбцов добавьте зависимость doctrine/dbal в свой файл composer.json. Библиотека Doctrine DBAL используется для определения текущего состояния столбца и создания SQL-запросов, необходимых для выполнения указанных преобразований столбца:

shcomposer require doctrine/dbal

Изменение атрибутов столбца

Метод PHPchange() позволяет изменить тип существующего столбца или изменить его атрибуты. Например, если вы захотите увеличить размер строкового столбца name с 25 до 50:

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

Также мы можем изменить столбец, чтобы он стал «обнуляемым»:

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

Переименование столбцов

Для переименования столбца используйте метод PHPrenameColumn() на построителе структур. Перед переименованием столбца добавьте зависимость doctrine/dbal в свой файл composer.json:

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

Пока не поддерживается переименование любых столбцов в таблице, содержащей столбцы типов enum, а для версий 5.2 и ранее ещё и json или jsonb.

Удаление столбцов

Для удаления столбца используйте метод PHPdropColumn() на построителе структур. Перед удалением столбцов из базы данных SQLite вам необходимо добавить зависимость doctrine/dbal в ваш файл composer.json и выполнить команду shcomposer update для установки библиотеки:

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

Вы можете удалить несколько столбцов таблицы, передав массив их имён в метод PHPdropColumn():

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

Удаление и изменение нескольких столбцов одной миграцией не поддерживается для базы данных SQLite.

Индексы

Создание индексов

Построитель структур поддерживает несколько типов индексов. Сначала давайте посмотрим на пример, в котором задаётся, что значения столбца должны быть уникальными. Для создания индекса мы можем просто сцепить метод PHPunique() с определением столбца:

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

Другой вариант — создать индекс после определения столбца. Например:

$table->unique('email');

Вы можете даже передать массив столбцов в метод PHPindex() для создания сложного индекса:

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

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

Доступные типы индексов

Удаление индексов

Для удаления индекса необходимо указать его имя. По умолчанию Laravel автоматически назначает имена индексам. Просто соедините имя таблицы, имя столбца-индекса и тип индекса. Вот несколько примеров:

Если вы передадите массив столбцов в метод для удаления индексов, будет сгенерировано стандартное имя индекса на основе имени таблицы, столбца и типа ключа:

Schema::table('geo', function (Blueprint $table) {
  $table->dropIndex(['state']); // Удаление индекса 'geo_state_index'
});

Ограничения внешнего ключа

Laravel также поддерживает создание ограничений для внешнего ключа, которые используются для обеспечения ссылочной целостности на уровне базы данных. Например, давайте определим столбец user_id в таблице posts, который ссылается на столбец id в таблице users:

Schema::table('posts', function (Blueprint $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');

Для удаления внешнего ключа используйте метод PHPdropForeign(). Ограничения внешнего ключа используют те же принципы именования, что и индексы. Итак, мы соединим имя таблицы и столбцов из ограничения, а затем добавим суффикс "_foreign":

$table->dropForeign('posts_user_id_foreign');

Либо вы можете передать значение массива, при этом для удаления будет автоматически использовано стандартное имя ограничения:

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

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

class DatabaseSeeder extends Seeder {

  public function run()
  {
    $this->call('UserTableSeeder');

    $this->command->info('Таблица пользователей загружена данными!');
  }

}

class UserTableSeeder extends Seeder {

  public function run()
  {
    DB::table('users')->delete();

    User::create(['email' => 'foo@bar.com']);
  }

}

shphp artisan db:seed

shphp artisan db:seed --class=UserTableSeeder

shphp artisan migrate:refresh --seed