Чертеж
класс Чертеж (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённая строка | $table | Таблица, описываемая чертежом. | |
| защищённый массив | $columns | Столбцы, которые должны быть добавлены в таблицу. | |
| защищённый массив | $commands | Команды, которые должны быть выполнены для таблицы. | |
| строка | $engine | Двигатель хранения, который должен использоваться для таблицы. | |
| $charset | Набор символов по умолчанию, который должен использоваться для таблицы. | ||
| $collation | Сортировка, которая должна использоваться для таблицы. | ||
| логическое значение | $temporary | Определяет, является ли таблица временной. |
Методы
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательский макрос. | из Macroable |
| static void | mixin(object $mixin) Включить другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name) Проверяет, зарегистрирован ли макрос. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса. | из Macroable |
| mixed | __call(string $method, array $parameters) Динамически обрабатывать вызовы класса. | из Macroable |
| 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|array $index) Указать, что указанный внешний ключ следует удалить. | |
| void | dropTimestamps() Указать, что столбцы временных меток следует удалить. | |
| void | dropTimestampsTz() Указать, что столбцы временных меток следует удалить. | |
| void | dropSoftDeletes() Указать, что столбец мягкого удаления следует удалить. | |
| void | dropSoftDeletesTz() Указать, что столбец мягкого удаления следует удалить. | |
| void | dropRememberToken() Указать, что столбец токена запоминания следует удалить. | |
| Fluent | rename(string $to) Переименовать таблицу в указанное имя. | |
| Fluent | primary(string|array $columns, string $name = null, string|null $algorithm = null) Указать первичный(е) ключ(и) для таблицы. | |
| Fluent | unique(string|array $columns, string $name = null, string|null $algorithm = null) Указать уникальный индекс для таблицы. | |
| Fluent | index(string|array $columns, string $name = null, string|null $algorithm = null) Указать индекс для таблицы. | |
| Fluent | spatialIndex(string|array $columns, string $name = null) Указать пространственный индекс для таблицы. | |
| Fluent | foreign(string|array $columns, string $name = null) Указать внешний ключ для таблицы. | |
| Fluent | increments(string $column) Создать новый столбец с автоинкрементом целых чисел (4 байта) в таблице. | |
| Fluent | tinyIncrements(string $column) Создать новый столбец с автоинкрементом маленьких целых чисел (1 байт) в таблице. | |
| Fluent | smallIncrements(string $column) Создать новый столбец с автоинкрементом малых целых чисел (2 байта) в таблице. | |
| Fluent | mediumIncrements(string $column) Создать новый столбец с автоинкрементом средних целых чисел (3 байта) в таблице. | |
| Fluent | bigIncrements(string $column) Создать новый столбец с автоинкрементом больших целых чисел (8 байт) в таблице. | |
| Fluent | char(string $column, int $length = null) Создать новый столбец char в таблице. |
| Fluent | string(string $column, int $length = null) Создать новый столбец типа 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) Создать новый столбец типа big integer (8 байт) в таблице. | |
| Fluent | unsignedInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа unsigned integer (4 байта) в таблице. | |
| Fluent | unsignedTinyInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа unsigned tiny integer (1 байт) в таблице. | |
| Fluent | unsignedSmallInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа unsigned small integer (2 байта) в таблице. | |
| Fluent | unsignedMediumInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа unsigned medium integer (3 байта) в таблице. | |
| Fluent | unsignedBigInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа unsigned 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 | unsignedDecimal(string $column, int $total = 8, int $places = 2) Создать новый столбец типа unsigned 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, int $precision) Создать новый столбец типа date-time в таблице. | |
| Fluent | dateTimeTz(string $column, int $precision) Создать новый столбец типа date-time (с часовым поясом) в таблице. | |
| Fluent | time(string $column) Создать новый столбец типа time в таблице. | |
| Fluent | timeTz(string $column) Создать новый столбец типа time (с часовым поясом) в таблице. | |
| Fluent | timestamp(string $column, int $precision) Создать новый столбец типа timestamp в таблице. | |
| Fluent | timestampTz(string $column, int $precision) Создать новый столбец типа timestamp (с часовым поясом) в таблице. | |
| void | timestamps(int $precision) Добавить nullable столбцы создания и обновления (timestamps) в таблицу. | |
| void | nullableTimestamps(int $precision) Добавить nullable столбцы создания и обновления (timestamps) в таблицу. | |
| void | timestampsTz(int $precision) Добавить столбцы создания и обновления (timestampTz) в таблицу. | |
| Fluent | softDeletes(string $column = 'deleted_at', int $precision) Добавить столбец "deleted at" (timestamp) в таблицу. | |
| Fluent | softDeletesTz(int $precision) Добавить столбец "deleted at" (timestampTz) в таблицу. | |
| Fluent | binary(string $column) Создать новый столбец типа binary в таблице. | |
| Fluent | uuid(string $column) Создать новый столбец типа uuid в таблице. | |
| Fluent | ipAddress(string $column) Создать новый столбец типа IP-адрес в таблице. |
| Fluent | macAddress(string $column) Создать новый столбец MAC-адреса в таблице. | |
| Fluent | geometry(string $column) Создать новый геометрический столбец в таблице. | |
| Fluent | point(string $column) Создать новый столбец точки в таблице. | |
| Fluent | lineString(string $column) Создать новый столбец линии в таблице. | |
| Fluent | polygon(string $column) Создать новый столбец многоугольника в таблице. | |
| Fluent | geometryCollection(string $column) Создать новый столбец коллекции геометрии в таблице. | |
| Fluent | multiPoint(string $column) Создать новый столбец множества точек в таблице. | |
| Fluent | multiLineString(string $column) Создать новый столбец множества линий в таблице. | |
| Fluent | multiPolygon(string $column) Создать новый столбец множества многоугольников в таблице. | |
| void | morphs(string $name, string|null $indexName = null) Добавить необходимые столбцы для полиморфной таблицы. | |
| void | nullableMorphs(string $name, string|null $indexName = null) Добавить необязательные столбцы для полиморфной таблицы. | |
| Fluent | rememberToken() Добавляет столбец | |
| Fluent | indexCommand(string $type, string|array $columns, string $index, string|null $algorithm = null) Добавить новую команду индекса в шаблон. | |
| Fluent | dropIndexCommand(string $command, string $type, string|array $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() Получить столбцы в шаблоне, которые должны быть изменены. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы к классу.
void __construct(string $table, Closure $callback = null)
Создать новый шаблон схемы.
void build(Connection $connection, Grammar $grammar)
Выполнить шаблон в базе данных.
массив toSql(Соединение $connection, Грамматика $grammar)
Получить исходные SQL-запросы для чертежа.
protected пустое addImpliedCommands()
Добавить команды, подразумеваемые состоянием чертежа.
protected пустое addFluentIndexes()
Добавить команды индексов, заданных через fluent интерфейс для столбцов.
protected логическое creating()
Определить, есть ли у чертежа команда создания.
Fluent create()
Указать, что таблица должна быть создана.
пустое temporary()
Указать, что таблица должна быть временной.
Fluent drop()
Указать, что таблица должна быть удалена.
Fluent dropIfExists()
Указать, что таблица должна быть удалена, если она существует.
Fluent dropColumn(массив|смешанный $columns)
Указать, что указанные столбцы должны быть удалены.
Fluent renameColumn(строка $from, строка $to)
Указать, что указанные столбцы должны быть переименованы.
Fluent dropPrimary(строка|массив $index = null)
Указать, что указанный первичный ключ должен быть удалён.
Fluent dropUnique(строка|массив $index)
Указать, что указанный уникальный ключ должен быть удалён.
Fluent dropIndex(строка|массив $index)
Указать, что указанный индекс должен быть удалён.
Fluent dropForeign(строка|массив $index)
Указать, что указанный внешний ключ должен быть удалён.
пустое dropTimestamps()
Указать, что столбцы временных меток должны быть удалены.
пустое dropTimestampsTz()
Указать, что столбцы временных меток должны быть удалены.
пустое dropSoftDeletes()
Указать, что столбец мягкого удаления должен быть удалён.
пустое dropSoftDeletesTz()
Указать, что столбец мягкого удаления должен быть удалён.
пустое dropRememberToken()
Указать, что столбец токена запоминания должен быть удалён.
Fluent rename(строка $to)
Переименовать таблицу в заданное имя.
Fluent primary(строка|массив $columns, строка $name = null, строка|null $algorithm = null)
Указать первичный(ые) ключ(и) для таблицы.
Fluent unique(строка|массив $columns, строка $name = null, строка|null $algorithm = null)
Указать уникальный индекс для таблицы.
Fluent index(string|array $columns, string $name = null, string|null $algorithm = null)
Укажите индекс для таблицы.
Fluent spatialIndex(string|array $columns, string $name = null)
Укажите пространственный индекс для таблицы.
Fluent foreign(string|array $columns, string $name = null)
Укажите внешний ключ для таблицы.
Fluent increments(string $column)
Создайте новый столбец с автоматическим увеличением целого числа (4 байта) в таблице.
Fluent tinyIncrements(string $column)
Создайте новый столбец с автоматическим увеличением малого целого числа (1 байт) в таблице.
Fluent smallIncrements(string $column)
Создайте новый столбец с автоматическим увеличением малого целого числа (2 байта) в таблице.
Fluent mediumIncrements(string $column)
Создайте новый столбец с автоматическим увеличением среднего целого числа (3 байта) в таблице.
Fluent bigIncrements(string $column)
Создайте новый столбец с автоматическим увеличением большого целого числа (8 байт) в таблице.
Fluent char(string $column, int $length = null)
Создайте новый столбец char в таблице.
Fluent string(string $column, int $length = null)
Создайте новый строковый столбец в таблице.
Fluent text(string $column)
Создайте новый текстовый столбец в таблице.
Fluent mediumText(string $column)
Создайте новый столбец среднего текста в таблице.
Fluent longText(string $column)
Создайте новый столбец длинного текста в таблице.
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)
Создать новый столбец большого целого числа (8 байт) в таблице.
Fluent unsignedInteger(string $column, bool $autoIncrement = false)
Создать новый столбец целого числа без знака (4 байта) в таблице.
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 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 unsignedDecimal(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, int $precision)
Создать новый столбец даты и времени в таблице.
Fluent dateTimeTz(string $column, int $precision)
Создать новый столбец даты и времени (с часовым поясом) в таблице.
Fluent time(string $column)
Создать новый столбец времени в таблице.
Fluent timeTz(string $column)
Создать новый столбец времени (с часовым поясом) в таблице.
Fluent timestamp(string $column, int $precision)
Создать новый столбец отметки времени в таблице.
Fluent timestampTz(string $column, int $precision)
Создать новый столбец отметки времени (с часовым поясом) в таблице.
void timestamps(int $precision)
Добавить необязательные метки времени создания и обновления в таблицу.
void nullableTimestamps(int $precision)
Добавить необязательные метки времени создания и обновления в таблицу.
Псевдоним для self::timestamps().
void timestampsTz(int $precision)
Добавить столбцы отметки времени создания и обновления (с часовым поясом) в таблицу.
Fluent softDeletes(string $column = 'deleted_at', int $precision)
Добавить метку времени "deleted at" для таблицы.
Fluent softDeletesTz(int $precision)
Добавить метку времени "deleted at" (с часовым поясом) для таблицы.
Fluent binary(string $column)
Создать новый столбец бинарных данных в таблице.
Fluent uuid(string $column)
Создать новый столбец uuid в таблице.
Fluent ipAddress(string $column)
Создать новый столбец IP-адреса в таблице.
Fluent macAddress(string $column)
Создать новый столбец MAC-адреса в таблице.
Fluent geometry(string $column)
Создать новый геометрический столбец в таблице.
Fluent point(string $column)
Создать новый точечный столбец в таблице.
Fluent lineString(string $column)
Создать новый столбец линии в таблице.
Fluent polygon(string $column)
Создать новый столбец многоугольника в таблице.
Fluent geometryCollection(string $column)
Создать новый столбец геометрической коллекции в таблице.
Fluent multiPoint(string $column)
Создать новый столбец multipoint в таблице.
Fluent multiLineString(string $column)
Создать новый столбец multilinestring в таблице.
Fluent multiPolygon(string $column)
Создать новый столбец multipolygon в таблице.
void morphs(string $name, string|null $indexName = null)
Добавить необходимые столбцы для полиморфной таблицы.
void nullableMorphs(string $name, string|null $indexName = null)
Добавить nullable столбцы для полиморфной таблицы.
Fluent rememberToken()
Добавляет столбец remember_token в таблицу.
protected Fluent indexCommand(string $type, string|array $columns, string $index, string|null $algorithm = null)
Добавить новую команду индекса в схему.
protected Fluent dropIndexCommand(string $command, string $type, string|array $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()
Получить команды в схеме.
array getAddedColumns()
Получить столбцы в схеме, которые должны быть добавлены.
array getChangedColumns()
Получить столбцы в схеме, которые должны быть изменены.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Database/Schema/Blueprint.html
