Структура базы данных и начальные данные

# Введение

Миграции и начальные данные позволяют Вам изменять и заполнять таблицы в БД при помощи файла version.yaml, который содержит в себе информацию о версиях плагина и находится в его папке в подпапке updates. Миграции должны описывать историю изменений базы данных, и эта история может быть воспроизведена как вперед, так и назад, чтобы создавать и удалять таблицы.

# Структура миграции (Migration Structure)

Файл с миграцией должен содержать в себе класс, который является наследником класса October\Rain\Database\Updates\Migration, и должен содержать два публичных метода: up() и down(). Имя класса должно совпадать с именем файла. Пример:

<?php namespace Acme\Blog\Updates;

use Schema;
use October\Rain\Database\Updates\Migration;

class CreatePostsTable extends Migration
{
    public function up()
    {
        Schema::create('october_blog_posts', function($table)
        {
            $table->engine = 'InnoDB';
            $table->increments('id');
            $table->string('title');
            $table->string('slug')->index();
            $table->text('excerpt')->nullable();
            $table->text('content');
            $table->timestamp('published_at')->nullable();
            $table->boolean('is_published')->default(false);
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::drop('october_blog_posts');
    }
}

# Создание таблиц (Creating Tables)

Используйте метод create фасада Schema, чтобы создать новую таблицу. Метода принимает два аргумента: название таблицы и Closure:

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

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

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

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

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

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

# Подключение и Движок Хранилища (Connection & Storage Engine)

Если требуется использовать подключение, отличное от дефолтного, используйте метод connection:

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

Для установки движка таблицы, задайте свойство engine:

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

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

# Переименование/удаление таблиц (Renaming / Dropping Tables)

Используйте метод rename, чтобы переименовать существующую таблицу:

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

Используйте метод drop или dropIfExists, чтобы удалить существующую таблицу:

Schema::drop('users');

Schema::dropIfExists('users');

# Создание столбцов (Creating Columns)

Для изменения существующей таблицы используйте метод table фасада Schema. Подобно методу create метод table принимает два аргумента: имя таблицы и замыкание, которое получает в качестве аргумента объект. Добавление столбца в таблицу:

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

# Доступные типы столбцов (Available Column Types)

Перечень доступных типов в классе конструкторе схемы:

# Модификация столбцов (Column Modifiers)

В дополнение к типам, перечисленным выше, доступны модификаторы столбцов, которые можно использовать при добавлении столбца. Добавим столбцу возможность принимать значения NULL:

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

Ниже приведен список доступных модификаторов. Список не включает индексные модификаторы index modifiers:

# Изменение столбцов (Modifying Columns)

Используйте метод 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();
});

# Переименование столбцов (Renaming Columns)

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

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

Примечание: Переименование столбцов типа enum на текущий момент не поддерживается.

# Удаление столбцов (Dropping Columns)

Используйте метод dropColumn, чтобы удалить столбец:

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

Вы также можете удалить сразу несколько столбцов:

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

# Создание индексов (Creating Indexes)

Используйте метод unique, чтобы создать индексы:

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

Создание индекса для существующего столбца:

$table->unique('email');

Индекс на основе нескольких столбцов:

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

October автоматически генерирует имя индекса, но можно указать его самому в качестве второго параметра:

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

# Доступные типа индексов (Available Index Types)

# Удаление индексов (Dropping Indexes)

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

# Ограничения внешнего ключа (Foreign Key Constraints)

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

Schema::table('posts', function ($table) {
    $table->integer('user_id')->unsigned();

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

Вы можете указать имя для ограничения вручную, передав второй аргумент методу foreign:

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

Вы также можете указать желаемое действие для свойств "on delete" и "on update":

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

Используйте метод dropForeign, чтобы удалить внешний ключ. Название внешнего ключа формируется аналогично названию индексов. Пример:

$table->dropForeign('posts_user_id_foreign');

# Структура начальных данных (Seeder structure)

По умолчанию класс-наполнитель содержит только один метод: run и должен расширять класс Seeder. Метод run вызывается при запуске обновления. В методе run Вы можете вставлять произвольные данные в БД любым удобным способом. Вы можете использовать конструктор запросов для ручной вставки или использовать модель. Пример:

<?php namespace Acme\Users\Updates;

use Seeder;
use Acme\Users\Models\User;

class SeedUsersTable extends Seeder
{
    public function run()
    {
        $user = User::create([
            'email'                 => 'user@user.com',
            'login'                 => 'user',
            'password'              => 'user',
            'password_confirmation' => 'user',
            'first_name'            => 'Adam',
            'last_name'             => 'Person',
            'is_activated'          => true
        ]);

        $user = Db::table('users')->create([
            'email'                 => 'user@user.com',
            'login'                 => 'user',
            [...]
        ]);
    }
}

# Вызов дополнительных наполнителей

В классе DatabaseSeeder можно использовать метод call для запуска дополнительных классов-наполнителей.м Просто передай методу желаемый класс-наполнитель для его запуска:

/**
 * Run the database seeds.
 *
 * @return void
 */
public function run()
{
    Model::unguard();

    $this->call('Acme\Users\Updates\UserTableSeeder');
    $this->call('Acme\Users\Updates\PostsTableSeeder');
    $this->call('Acme\Users\Updates\CommentsTableSeeder');
}