Spec-Zone.ru › Laravel 10

Чертеж

класс Чертеж (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищенный массив $macros

Зарегистрированные строковые макросы.

 из Macroable
защищенный строка $table

Таблица, описываемая чертежом.
защищенный строка $prefix

Префикс таблицы.
защищенный ColumnDefinition[] $columns

Столбцы, которые должны быть добавлены в таблицу.
защищенный Fluent[] $commands

Команды, которые должны быть выполнены для таблицы.
строка $engine

Двигатель хранения, который должен быть использован для таблицы.
строка $charset

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

Коллирование, которое должно быть использовано для таблицы.
булево $temporary

Указывает, является ли таблица временной.
строка $after

Столбец, после которого следует добавить новые столбцы.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательскую макрокоманду.

 из Macroable
static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

 из Macroable
static bool hasMacro(string $name)

Проверяет, зарегистрирована ли макрокоманда.

 из Macroable
static void flushMacros()

Очистить существующие макрокоманды.

 из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

 из Macroable
mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

 из Macroable
void __construct(string $table, Closure $callback = null, string $prefix = '')

Создать новый шаблон схемы.
void build(Connection $connection, Grammar $grammar)

Выполнить шаблон в базе данных.
array toSql(Connection $connection, Grammar $grammar)

Получить исходные SQL-запросы для шаблона.
void ensureCommandsAreValid(Connection $connection)

Убедиться, что команды в шаблоне действительны для типа соединения.
Collection commandsNamed(array $names)

Получить все команды, соответствующие заданным именам.
void addImpliedCommands(Connection $connection, Grammar $grammar)

Добавить команды, которые подразумеваются состоянием шаблона.
void addFluentIndexes()

Добавить команды индексов, заданных в столбцах.
void addFluentCommands(Connection $connection, Grammar $grammar)

Добавить команды, заданные в столбцах.
bool creating()

Определить, есть ли в шаблоне команда создания.
Fluent create()

Указать, что таблица должна быть создана.
void engine(string $engine)

Указать механизм хранения, который должен использоваться для таблицы.
void innoDb()

Указать, что должен использоваться механизм хранения InnoDB для таблицы (только MySQL).
void charset(string $charset)

Указать кодировку символов, которая должна использоваться для таблицы.
void collation(string $collation)

Указать сортировку, которая должна использоваться для таблицы.
void temporary()

Указать, что таблица должна быть временной.
Fluent drop()

Указать, что таблица должна быть удалена.
Fluent dropIfExists()

Указать, что таблица должна быть удалена, если она существует.
Fluent dropColumn(array|mixed $columns)

Указать, что заданные столбцы должны быть удалены.
Fluent renameColumn(string $from, string $to)

Указать, что заданные столбцы должны быть переименованы.
Fluent dropPrimary(string|array|null $index = null)

Указать, что заданный первичный ключ должен быть удален.
void dropSoftDeletes(string $column = 'deleted_at')

Укажите, что столбец мягкого удаления должен быть удалён.
void dropSoftDeletesTz(string $column = 'deleted_at')

Укажите, что столбец мягкого удаления должен быть удалён.
void dropRememberToken()

Укажите, что столбец токена запоминания должен быть удалён.
void dropMorphs(string $name, string|null $indexName = null)

Укажите, что полиморфные столбцы должны быть удалены.
Fluent rename(string $to)

Переименовать таблицу в заданное имя.
IndexDefinition primary(string|array $columns, string|null $name = null, string|null $algorithm = null)

Укажите первичный(ые) ключ(и) для таблицы.
IndexDefinition unique(string|array $columns, string|null $name = null, string|null $algorithm = null)

Укажите уникальный индекс для таблицы.
IndexDefinition index(string|array $columns, string|null $name = null, string|null $algorithm = null)

Укажите индекс для таблицы.
IndexDefinition fullText(string|array $columns, string|null $name = null, string|null $algorithm = null)

Укажите полный текст для таблицы.
IndexDefinition spatialIndex(string|array $columns, string|null $name = null)

Укажите пространственный индекс для таблицы.
IndexDefinition rawIndex(string $expression, string $name)

Укажите простой индекс для таблицы.
ForeignKeyDefinition foreign(string|array $columns, string|null $name = null)

Укажите внешний ключ для таблицы.
ColumnDefinition id(string $column = 'id')

Создать новый столбец с автоинкрементом (8-байтовый) для таблицы.
ColumnDefinition increments(string $column)

Создать новый столбец с автоинкрементом (4-байтовый) для таблицы.
ColumnDefinition integerIncrements(string $column)

Создать новый столбец с автоинкрементом (4-байтовый) для таблицы.
ColumnDefinition tinyIncrements(string $column)

Создать новый столбец с автоинкрементом (1-байтовый) для таблицы.
ColumnDefinition smallIncrements(string $column)

Создать новый столбец с автоинкрементом (2-байтовый) для таблицы.
ColumnDefinition mediumIncrements(string $column)

Создать новый столбец с автоинкрементом (3-байтовый) для таблицы.
ColumnDefinition bigIncrements(string $column)

Создать новый столбец с автоинкрементом (8-байтовый) для таблицы.
ColumnDefinition char(string $column, int|null $length = null)

Создать новый столбец char для таблицы.
ColumnDefinition string(string $column, int|null $length = null)

Создать новый строковый столбец для таблицы.
ColumnDefinition tinyText(string $column)

Создать новый столбец tiny text для таблицы.
ColumnDefinition text(string $column)

Создать новый текстовый столбец для таблицы.
ColumnDefinition mediumText(string $column)

Создать новый столбец medium text для таблицы.
ColumnDefinition longText(string $column)

Создать новый столбец long text для таблицы.
ColumnDefinition integer(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец integer (4-байтовый) для таблицы.
ColumnDefinition tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец tiny integer (1-байтовый) для таблицы.
ColumnDefinition smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец small integer (2-байтовый) для таблицы.
ColumnDefinition mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец medium integer (3-байтовый) для таблицы.
ColumnDefinition bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец big integer (8-байтовый) для таблицы.
ColumnDefinition unsignedInteger(string $column, bool $autoIncrement = false)

Создать новый столбец unsigned integer (4-байтовый) для таблицы.
ColumnDefinition unsignedTinyInteger(string $column, bool $autoIncrement = false)

Создать новый столбец unsigned tiny integer (1-байтовый) для таблицы.
ColumnDefinition unsignedSmallInteger(string $column, bool $autoIncrement = false)

Создать новый столбец unsigned small integer (2-байтовый) для таблицы.
ColumnDefinition unsignedMediumInteger(string $column, bool $autoIncrement = false)

Создать новый столбец unsigned medium integer (3-байтовый) для таблицы.
ColumnDefinition unsignedBigInteger(string $column, bool $autoIncrement = false)

Создать новый столбец беззнакового большого целого числа (8 байт) в таблице.
ForeignIdColumnDefinition foreignId(string $column)

Создать новый столбец беззнакового большого целого числа (8 байт) в таблице.
ForeignIdColumnDefinition foreignIdFor(Model|string $model, string|null $column = null)

Создать столбец внешнего ID для данной модели.
ColumnDefinition float(string $column, int $total = 8, int $places = 2, bool $unsigned = false)

Создать новый столбец с плавающей точкой в таблице.
ColumnDefinition double(string $column, int|null $total = null, int|null $places = null, bool $unsigned = false)

Создать новый столбец типа double в таблице.
ColumnDefinition decimal(string $column, int $total = 8, int $places = 2, bool $unsigned = false)

Создать новый столбец типа decimal в таблице.
ColumnDefinition unsignedFloat(string $column, int $total = 8, int $places = 2)

Создать новый столбец беззнакового числа с плавающей точкой в таблице.
ColumnDefinition unsignedDouble(string $column, int $total = null, int $places = null)

Создать новый столбец беззнакового типа double в таблице.
ColumnDefinition unsignedDecimal(string $column, int $total = 8, int $places = 2)

Создать новый столбец беззнакового типа decimal в таблице.
ColumnDefinition boolean(string $column)

Создать новый булевый столбец в таблице.
ColumnDefinition enum(string $column, array $allowed)

Создать новый столбец типа enum в таблице.
ColumnDefinition set(string $column, array $allowed)

Создать новый столбец типа set в таблице.
ColumnDefinition json(string $column)

Создать новый столбец типа json в таблице.
ColumnDefinition jsonb(string $column)

Создать новый столбец типа jsonb в таблице.
ColumnDefinition date(string $column)

Создать новый столбец типа date в таблице.
ColumnDefinition dateTime(string $column, int|null $precision = 0)

Создать новый столбец типа datetime в таблице.
ColumnDefinition dateTimeTz(string $column, int|null $precision = 0)

Создать новый столбец типа datetime (с часовым поясом) в таблице.
ColumnDefinition time(string $column, int|null $precision = 0)

Создать новый столбец типа time в таблице.
ColumnDefinition timeTz(string $column, int|null $precision = 0)

Создать новый столбец типа time (с часовым поясом) в таблице.
ColumnDefinition timestamp(string $column, int|null $precision = 0)

Создать новый столбец типа timestamp в таблице.
ColumnDefinition timestampTz(string $column, int|null $precision = 0)

Создать новый столбец типа timestamp (с часовым поясом) в таблице.
void timestamps(int|null $precision = 0)

Добавить в таблицу столбцы с метками времени создания и обновления (допускается NULL).
void nullableTimestamps(int|null $precision = 0)

Добавить в таблицу столбцы с метками времени создания и обновления (допускается NULL).
void timestampsTz(int|null $precision = 0)

Добавить в таблицу столбцы timestampTz создания и обновления.
void datetimes(int|null $precision = 0)

Добавить в таблицу столбцы datetime создания и обновления.
ColumnDefinition softDeletes(string $column = 'deleted_at', int|null $precision = 0)

Добавить в таблицу метку времени "удалено в".
ColumnDefinition softDeletesTz(string $column = 'deleted_at', int|null $precision = 0)

Добавить в таблицу метку времени timestampTz "удалено в".
ColumnDefinition softDeletesDatetime(string $column = 'deleted_at', int|null $precision = 0)

Добавить в таблицу столбец datetime "удалено в".
ColumnDefinition year(string $column)

Создать новый столбец года в таблице.
ColumnDefinition binary(string $column)

Создать новый бинарный столбец в таблице.
ColumnDefinition uuid(string $column = 'uuid')

Создать новый столбец UUID в таблице.
ForeignIdColumnDefinition foreignUuid(string $column)

Создать новый столбец UUID в таблице с ограничением внешнего ключа.
ColumnDefinition ulid(string $column = 'ulid', int|null $length = 26)

Создать новый столбец ULID в таблице.
ForeignIdColumnDefinition foreignUlid(string $column, int|null $length = 26)

Создать новый столбец ULID в таблице с ограничением внешнего ключа.
ColumnDefinition ipAddress(string $column = 'ip_address')

Создать новый столбец IP-адреса в таблице.
ColumnDefinition macAddress(string $column = 'mac_address')

Создать новый столбец MAC-адреса в таблице.
ColumnDefinition geometry(string $column)

Создать новый столбец геометрии в таблице.
ColumnDefinition point(string $column, int|null $srid = null)

Создать новый столбец точки в таблице.
ColumnDefinition lineString(string $column)

Создать новый столбец линии в таблице.
ColumnDefinition polygon(string $column)

Создать новый столбец многоугольника в таблице.
ColumnDefinition geometryCollection(string $column)

Создать новый столбец коллекции геометрий в таблице.
ColumnDefinition multiPoint(string $column)

Создать новый столбец множества точек в таблице.
ColumnDefinition multiLineString(string $column)

Создать новый столбец множества линий в таблице.
ColumnDefinition multiPolygon(string $column)

Создать новый столбец множества многоугольников в таблице.
ColumnDefinition multiPolygonZ(string $column)

Создать новый столбец множества многоугольников с Z-координатами в таблице.
ColumnDefinition computed(string $column, string $expression)

Создать новый вычисляемый столбец в таблице.
void morphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы.
void nullableMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы.
void numericMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы с использованием числовых идентификаторов (инкрементные).
void nullableNumericMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы с использованием числовых идентификаторов (инкрементные).
void uuidMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы с использованием UUID.
void nullableUuidMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы с использованием UUID.
void ulidMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы с использованием ULID.
void nullableUlidMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы с использованием ULID.
ColumnDefinition rememberToken()

Добавляет столбец remember_token в таблицу.
Fluent comment(string $comment)

Добавить комментарий к таблице.
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)

Создать имя индекса по умолчанию для таблицы.
ColumnDefinition addColumn(string $type, string $name, array $parameters = [])

Добавить новый столбец в черновик.
ColumnDefinition addColumnDefinition(ColumnDefinition $definition)

Добавить новое определение столбца в черновик.
void after(string $column, Closure $callback)

Добавить столбцы из обратного вызова после заданного столбца.
$this removeColumn(string $name)

Удалить столбец из схемы черновика.
Fluent addCommand(string $name, array $parameters = [])

Добавить новую команду в черновик.
Fluent createCommand(string $name, array $parameters = [])

Создать новую команду Fluent.
string getTable()

Получить таблицу, которую описывает черновик.
string getPrefix()

Получить префикс таблицы.
ColumnDefinition[] getColumns()

Получить столбцы в черновике.
Fluent[] getCommands()

Получить команды в черновике.
ColumnDefinition[] getAddedColumns()

Получить столбцы в черновике, которые должны быть добавлены.
ColumnDefinition[] getChangedColumns()

Получить столбцы в черновике, которые должны быть изменены.

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательскую макрокоманду.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирована ли макрокоманда.

Parameters

string $name

Return Value

bool

static void flushMacros()

Очистить существующие макрокоманды.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(string $table, Closure $callback = null, string $prefix = '')

Создать новую схему проекта.

Parameters

string $table
Closure $callback
string $prefix

Return Value

void

void build(Connection $connection, Grammar $grammar)

Выполнить проект в базе данных.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

array toSql(Connection $connection, Grammar $grammar)

Получить исходные SQL-запросы для проекта.

Parameters

Connection $connection
Grammar $grammar

Return Value

array

protected void ensureCommandsAreValid(Connection $connection)

Убедиться, что команды в проекте допустимы для типа подключения.

Parameters

Connection $connection

Return Value

void

Exceptions

BadMethodCallException

protected Collection commandsNamed(array $names)

Получить все команды, соответствующие заданным именам.

Parameters

array $names

Return Value

Collection

protected void addImpliedCommands(Connection $connection, Grammar $grammar)

Добавить команды, подразумеваемые состоянием проекта.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

protected void addFluentIndexes()

Добавить команды индексов, указанные для столбцов в стиле fluent.

Return Value

void

void addFluentCommands(Connection $connection, Grammar $grammar)

Добавить команды fluent, указанные для столбцов.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

bool creating()

Определить, содержит ли проект команду создания.

Return Value

bool

Fluent create()

Указать, что таблица должна быть создана.

Return Value

Fluent

void engine(string $engine)

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

Parameters

string $engine

Return Value

void

void innoDb()

Указать, что должен быть использован движок хранения InnoDB для таблицы (только MySQL).

Return Value

void

void charset(string $charset)

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

Parameters

string $charset

Return Value

void

void collation(string $collation)

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

Parameters

string $collation

Return Value

void

void temporary()

Укажите, что таблица должна быть временной.

Return Value

void

Fluent drop()

Укажите, что таблица должна быть удалена.

Return Value

Fluent

Fluent dropIfExists()

Укажите, что таблица должна быть удалена, если она существует.

Return Value

Fluent

Fluent dropColumn(array|mixed $columns)

Укажите, что указанные столбцы должны быть удалены.

Parameters

array|mixed $columns

Return Value

Fluent

Fluent renameColumn(string $from, string $to)

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

Parameters

string $from
string $to

Return Value

Fluent

Fluent dropPrimary(string|array|null $index = null)

Укажите, что заданный первичный ключ должен быть удален.

Parameters

string|array|null $index

Return Value

Fluent

Fluent dropUnique(string|array $index)

Укажите, что заданный уникальный ключ должен быть удален.

Parameters

string|array $index

Return Value

Fluent

Fluent dropIndex(string|array $index)

Укажите, что заданный индекс должен быть удален.

Parameters

string|array $index

Return Value

Fluent

Fluent dropFullText(string|array $index)

Указывает, что указанный полнотекстовый индекс должен быть удалён.

Параметры

string|array $index

Возвращаемое значение

Fluent

Fluent dropSpatialIndex(string|array $index)

Указывает, что указанный пространственный индекс должен быть удалён.

Параметры

string|array $index

Возвращаемое значение

Fluent

Fluent dropForeign(string|array $index)

Указывает, что указанный внешний ключ должен быть удалён.

Параметры

string|array $index

Возвращаемое значение

Fluent

Fluent dropConstrainedForeignId(string $column)

Указывает, что указанный столбец и внешний ключ должны быть удалены.

Параметры

string $column

Возвращаемое значение

Fluent

Fluent dropForeignIdFor(Model|string $model, string|null $column = null)

Указывает, что указанный внешний ключ должен быть удалён.

Параметры

Model|string $model
string|null $column

Возвращаемое значение

Fluent

Fluent dropConstrainedForeignIdFor(Model|string $model, string|null $column = null)

Указывает, что указанный внешний ключ должен быть удалён.

Параметры

Model|string $model
string|null $column

Возвращаемое значение

Fluent

Fluent renameIndex(string $from, string $to)

Указывает, что указанные индексы должны быть переименованы.

Параметры

string $from
string $to

Возвращаемое значение

Fluent

void dropTimestamps()

Указывает, что столбцы временных меток должны быть удалены.

Возвращаемое значение

void

void dropTimestampsTz()

Указывает, что столбцы временных меток должны быть удалены.

Возвращаемое значение

void

void dropSoftDeletes(string $column = 'deleted_at')

Указать, что столбец мягкого удаления должен быть удален.

Параметры

string $column

Возвращаемое значение

void

void dropSoftDeletesTz(string $column = 'deleted_at')

Указать, что столбец мягкого удаления должен быть удален.

Параметры

string $column

Возвращаемое значение

void

void dropRememberToken()

Указать, что столбец токена запоминания должен быть удален.

Возвращаемое значение

void

void dropMorphs(string $name, string|null $indexName = null)

Указать, что полиморфные столбцы должны быть удалены.

Параметры

string $name
string|null $indexName

Возвращаемое значение

void

Fluent rename(string $to)

Переименовать таблицу в заданное имя.

Параметры

string $to

Возвращаемое значение

Fluent

IndexDefinition primary(string|array $columns, string|null $name = null, string|null $algorithm = null)

Указать первичный ключ(и) для таблицы.

Параметры

string|array $columns
string|null $name
string|null $algorithm

Возвращаемое значение

IndexDefinition

IndexDefinition unique(string|array $columns, string|null $name = null, string|null $algorithm = null)

Указать уникальный индекс для таблицы.

Параметры

string|array $columns
string|null $name
string|null $algorithm

Возвращаемое значение

IndexDefinition

IndexDefinition index(string|array $columns, string|null $name = null, string|null $algorithm = null)

Указать индекс для таблицы.

Параметры

string|array $columns
string|null $name
string|null $algorithm

Возвращаемое значение

IndexDefinition

IndexDefinition fullText(string|array $columns, string|null $name = null, string|null $algorithm = null)

Указать полный текст для таблицы.

Параметры

string|array $columns
string|null $name
string|null $algorithm

Возвращаемое значение

IndexDefinition

IndexDefinition spatialIndex(string|array $columns, string|null $name = null)

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

Параметры

string|array $columns
string|null $name

Возвращаемое значение

IndexDefinition

IndexDefinition rawIndex(string $expression, string $name)

Указать исходный индекс для таблицы.

Параметры

string $expression
string $name

Возвращаемое значение

IndexDefinition

ForeignKeyDefinition foreign(string|array $columns, string|null $name = null)

Указать внешний ключ для таблицы.

Параметры

string|array $columns
string|null $name

Возвращаемое значение

ForeignKeyDefinition

ColumnDefinition id(string $column = 'id')

Создать новый автоинкрементируемый столбец большого целого типа данных (8 байт) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition increments(string $column)

Создать новый автоинкрементируемый столбец целого типа данных (4 байта) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition integerIncrements(string $column)

Создать новый автоинкрементируемый столбец целого типа данных (4 байта) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition tinyIncrements(string $column)

Создать новый автоинкрементируемый столбец малого целого типа данных (1 байт) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition smallIncrements(string $column)

Создать новый автоинкрементируемый столбец малого целого типа данных (2 байта) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition mediumIncrements(string $column)

Создать новый столбец с автоинкрементом среднего целого типа (3 байта) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition bigIncrements(string $column)

Создать новый столбец с автоинкрементом большого целого типа (8 байт) в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition char(string $column, int|null $length = null)

Создать новый столбец типа char в таблице.

Параметры

string $column
int|null $length

Возвращаемое значение

ColumnDefinition

ColumnDefinition string(string $column, int|null $length = null)

Создать новый столбец типа string в таблице.

Параметры

string $column
int|null $length

Возвращаемое значение

ColumnDefinition

ColumnDefinition tinyText(string $column)

Создать новый столбец типа tiny text в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition text(string $column)

Создать новый столбец типа text в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition mediumText(string $column)

Создать новый столбец типа medium text в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition longText(string $column)

Создать новый столбец типа long text в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition integer(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец типа integer (4 байта) в таблице.

Параметры

string $column
bool $autoIncrement
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец типа tiny integer (1 байт) в таблице.

Параметры

string $column
bool $autoIncrement
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец типа small integer (2 байта) в таблице.

Параметры

string $column
bool $autoIncrement
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец типа medium integer (3 байта) в таблице.

Параметры

string $column
bool $autoIncrement
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Создать новый столбец типа big integer (8 байт) в таблице.

Параметры

string $column
bool $autoIncrement
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedInteger(string $column, bool $autoIncrement = false)

Создать новый столбец типа unsigned integer (4 байта) в таблице.

Параметры

string $column
bool $autoIncrement

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedTinyInteger(string $column, bool $autoIncrement = false)

Создать новый столбец типа unsigned tiny integer (1 байт) в таблице.

Параметры

string $column
bool $autoIncrement

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedSmallInteger(string $column, bool $autoIncrement = false)

Создать новый столбец целых чисел без знака малого размера (2 байта) в таблице.

Параметры

string $column
bool $autoIncrement

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedMediumInteger(string $column, bool $autoIncrement = false)

Создать новый столбец целых чисел без знака среднего размера (3 байта) в таблице.

Параметры

string $column
bool $autoIncrement

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedBigInteger(string $column, bool $autoIncrement = false)

Создать новый столбец целых чисел без знака большого размера (8 байт) в таблице.

Параметры

string $column
bool $autoIncrement

Возвращаемое значение

ColumnDefinition

ForeignIdColumnDefinition foreignId(string $column)

Создать новый столбец целых чисел без знака большого размера (8 байт) в таблице.

Параметры

string $column

Возвращаемое значение

ForeignIdColumnDefinition

ForeignIdColumnDefinition foreignIdFor(Модель|string $model, string|null $column = null)

Создать столбец внешнего ключа для заданной модели.

Параметры

Модель|string $model
string|null $column

Возвращаемое значение

ForeignIdColumnDefinition

ColumnDefinition float(string $column, int $total = 8, int $places = 2, bool $unsigned = false)

Создать новый столбец с плавающей точкой в таблице.

Параметры

string $column
int $total
int $places
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition double(string $column, int|null $total = null, int|null $places = null, bool $unsigned = false)

Создать новый столбец double в таблице.

Параметры

string $column
int|null $total
int|null $places
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition decimal(string $column, int $total = 8, int $places = 2, bool $unsigned = false)

Создать новый столбец decimal в таблице.

Параметры

string $column
int $total
int $places
bool $unsigned

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedFloat(string $column, int $total = 8, int $places = 2)

Создать новый столбец с плавающей точкой без знака в таблице.

Параметры

string $column
int $total
int $places

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedDouble(string $column, int $total = null, int $places = null)

Создать новый столбец double без знака в таблице.

Параметры

string $column
int $total
int $places

Возвращаемое значение

ColumnDefinition

ColumnDefinition unsignedDecimal(string $column, int $total = 8, int $places = 2)

Создать новый столбец decimal без знака в таблице.

Параметры

string $column
int $total
int $places

Возвращаемое значение

ColumnDefinition

ColumnDefinition boolean(string $column)

Создать новый столбец boolean в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition enum(string $column, array $allowed)

Создать новый столбец типа перечисление в таблице.

Параметры

string $column
array $allowed

Возвращаемое значение

ColumnDefinition

ColumnDefinition set(string $column, array $allowed)

Создать новый столбец типа множество в таблице.

Параметры

string $column
array $allowed

Возвращаемое значение

ColumnDefinition

ColumnDefinition json(string $column)

Создать новый столбец json в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition jsonb(string $column)

Создать новый столбец jsonb в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition date(string $column)

Создать новый столбец date в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition dateTime(string $column, int|null $precision = 0)

Создать новый столбец date-time в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition dateTimeTz(string $column, int|null $precision = 0)

Создать новый столбец date-time (с часовым поясом) в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition time(string $column, int|null $precision = 0)

Создать новый столбец time в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition timeTz(string $column, int|null $precision = 0)

Создать новый столбец time (с часовым поясом) в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition timestamp(string $column, int|null $precision = 0)

Создать новый столбец timestamp в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition timestampTz(string $column, int|null $precision = 0)

Создать новый столбец timestamp (с часовым поясом) в таблице.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

void timestamps(int|null $precision = 0)

Добавить nullable столбцы создания и обновления в таблицу.

Параметры

int|null $precision

Возвращаемое значение

void

void nullableTimestamps(int|null $precision = 0)

Добавить nullable столбцы создания и обновления в таблицу.

Псевдоним для self::timestamps().

Параметры

int|null $precision

Возвращаемое значение

void

void timestampsTz(int|null $precision = 0)

Добавить столбцы создания и обновления timestampTz в таблицу.

Параметры

int|null $precision

Возвращаемое значение

void

void datetimes(int|null $precision = 0)

Добавить столбцы создания и обновления datetime в таблицу.

Параметры

int|null $precision

Возвращаемое значение

void

ColumnDefinition softDeletes(string $column = 'deleted_at', int|null $precision = 0)

Добавить столбец "deleted at" timestamp для таблицы.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition softDeletesTz(string $column = 'deleted_at', int|null $precision = 0)

Добавить столбец "deleted at" timestampTz для таблицы.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition softDeletesDatetime(string $column = 'deleted_at', int|null $precision = 0)

Добавить столбец "deleted at" datetime в таблицу.

Параметры

string $column
int|null $precision

Возвращаемое значение

ColumnDefinition

ColumnDefinition year(string $column)

Создать новый столбец year в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition binary(string $column)

Создать новый бинарный столбец в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition uuid(string $column = 'uuid')

Создать новый столбец UUID в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ForeignIdColumnDefinition foreignUuid(string $column)

Создать новый столбец UUID в таблице с ограничением внешнего ключа.

Параметры

string $column

Возвращаемое значение

ForeignIdColumnDefinition

ColumnDefinition ulid(string $column = 'ulid', int|null $length = 26)

Создать новый столбец ULID в таблице.

Параметры

string $column
int|null $length

Возвращаемое значение

ColumnDefinition

ForeignIdColumnDefinition foreignUlid(string $column, int|null $length = 26)

Создать новый столбец ULID в таблице с ограничением внешнего ключа.

Параметры

string $column
int|null $length

Возвращаемое значение

ForeignIdColumnDefinition

ColumnDefinition ipAddress(string $column = 'ip_address')

Создать новый столбец IP-адреса в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition macAddress(string $column = 'mac_address')

Создать новый столбец MAC-адреса в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition geometry(string $column)

Создать новый столбец геометрии в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition point(string $column, int|null $srid = null)

Создать новый столбец точки в таблице.

Параметры

string $column
int|null $srid

Возвращаемое значение

ColumnDefinition

ColumnDefinition lineString(string $column)

Создать новый столбец типа linestring в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition polygon(string $column)

Создать новый столбец типа polygon в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition geometryCollection(string $column)

Создать новый столбец типа geometrycollection в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition multiPoint(string $column)

Создать новый столбец типа multipoint в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition multiLineString(string $column)

Создать новый столбец типа multilinestring в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition multiPolygon(string $column)

Создать новый столбец типа multipolygon в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition multiPolygonZ(string $column)

Создать новый столбец типа multipolygon в таблице.

Параметры

string $column

Возвращаемое значение

ColumnDefinition

ColumnDefinition computed(string $column, string $expression)

Создать новый вычисляемый столбец в таблице.

Параметры

string $column
string $expression

Возвращаемое значение

ColumnDefinition

void morphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы.

Parameters

string $name
string|null $indexName

Return Value

void

void nullableMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы.

Parameters

string $name
string|null $indexName

Return Value

void

void numericMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы, используя числовые ID (последовательные).

Parameters

string $name
string|null $indexName

Return Value

void

void nullableNumericMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы, используя числовые ID (последовательные).

Parameters

string $name
string|null $indexName

Return Value

void

void uuidMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы, используя UUID.

Parameters

string $name
string|null $indexName

Return Value

void

void nullableUuidMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы, используя UUID.

Parameters

string $name
string|null $indexName

Return Value

void

void ulidMorphs(string $name, string|null $indexName = null)

Добавить необходимые столбцы для полиморфной таблицы, используя ULID.

Parameters

string $name
string|null $indexName

Return Value

void

void nullableUlidMorphs(string $name, string|null $indexName = null)

Добавить необязательные столбцы для полиморфной таблицы, используя ULID.

Parameters

string $name
string|null $indexName

Return Value

void

ColumnDefinition rememberToken()

Добавляет столбец remember_token в таблицу.

Return Value

ColumnDefinition

Fluent comment(string $comment)

Добавить комментарий к таблице.

Parameters

string $comment

Return Value

Fluent

protected Fluent indexCommand(string $type, string|array $columns, string $index, string|null $algorithm = null)

Добавить новую команду индекса в шаблон.

Parameters

string $type
string|array $columns
string $index
string|null $algorithm

Return Value

Fluent

protected Fluent dropIndexCommand(string $command, string $type, string|array $index)

Создать новую команду удаления индекса в шаблоне.

Parameters

string $command
string $type
string|array $index

Return Value

Fluent

protected string createIndexName(string $type, array $columns)

Создать имя индекса по умолчанию для таблицы.

Parameters

string $type
array $columns

Return Value

string

ColumnDefinition addColumn(string $type, string $name, array $parameters = [])

Добавить новый столбец в шаблон.

Parameters

string $type
string $name
array $parameters

Return Value

ColumnDefinition

protected ColumnDefinition addColumnDefinition(ColumnDefinition $definition)

Добавить новое определение столбца в шаблон.

Parameters

ColumnDefinition $definition

Return Value

ColumnDefinition

void after(string $column, Closure $callback)

Добавить столбцы из обратного вызова после указанного столбца.

Parameters

string $column
Closure $callback

Return Value

void

$this removeColumn(string $name)

Удалить столбец из схемы.

Parameters

string $name

Return Value

$this

protected Fluent addCommand(string $name, array $parameters = [])

Добавить новую команду в черновик.

Параметры

string $name
array $parameters

Значение возврата

Fluent

protected Fluent createCommand(string $name, array $parameters = [])

Создать новую команду Fluent.

Параметры

string $name
array $parameters

Значение возврата

Fluent

string getTable()

Получить таблицу, которую описывает черновик.

Значение возврата

string

string getPrefix()

Получить префикс таблицы.

Значение возврата

string

ColumnDefinition[] getColumns()

Получить столбцы в черновике.

Значение возврата

ColumnDefinition[]

Fluent[] getCommands()

Получить команды в черновике.

Значение возврата

Fluent[]

ColumnDefinition[] getAddedColumns()

Получить столбцы в черновике, которые должны быть добавлены.

Значение возврата

ColumnDefinition[]

ColumnDefinition[] getChangedColumns()

Получить столбцы в черновике, которые должны быть изменены.

Значение возврата

ColumnDefinition[]

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Schema/Blueprint.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API