Конструктор таблиц

Статистика: Символов — 7 861/6 718 без пробелов (4 795/4 123 без кода):, слов — 673
Разметка: Wiki
{{TOC}}

{{DOCVER 5.0=f6e862ba51a97f2bf9865f35fd5c522c14af93a1 31.07.2015 15:36:24}}

.(alert)
Данная статья документации актуальна только для версии 5.0 и была удалена в версии 5.1.

== Введение ==
В Laravel, класс %%Schema%% представляет собой независимый от БД интерфейс манипулирования таблицами. Он хорошо работает со всеми СУБД, поддерживаемыми Laravel, и предоставляет унифицированный API для любой из этих систем.

== Создание и удаление таблиц ==
Для создания новой таблицы используется метод %%Schema::create()%%:
%%
Schema::create('users', function($table)
{
  $table->increments('id');
});
%%

Первый аргумент метода %%create()%% - имя таблицы, а второй - замыкание, которое получает объект %%Blueprint%%, использующийся для заполнения новой таблицы.

Чтобы переименовать существующую таблицу используется метод %%rename()%%:
%%
Schema::rename($from, $to);
%%

Для указания того, какое  подключение к БД должно использоваться для выполнения операции, используется метод %%Schema::connection()%%:
%%
Schema::connection('foo')->create('users', function($table)
{
  $table->increments('id');
});
%%

Для удаления таблицы вы можете использовать метод %%Schema::drop()%%:
%%
Schema::drop('users');

Schema::dropIfExists('users');
%%

== Добавление полей ==
Для обновления существующей таблицы мы будем использовать метод %%Schema::table()%%:
%%
Schema::table('users', function($table)
{
  $table->string('email');
});
%%

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

%%(hvlraw)
  <table>
    <tr>
      <th>Команда</th>
      <th>Описание</th>
    </tr>
    <tr>
      <td><kbd>$table->bigIncrements('id');</kbd></td>
      <td>Первичный последовательный ключ типа <strong>BIGINT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->bigInteger('votes');</kbd></td>
      <td>Поле <strong>BIGINT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->binary('data');</kbd></td>
      <td>Поле <strong>BLOB</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->boolean('confirmed');</kbd></td>
      <td>Поле <strong>BOOLEAN</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->char('name', 4);</kbd></td>
      <td>Поле <strong>CHAR</strong> с указанной длиной</td>
    </tr>
    <tr>
      <td><kbd>$table->date('created_at');</kbd></td>
      <td>Поле <strong>DATE</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->dateTime('created_at');</kbd></td>
      <td>Поле <strong>DATETIME</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->decimal('amount', 5, 2);</kbd></td>
      <td>Поле <strong>DECIMAL</strong> с указанной размерностью и точностью</td>
    </tr>
    <tr>
      <td><kbd>$table->double('column', 15, 8);</kbd></td>
      <td>Поле <strong>DOUBLE</strong> с указанной точностью</td>
    </tr>
    <tr>
      <td><kbd>$table->enum('choices', ['foo', 'bar']);</kbd></td>
      <td>Поле <strong>ENUM</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->float('amount');</kbd></td>
      <td>Поле <strong>FLOAT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->increments('id');</kbd></td>
      <td>Первичный последовательный ключ (<em>autoincrement</em>)</td>
    </tr>
    <tr>
      <td><kbd>$table->integer('votes');</kbd></td>
      <td>Поле <strong>INTEGER</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->json('options');</kbd></td>
      <td>Поле <strong>JSON</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->jsonb('options');</kbd></td>
      <td>Поле <strong>JSONB</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->longText('description');</kbd></td>
      <td>Поле <strong>LONGTEXT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->mediumInteger('numbers');</kbd></td>
      <td>Поле <strong>MEDIUMINT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->mediumText('description');</kbd></td>
      <td>Поле <strong>MEDIUMTEXT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->morphs('taggable');</kbd></td>
      <td>Добавляет <strong>INTEGER</strong> поле <kbd>taggable_id</kbd> и <strong>STRING</strong> поле <kbd>taggable_type</kbd></td>
    </tr>
    <tr>
      <td><kbd>$table->nullableTimestamps();</kbd></td>
      <td>То же что и <kbd>timestamps()</kbd>, но разрешены значения <strong>NULL</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->smallInteger('votes');</kbd></td>
      <td>Поле <strong>SMALLINT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->tinyInteger('numbers');</kbd></td>
      <td>Поле <strong>TINYINT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->softDeletes();</kbd></td>
      <td>Добавляет поле <kbd>deleted_at</kbd> для <a href="/docs/v5/eloquent#мягкое">мягкого удаления</a></td>
    </tr>
    <tr>
      <td><kbd>$table->string('email');</kbd></td>
      <td>Поле <strong>VARCHAR</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->string('name', 100);</kbd></td>
      <td>Поле <strong>VARCHAR</strong> с указанной длиной</td>
    </tr>
    <tr>
      <td><kbd>$table->text('description');</kbd></td>
      <td>Поле <strong>TEXT</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->time('sunrise');</kbd></td>
      <td>Поле <strong>TIME</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->timestamp('added_on');</kbd></td>
      <td>Поле <strong>TIMESTAMP</strong></td>
    </tr>
    <tr>
      <td><kbd>$table->timestamps();</kbd></td>
      <td>Добавляет поля <kbd>created_at</kbd> и <kbd>updated_at</kbd></td>
    </tr>
    <tr>
      <td><kbd>$table->rememberToken();</kbd></td>
      <td>Добавляет поле <kbd>remember_token</kbd> с типом <strong>VARCHAR(100) NULL</strong></td>
    </tr>
    <tr>
      <td><kbd>->nullable()</kbd></td>
      <td>Указывает, что поле может быть <strong>NULL</strong></td>
    </tr>
    <tr>
      <td><kbd>->default($value)</kbd></td>
      <td>Указывает значение по умолчанию для поля</td>
    </tr>
    <tr>
      <td><kbd>->unsigned()</kbd></td>
      <td>Переводит <strong>INTEGER</strong> в беззнаковое число <strong>UNSIGNED</strong></td>
    </tr>
  </table>
%%

**Вставка поля после существующего в MySQL**

Если вы используете MySQL, то метод %%after()%% позволит вам вставить поле после определённого существующего поля:
%%
$table->string('name')->after('email');
%%

== Изменение полей ==
.(alert)
**Внимание:** Перед изменением полей не забудьте добавить зависимость %%(t)doctrine/dbal%% в свой файл %%(t)composer.json%%.

Иногда необходимо изменить существующее поле. Например, если надо увеличить размер строкового поля. С методом %%change()%% это легко! Давайте увеличим размер поля %%(t)name%% с 25 до 50:
%%
Schema::table('users', function($table)
{
  $table->string('name', 50)->change();
});
%%

Также мы можем сделать поле обнуляемым (nullable):
%%
Schema::table('users', function($table)
{
  $table->string('name', 50)->nullable()->change();
});
%%

== Переименование полей ==
Для переименования поля можно использовать метод %%renameColumn()%% объекта конструктора. Перед переименованием полей не забудьте добавить зависимость %%(t)doctrine/dbal%% в ваш файл %%(t)composer.json%%.
%%
Schema::table('users', function($table)
{
  $table->renameColumn('from', 'to');
});
%%

.(alert)
**Внимание:** Переименование полей типа **ENUM** не поддерживается.

== Удаление полей ==
Для удаления поля можно использовать метод конструктора таблиц %%dropColumn()%%. Перед удалением поля убедитесь, что в файл %%(t)composer.json%% добавлена зависимость %%(conf)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();
%%

Или вы можете добавлять их отдельными строками. Ниже список всех доступных типов индексов:
%%(hvlraw)
  <table>
    <tr>
      <th>Команда</th>
      <th>Описание</th>
    </tr>
    <tr>
      <td><kbd>$table->primary('id');</kbd></td>
      <td>Добавляет первичный ключ</td>
    </tr>
    <tr>
      <td><kbd>$table->primary(['first', 'last']);</kbd></td>
      <td>Добавляет составной первичный ключ</td>
    </tr>
    <tr>
      <td><kbd>$table->unique('email');</kbd></td>
      <td>Добавляет уникальный индекс</td>
    </tr>
    <tr>
      <td><kbd>$table->index('state');</kbd></td>
      <td>Добавляет простой индекс</td>
    </tr>
  </table>
%%

== Внешние ключи ==
Laravel поддерживает добавление внешних ключей (//foreign key constraints//) для ваших таблиц:
%%
$table->integer('user_id')->unsigned();
$table->foreign('user_id')->references('id')->on('users');
%%

В этом примере мы указываем, что поле %%(t)user_id%% связано с полем %%(t)id%% таблицы %%(t)users%%. Не забудьте сначала создать поле для внешних ключей!

Вы также можете задать действия, происходящие при обновлении (//on update//) и удалении (//on delete//) записей:
%%
$table->foreign('user_id')
      ->references('id')->on('users')
      ->onDelete('cascade');
%%

Для удаления внешнего ключа используется метод %%dropForeign()%%. Схема именования ключей - та же, что и для ((#удаление_индексов индексов)):
%%
$table->dropForeign('posts_user_id_foreign');
%%

.(alert)
**Внимание:** при создании внешнего ключа, указывающего на инкрементное числовое поле, не забудьте сделать поле внешнего ключа типа **UNSIGNED**.

== ((#удаление_индексов)) Удаление индексов ==
Для удаления индекса вы должны указать его имя. По умолчанию Laravel присваивает каждому индексу осознанное имя. Просто объедините имя таблицы, имена всех его полей и добавьте тип индекса. Вот несколько примеров:
%%(hvlraw)
  <table>
    <tr>
      <th>Команда</th>
      <th>Описание</th>
    </tr>
    <tr>
      <td><kbd>$table->dropPrimary('users_id_primary');</kbd></td>
      <td>Удаление первичного ключа из таблицы <kbd>users</kbd></td>
    </tr>
    <tr>
      <td><kbd>$table->dropUnique('users_email_unique');</kbd></td>
      <td>Удаление уникального индекса из таблицы <kbd>users</kbd></td>
    </tr>
    <tr>
      <td><kbd>$table->dropIndex('geo_state_index');</kbd></td>
      <td>Удаление простого индекса из таблицы <kbd>geo</kbd></td>
    </tr>
  </table>
%%

== Удаление полей Timestamps и SoftDeletes ==
Для удаления полей с типами %%timestamps%%, %%nullableTimestamps%% и %%softDeletes%% используйте следующие методы:
%%(hvlraw)
  <table>
    <tr>
      <th>Команда</th>
      <th>Описание</th>
    </tr>
    <tr>
      <td><kbd>$table->dropTimestamps();</kbd></td>
      <td>Удаляет из таблицы поля <kbd>created_at</kbd> и <kbd>updated_at</kbd></td>
    </tr>
    <tr>
      <td><kbd>$table->dropSoftDeletes();</kbd></td>
      <td>Удаляет из таблицы поле <kbd>deleted_at</kbd></td>
    </tr>
  </table>
%%

== Системы хранения ==
Для задания конкретной системы хранения таблицы задайте свойство %%engine%% конструктора таблиц:
%%
Schema::create('users', function($table)
{
  $table->engine = 'InnoDB';

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

.(tl_note)
**Система хранения** - тип архитектуры таблицы. Некоторые СУБД поддерживают только свой встроенный тип (такие, как SQLite), в то время другие - например, MySQL - позволяют использовать различные системы даже внутри одной БД (наиболее используемыми являются //MyISAM//, //InnoDB// и //MEMORY//). Правда, использование таблиц различных архитектур в одном запросе заметно снижает его производительность - //прим. пер.//