Spec-Zone.ru › Laravel 9

Чертеж

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

Трейты

Macroable

Свойства

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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 $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(Grammar $grammar)

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

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

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

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

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

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

Указать, что заданный индекс fulltext следует удалить.
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()

Указать, что столбец remember token следует удалить.
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)

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

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

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

Создать новый столбец unsigned big integer (8 байт) в таблице.
ForeignIdColumnDefinition foreignId(string $column)

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

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

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

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

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

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

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

Добавить столбцы timestampTz создания и обновления в таблицу.
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 year(string $column)

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

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

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

Создать новый столбец типа UUID в таблице с ограничением внешнего ключа.
ColumnDefinition ulid(string $column = 'uuid', 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)

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

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

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

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

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

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

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

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

Определить, содержит ли черновик столбцы с автоинкрементом.
array autoIncrementingStartingValues()

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

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

Создать новый чертеж схемы.

Параметры

string $table
Closure $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)

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

Параметры

array $names

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

Collection

protected void addImpliedCommands(Grammar $grammar)

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

Параметры

Grammar $grammar

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

void

protected void addFluentIndexes()

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

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

void

void addFluentCommands(Grammar $grammar)

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

Параметры

Grammar $grammar

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

void

bool creating()

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

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

bool

Fluent create()

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

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

Fluent

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
END_OF_DOCUMENT_MARKER

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)

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

Параметры

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

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

Fluent

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

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

Параметры

Модель|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

ОпределениеИндекса primary(string|array $columns, string|null $name = null, string|null $algorithm = null)

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

Параметры

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

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

ОпределениеИндекса
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition increments(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition integerIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition tinyIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition smallIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition mediumIncrements(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition bigIncrements(string $column)

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

Параметры

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)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition mediumText(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition longText(string $column)

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

Параметры

string $column

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

ColumnDefinition

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

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

Параметры

string $column
bool $autoIncrement

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

ColumnDefinition

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

Создать новый беззнаковый столбец для малых целых чисел (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(Model|string $model, string|null $column = null)

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

Параметры

Model|string $model
string|null $column

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

ForeignIdColumnDefinition

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

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

Параметры

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)

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

Параметры

string $column
int $total
int $places

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

ColumnDefinition

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

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

Параметры

string $column
int $total
int $places

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

ColumnDefinition

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

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

Параметры

string $column
int $total
int $places

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

ColumnDefinition

ColumnDefinition boolean(string $column)

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

Параметры

string $column

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

ColumnDefinition

ColumnDefinition enum(string $column, array $allowed)

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

Параметры

string $column
array $allowed

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

ColumnDefinition

ColumnDefinition set(string $column, array $allowed)

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

Параметры

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)

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

Параметры

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

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

Добавить метку времени "deleted at" в таблицу.

Параметры

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 year(string $column)

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

Параметры

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 = 'uuid', 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)

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

Параметры

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)

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

string $name
string|null $indexName

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

void

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

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

Параметры

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)

Добавить необязательные столбцы для полиморфной таблицы, используя 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)

Добавить необязательные столбцы для полиморфной таблицы, используя 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

ColumnDefinition[] getColumns()

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

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

ColumnDefinition[]

Fluent[] getCommands()

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

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

Fluent[]

ColumnDefinition[] getAddedColumns()

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

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

ColumnDefinition[]

ColumnDefinition[] getChangedColumns()

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

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

ColumnDefinition[]

bool hasAutoIncrementColumn()

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

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

bool

array autoIncrementingStartingValues()

Получить начальные значения столбцов с автоматическим увеличением.

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

array

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

Spec-Zone.ru

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