Spec-Zone.ru › Laravel 11

Чертеж

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

Трейты

Macroable

Свойства

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

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

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

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

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

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

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

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

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

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

Определить, следует ли сделать таблицу временной.
строка $after

Столбец, после которого следует добавить новые столбцы.
защищенный BlueprintState|null $state

Экземпляр состояния чертежа.

Методы

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

Зарегистрировать пользовательский макрос.

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

Включить другой объект в класс.

 from Macroable
static bool hasMacro(string $name)

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

 from Macroable
static void flushMacros()

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

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

 from Macroable
void __construct(string $table, Closure|null $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) deprecated

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

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

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

Добавить команды, указанные для любых столбцов.
void addAlterCommands(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)

Указать, что заданный первичный ключ следует удалить.
Fluent dropUnique(string|array $index)

Указать, что заданный уникальный ключ следует удалить.
Fluent dropIndex(string|array $index)

Указать, что заданный индекс следует удалить.
Fluent dropFullText(string|array $index)

Указать, что заданный полнотекстовый индекс следует удалить.
Fluent dropSpatialIndex(string|array $index)

Указать, что заданный пространственный индекс следует удалить.
Fluent dropForeign(string|array $index)

Указать, что заданный внешний ключ следует удалить.
Fluent dropConstrainedForeignId(string $column)

Указать, что заданный столбец и внешний ключ следует удалить.
Fluent dropForeignIdFor(Model|string $model, string|null $column = null)

Указать, что заданный внешний ключ следует удалить.
Fluent dropConstrainedForeignIdFor(Model|string $model, string|null $column = null)

Указать, что заданный внешний ключ следует удалить.
Fluent renameIndex(string $from, string $to)

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

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

Указать, что столбцы с временными метками должны быть удалены.
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)

Указать fulltext для таблицы.
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')

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

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

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

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

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

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

Создать новый столбец с автоинкрементом типа big integer (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)

Создать новый целочисленный столбец (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)

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

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

Создать новый столбец без знака малого целого числа (2 байта) в таблице.
ColumnDefinition unsignedMediumInteger(string $column, bool $autoIncrement = false)

Создать новый столбец без знака среднего целого числа (3 байта) в таблице.
ColumnDefinition unsignedBigInteger(string $column, bool $autoIncrement = false)

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

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

Создать столбец внешнего ключа для данной модели.
ColumnDefinition float(string $column, int $precision = 53)

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

Создать новый столбец с типом double в таблице.
ColumnDefinition decimal(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)

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

Создать новый столбец типа date-time (с часовым поясом) в таблице.
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)

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

Добавить timestampTz "deleted at" для таблицы.
ColumnDefinition softDeletesDatetime(string $column = 'deleted_at', int|null $precision = 0)

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

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

Создать новый бинарный столбец в таблице.
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, string|null $subtype = null, int $srid = 0)

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

Создать новый географический столбец в таблице.
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()

Получить команды в схеме.
BlueprintState getState()

Получить состояние схемы.
ColumnDefinition[] getAddedColumns()

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

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

Подробности

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

смешанный тип __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

смешанный тип

Исключения

BadMethodCallException

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

Создать новый шаблон схемы.

Параметры

string $table
Closure|null $callback
string $prefix

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

void

void build(Connection $connection, Grammar $grammar)

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

Параметры

Connection $connection
Grammar $grammar

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

void

array toSql(Connection $connection, Grammar $grammar)

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

Параметры

Connection $connection
Grammar $grammar

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

array

protected void ensureCommandsAreValid(Connection $connection)

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

Параметры

Connection $connection

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

void

Исключения

BadMethodCallException

protected Collection commandsNamed(array $names) устарело

устарело

Будет удалено в будущей версии Laravel.

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

Параметры

array $names

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

Collection

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

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

Параметры

Connection $connection
Grammar $grammar

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

void

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

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

Параметры

Connection $connection
Grammar $grammar

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

void

void addFluentCommands(Connection $connection, Grammar $grammar)

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

Параметры

Connection $connection
Grammar $grammar

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

void

void addAlterCommands(Connection $connection, Grammar $grammar)

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

Параметры

Connection $connection
Grammar $grammar

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

void

bool creating()

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

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

bool

Fluent create()

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

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

Fluent

void engine(string $engine)

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

Параметры

string $engine

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

void

void innoDb()

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

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

void

void charset(string $charset)

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

Параметры

string $charset

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

void

void collation(string $collation)

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

Параметры

string $collation

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

void

void temporary()

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

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

void

Fluent drop()

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

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

Fluent

Fluent dropIfExists()

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

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

Fluent

Fluent dropColumn(array|mixed $columns)

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

Параметры

array|mixed $columns

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

Fluent

Fluent renameColumn(string $from, string $to)

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

Параметры

string $from
string $to

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

Fluent

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

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

Параметры

string|array|null $index

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

Fluent

Fluent dropUnique(string|array $index)

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

Параметры

string|array $index

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

Fluent

Fluent dropIndex(string|array $index)

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

Параметры

string|array $index

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

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()

Указать, что столбец remember token следует удалить.

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

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)

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

Параметры

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)

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

Параметры

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')

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition increments(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition integerIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition tinyIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition smallIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition mediumIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition bigIncrements(string $column)

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

Parameters

string $column

Return Value

ColumnDefinition

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

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

Parameters

string $column
int|null $length

Return Value

ColumnDefinition

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

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

Parameters

string $column
int|null $length

Return Value

ColumnDefinition

ColumnDefinition tinyText(string $column)

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

Parameters

string $column

Return Value

ColumnDefinition

ColumnDefinition text(string $column)

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

Parameters

string $column

Return Value

ColumnDefinition

ColumnDefinition mediumText(string $column)

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

Parameters

string $column

Return Value

ColumnDefinition

ColumnDefinition longText(string $column)

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

Parameters

string $column

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement

Return Value

ColumnDefinition

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

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

Parameters

string $column
bool $autoIncrement

Return Value

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(Model|string $model, string|null $column = null)

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

Параметры

Model|string $model
string|null $column

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

ForeignIdColumnDefinition

ColumnDefinition float(string $column, int $precision = 53)

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

Параметры

string $column
int $precision

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

ColumnDefinition

ColumnDefinition double(string $column)

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

Параметры

string $column

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

ColumnDefinition

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

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

Параметры

string $column
int $total
int $places

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

ColumnDefinition

ColumnDefinition boolean(string $column)

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

Параметры

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)

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

Параметры

string $column

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

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

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

Параметры

string $column
int|null $precision

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

ColumnDefinition

void timestamps(int|null $precision = 0)

Добавьте маркеры создания и обновления (с возможностью null) в таблицу.

Параметры

int|null $precision

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

void

void nullableTimestamps(int|null $precision = 0)

Добавьте маркеры создания и обновления (с возможностью null) в таблицу.

Псевдоним для 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)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition binary(string $column, int|null $length = null, bool $fixed = false)

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

Параметры

string $column
int|null $length
bool $fixed

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

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
END_OF_DOCUMENT_MARKER

ColumnDefinition macAddress(string $column = 'mac_address')

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition geometry(string $column, string|null $subtype = null, int $srid = 0)

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

Параметры

string $column
string|null $subtype
int $srid

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

ColumnDefinition

ColumnDefinition geography(string $column, string|null $subtype = null, int $srid = 4326)

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

Параметры

string $column
string|null $subtype
int $srid

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

ColumnDefinition

ColumnDefinition computed(string $column, string $expression)

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

Параметры

string $column
string $expression

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

ColumnDefinition

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

ColumnDefinition rememberToken()

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

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

ColumnDefinition

Fluent comment(string $comment)

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

Параметры

string $comment

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

Fluent

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

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

Параметры

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

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

Fluent

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

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

Параметры

string $command
string $type
string|array $index

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

Fluent

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

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

Параметры

string $type
array $columns

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

string

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

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

Параметры

string $type
string $name
array $parameters

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

ColumnDefinition

protected ColumnDefinition addColumnDefinition(ColumnDefinition $definition)

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

Параметры

ColumnDefinition $definition

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

ColumnDefinition

void after(string $column, Closure $callback)

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

Параметры

string $column
Closure $callback

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

void

$this removeColumn(string $name)

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

Параметры

string $name

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

$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[]

BlueprintState getState()

Получить состояние чертежа.

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

BlueprintState

ColumnDefinition[] getAddedColumns()

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

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

ColumnDefinition[]

ColumnDefinition[] getChangedColumns() deprecated

deprecated

Будет удален в будущей версии Laravel.

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

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

ColumnDefinition[]

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

Spec-Zone.ru

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