Blueprint
class Blueprint (View source)
Свойства
| protected string | $table | Таблица, описываемая планом. | |
| protected array | $columns | Столбцы, которые должны быть добавлены в таблицу. | |
| protected array | $commands | Команды, которые должны быть выполнены для таблицы. | |
| string | $engine | Двигатель хранения, который должен быть использован для таблицы. | |
| $charset | Набор символов по умолчанию, который должен быть использован для таблицы. | ||
| $collation | Коллирование, которое должно быть использовано для таблицы. | ||
| bool | $temporary | Указывает, следует ли сделать таблицу временной. |
Методы
| void | __construct(string $table, Closure $callback = null) Создать новую схему проекта. | |
| void | build(Connection $connection, Grammar $grammar) Выполнить проект в базе данных. | |
| array | toSql(Connection $connection, Grammar $grammar) Получить исходные SQL-запросы для проекта. | |
| void | addImpliedCommands() Добавить команды, подразумеваемые проектом. | |
| void | addFluentIndexes() Добавить команды индексов, заданных для столбцов. | |
| bool | creating() Определить, имеет ли проект команду создания. | |
| Fluent | create() Указать, что таблица должна быть создана. | |
| void | temporary() Указать, что таблица должна быть временной. | |
| Fluent | drop() Указать, что таблица должна быть удалена. | |
| Fluent | dropIfExists() Указать, что таблица должна быть удалена, если она существует. | |
| Fluent | dropColumn(array|mixed $columns) Указать, что указанные столбцы должны быть удалены. | |
| Fluent | renameColumn(string $from, string $to) Указать, что указанные столбцы должны быть переименованы. | |
| Fluent | dropPrimary(string|array $index = null) Указать, что указанный первичный ключ должен быть удален. | |
| Fluent | dropUnique(string|array $index) Указать, что указанный уникальный ключ должен быть удален. | |
| Fluent | dropIndex(string|array $index) Указать, что указанный индекс должен быть удален. | |
| Fluent | dropForeign(string $index) Указать, что указанный внешний ключ должен быть удален. | |
| void | dropTimestamps() Указать, что столбцы временных меток должны быть удалены. | |
| void | dropTimestampsTz() Указать, что столбцы временных меток должны быть удалены. | |
| void | dropSoftDeletes() Указать, что столбец мягкого удаления должен быть удален. | |
| void | dropRememberToken() Указать, что столбец токена запоминания должен быть удален. | |
| Fluent | rename(string $to) Переименовать таблицу в заданное имя. | |
| Fluent | primary(string|array $columns, string $name = null) Указать первичный(е) ключ(и) для таблицы. | |
| Fluent | unique(string|array $columns, string $name = null) Указать уникальный индекс для таблицы. | |
| Fluent | index(string|array $columns, string $name = null) Указать индекс для таблицы. | |
| Fluent | foreign(string|array $columns, string $name = null) Указать внешний ключ для таблицы. | |
| Fluent | increments(string $column) Создать новый столбец целого типа с автоинкрементом (4 байта) в таблице. | |
| Fluent | smallIncrements(string $column) Создать новый столбец малого целого типа с автоинкрементом (2 байта) в таблице. | |
| Fluent | mediumIncrements(string $column) Создать новый столбец среднего целого типа с автоинкрементом (3 байта) в таблице. | |
| Fluent | bigIncrements(string $column) Создать новый столбец большого целого типа с автоинкрементом (8 байт) в таблице. | |
| Fluent | char(string $column, int $length = 255) Создать новый столбец char в таблице. | |
| Fluent | string(string $column, int $length = 255) Создать новый столбец string в таблице. | |
| Fluent | text(string $column) Создать новый столбец text в таблице. | |
| Fluent | mediumText(string $column) Создать новый столбец medium text в таблице. | |
| Fluent | longText(string $column) Создать новый столбец long text в таблице. | |
| Fluent | integer(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец целого типа (4 байта) в таблице. | |
| Fluent | tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец маленького целого типа (1 байт) в таблице. | |
| Fluent | smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец малого целого типа (2 байта) в таблице. | |
| Fluent | mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец среднего целого типа (3 байта) в таблице. |
| Fluent | bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец big integer (8 байт) в таблице. | |
| Fluent | unsignedTinyInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец tiny integer (1 байт) в таблице. | |
| Fluent | unsignedSmallInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец small integer (2 байта) в таблице. | |
| Fluent | unsignedMediumInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец medium integer (3 байта) в таблице. | |
| Fluent | unsignedInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец integer (4 байта) в таблице. | |
| Fluent | unsignedBigInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец big integer (8 байт) в таблице. | |
| Fluent | float(string $column, int $total = 8, int $places = 2) Создать новый столбец float в таблице. | |
| Fluent | double(string $column, int|null $total = null, int|null $places = null) Создать новый столбец double в таблице. | |
| Fluent | decimal(string $column, int $total = 8, int $places = 2) Создать новый столбец decimal в таблице. | |
| Fluent | boolean(string $column) Создать новый столбец boolean в таблице. | |
| Fluent | enum(string $column, array $allowed) Создать новый столбец enum в таблице. | |
| Fluent | json(string $column) Создать новый столбец json в таблице. | |
| Fluent | jsonb(string $column) Создать новый столбец jsonb в таблице. | |
| Fluent | date(string $column) Создать новый столбец date в таблице. | |
| Fluent | dateTime(string $column) Создать новый столбец date-time в таблице. | |
| Fluent | dateTimeTz(string $column) Создать новый столбец date-time (с часовым поясом) в таблице. | |
| Fluent | time(string $column) Создать новый столбец time в таблице. | |
| Fluent | timeTz(string $column) Создать новый столбец time (с часовым поясом) в таблице. | |
| Fluent | timestamp(string $column) Создать новый столбец timestamp в таблице. | |
| Fluent | timestampTz(string $column) Создать новый столбец timestamp (с часовым поясом) в таблице. | |
| void | nullableTimestamps() Добавить необязательные метки создания и обновления в таблицу. | |
| void | timestamps() Добавить метки создания и обновления в таблицу. | |
| void | timestampsTz() Добавить столбцы timestampTz создания и обновления в таблицу. | |
| Fluent | softDeletes() Добавить метку "deleted at" для таблицы. | |
| Fluent | binary(string $column) Создать новый столбец binary в таблице. | |
| Fluent | uuid(string $column) Создать новый столбец uuid в таблице. | |
| void | morphs(string $name, string|null $indexName = null) Добавить необходимые столбцы для полиморфной таблицы. | |
| Fluent | rememberToken() Добавляет столбец | |
| Fluent | dropIndexCommand(string $command, string $type, string|array $index) Создать команду удаления индекса в схеме. | |
| Fluent | indexCommand(string $type, string|array $columns, string $index) Добавить команду создания индекса в схему. | |
| string | createIndexName(string $type, array $columns) Создать имя индекса по умолчанию для таблицы. | |
| Fluent | addColumn(string $type, string $name, array $parameters = []) Добавить новый столбец в схему. | |
| $this | removeColumn(string $name) Удалить столбец из схемы. | |
| Fluent | addCommand(string $name, array $parameters = []) Добавить новую команду в схему. | |
| Fluent | createCommand(string $name, array $parameters = []) Создать новую команду Fluent. | |
| string | getTable() Получить таблицу, описываемую схемой. | |
| array | getColumns() Получить столбцы в схеме. | |
| array | getCommands() Получить команды в схеме. | |
| array | getAddedColumns() Получить столбцы в схеме, которые нужно добавить. | |
| array | getChangedColumns() Получить столбцы в схеме, которые нужно изменить. |
Подробное описание
void __construct(string $table, Closure $callback = null)
Создать новый черновик схемы.
void build(Connection $connection, Grammar $grammar)
Выполнить черновик схемы в базе данных.
array toSql(Connection $connection, Grammar $grammar)
Получить исходные SQL-запросы для черновика схемы.
protected void addImpliedCommands()
Добавить команды, которые подразумеваются черновиком схемы.
protected void addFluentIndexes()
Добавить команды индексов, явно указанные для столбцов.
protected bool creating()
Определить, содержит ли черновик команду создания.
Fluent create()
Указать, что таблица должна быть создана.
void temporary()
Указать, что таблица должна быть временной.
Fluent drop()
Указать, что таблица должна быть удалена.
Fluent dropIfExists()
Указать, что таблица должна быть удалена, если она существует.
Fluent dropColumn(array|mixed $columns)
Указать, что указанные столбцы должны быть удалены.
Fluent renameColumn(string $from, string $to)
Указать, что указанные столбцы должны быть переименованы.
Fluent dropPrimary(string|array $index = null)
Указать, что заданный первичный ключ должен быть удален.
Fluent dropUnique(string|array $index)
Указать, что заданный уникальный ключ должен быть удален.
Fluent dropIndex(string|array $index)
Указать, что заданный индекс должен быть удален.
Fluent dropForeign(string $index)
Указать, что заданный внешний ключ должен быть удален.
void dropTimestamps()
Указать, что столбцы временных меток должны быть удалены.
void dropTimestampsTz()
Указать, что столбцы временных меток должны быть удалены.
void dropSoftDeletes()
Указать, что столбец мягкого удаления должен быть удален.
void dropRememberToken()
Указать, что столбец токена запоминания должен быть удален.
Fluent rename(string $to)
Переименовать таблицу в заданное имя.
Fluent primary(string|array $columns, string $name = null)
Укажите первичный(е) ключ(и) для таблицы.
Fluent unique(string|array $columns, string $name = null)
Укажите уникальный индекс для таблицы.
Fluent index(string|array $columns, string $name = null)
Укажите индекс для таблицы.
Fluent foreign(string|array $columns, string $name = null)
Укажите внешний ключ для таблицы.
Fluent increments(string $column)
Создайте новый столбец с автоинкрементом целочисленного типа (4 байта) в таблице.
Fluent smallIncrements(string $column)
Создайте новый столбец с автоинкрементом малого целого типа (2 байта) в таблице.
Fluent mediumIncrements(string $column)
Создайте новый столбец с автоинкрементом среднего целого типа (3 байта) в таблице.
Fluent bigIncrements(string $column)
Создайте новый столбец с автоинкрементом большого целого типа (8 байт) в таблице.
Fluent char(string $column, int $length = 255)
Создайте новый столбец типа char в таблице.
Fluent string(string $column, int $length = 255)
Создайте новый столбец типа string в таблице.
Fluent text(string $column)
Создайте новый столбец типа text в таблице.
Fluent mediumText(string $column)
Создайте новый столбец типа medium text в таблице.
Fluent longText(string $column)
Создайте новый столбец типа long text в таблице.
Fluent integer(string $column, bool $autoIncrement = false, bool $unsigned = false)
Создайте новый столбец типа integer (4 байта) в таблице.
Fluent tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)
Создайте новый столбец типа tiny integer (1 байт) в таблице.
Fluent smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)
Создайте новый столбец типа small integer (2 байта) в таблице.
Fluent mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)
Создайте новый столбец типа medium integer (3 байта) в таблице.
Fluent bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)
Создать новый столбец большого целого числа (8 байт) в таблице.
Fluent unsignedTinyInteger(string $column, bool $autoIncrement = false)
Создать новый беззнаковый столбец малого целого числа (1 байт) в таблице.
Fluent unsignedSmallInteger(string $column, bool $autoIncrement = false)
Создать новый беззнаковый столбец среднего целого числа (2 байта) в таблице.
Fluent unsignedMediumInteger(string $column, bool $autoIncrement = false)
Создать новый беззнаковый столбец среднего целого числа (3 байта) в таблице.
Fluent unsignedInteger(string $column, bool $autoIncrement = false)
Создать новый беззнаковый столбец целого числа (4 байта) в таблице.
Fluent unsignedBigInteger(string $column, bool $autoIncrement = false)
Создать новый беззнаковый столбец большого целого числа (8 байт) в таблице.
Fluent float(string $column, int $total = 8, int $places = 2)
Создать новый столбец с плавающей запятой в таблице.
Fluent double(string $column, int|null $total = null, int|null $places = null)
Создать новый столбец с двойной точностью в таблице.
Fluent decimal(string $column, int $total = 8, int $places = 2)
Создать новый столбец десятичной дроби в таблице.
Fluent boolean(string $column)
Создать новый булевый столбец в таблице.
Fluent enum(string $column, array $allowed)
Создать новый столбец перечисления в таблице.
Fluent json(string $column)
Создать новый столбец JSON в таблице.
Fluent jsonb(string $column)
Создать новый столбец JSONB в таблице.
Fluent date(string $column)
Создать новый столбец даты в таблице.
Fluent dateTime(string $column)
Создать новый столбец даты и времени в таблице.
Fluent dateTimeTz(string $column)
Создать новый столбец даты и времени (с часовым поясом) в таблице.
Fluent time(string $column)
Создать новый столбец времени в таблице.
Fluent timeTz(string $column)
Создать новый столбец времени (с часовым поясом) в таблице.
Fluent timestamp(string $column)
Создать новый столбец отметки времени в таблице.
Fluent timestampTz(string $column)
Создать новый столбец отметки времени (с часовым поясом) в таблице.
void nullableTimestamps()
Добавить столбцы создания и обновления со значениями NULL в таблицу.
void timestamps()
Добавить столбцы создания и обновления в таблицу.
void timestampsTz()
Добавить столбцы создания и обновления timestampTz в таблицу.
Fluent softDeletes()
Добавить столбец "deleted at" со значением отметки времени для таблицы.
Fluent binary(string $column)
Создать новый двоичный столбец в таблице.
Fluent uuid(string $column)
Создать новый столбец uuid в таблице.
void morphs(string $name, string|null $indexName = null)
Добавить необходимые столбцы для полиморфной таблицы.
Fluent rememberToken()
Добавляет столбец remember_token в таблицу.
protected Fluent dropIndexCommand(string $command, string $type, string|array $index)
Создать новую команду удаления индекса в схеме.
protected Fluent indexCommand(string $type, string|array $columns, string $index)
Добавить новую команду создания индекса в схему.
protected string createIndexName(string $type, array $columns)
Создать имя индекса по умолчанию для таблицы.
Fluent addColumn(string $type, string $name, array $parameters = [])
Добавить новый столбец в схему.
$this removeColumn(string $name)
Удалить столбец из схемы.
protected Fluent addCommand(string $name, array $parameters = [])
Добавить новую команду в схему.
protected Fluent createCommand(string $name, array $parameters = [])
Создать новую команду Fluent.
string getTable()
Получить таблицу, которую описывает схема.
array getColumns()
Получить столбцы в схеме.
array getCommands()
Получить команды в схеме.
массив getAddedColumns()
Получить столбцы на чертеже, которые следует добавить.
массив getChangedColumns()
Получить столбцы на чертеже, которые следует изменить.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Database/Schema/Blueprint.html
