Чертеж

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

Трейты

Свойства

статический защищённый массив	$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(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	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) Переименовать таблицу в заданное имя.
Fluent	primary(string\|array $columns, string\|null $name = null, string\|null $algorithm = null) Указать первичный(е) ключ(и) для таблицы.
Fluent	unique(string\|array $columns, string\|null $name = null, string\|null $algorithm = null) Указать уникальный индекс для таблицы.

Fluent	index(string\|array $columns, string\|null $name = null, string\|null $algorithm = null) Указать индекс для таблицы.
Fluent	fullText(string\|array $columns, string\|null $name = null, string\|null $algorithm = null) Указать полнотекстовый индекс для таблицы.
Fluent	spatialIndex(string\|array $columns, string\|null $name = null) Указать пространственный индекс для таблицы.
Fluent	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) Создать новый столбец типа 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) Создать новый беззнаковый целочисленный столбец (4 байта) в таблице.
ColumnDefinition	unsignedTinyInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец типа tiny integer (1 байт) в таблице.
ColumnDefinition	unsignedSmallInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец типа small integer (2 байта) в таблице.
ColumnDefinition	unsignedMediumInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец типа medium integer (3 байта) в таблице.
ColumnDefinition	unsignedBigInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец типа big integer (8 байт) в таблице.
ForeignIdColumnDefinition	foreignId(string $column) Создать новый беззнаковый столбец типа 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) Создать новый десятичный столбец в таблице.
ColumnDefinition	unsignedFloat(string $column, int $total = 8, int $places = 2) Создать новый беззнаковый столбец с плавающей запятой в таблице.
ColumnDefinition	unsignedDouble(string $column, int $total = null, int $places = null) Создать новый беззнаковый столбец с двойной точностью в таблице.
ColumnDefinition	unsignedDecimal(string $column, int $total = 8, int $places = 2) Создать новый беззнаковый десятичный столбец в таблице.
ColumnDefinition	boolean(string $column) Создать новый логический столбец в таблице.
ColumnDefinition	enum(string $column, array $allowed) Создать новый столбец перечисления в таблице.
ColumnDefinition	set(string $column, array $allowed) Создать новый столбец множества в таблице.
ColumnDefinition	json(string $column) Создать новый столбец JSON в таблице.
ColumnDefinition	jsonb(string $column) Создать новый столбец JSONB в таблице.
ColumnDefinition	date(string $column) Создать новый столбец даты в таблице.
ColumnDefinition	dateTime(string $column, int $precision = 0) Создать новый столбец даты и времени в таблице.
ColumnDefinition	dateTimeTz(string $column, int $precision = 0) Создать новый столбец даты и времени (с часовым поясом) в таблице.
ColumnDefinition	time(string $column, int $precision = 0) Создать новый столбец времени в таблице.
ColumnDefinition	timeTz(string $column, int $precision = 0) Создать новый столбец времени (с часовым поясом) в таблице.
ColumnDefinition	timestamp(string $column, int $precision = 0) Создать новый столбец отметки времени в таблице.
ColumnDefinition	timestampTz(string $column, int $precision = 0) Создать новый столбец отметки времени (с часовым поясом) в таблице.
void	timestamps(int $precision = 0) Добавить необязательные метки создания и обновления в таблицу.
void	nullableTimestamps(int $precision = 0) Добавить необязательные метки создания и обновления в таблицу.
void	timestampsTz(int $precision = 0) Добавить столбцы создания и обновления timestampTz в таблицу.
ColumnDefinition	softDeletes(string $column = 'deleted_at', int $precision = 0) Добавить метку "удалено в" (timestamp) для таблицы.
ColumnDefinition	softDeletesTz(string $column = 'deleted_at', int $precision = 0) Добавить метку "удалено в" (timestampTz) для таблицы.
ColumnDefinition	year(string $column) Создать новый столбец года в таблице.
ColumnDefinition	binary(string $column) Создать новый двоичный столбец в таблице.
ColumnDefinition	uuid(string $column) Создать новый столбец UUID в таблице.
ForeignIdColumnDefinition	foreignUuid(string $column) Создать новый столбец UUID в таблице с ограничением внешнего ключа.
ColumnDefinition	ipAddress(string $column) Создать новый столбец IP-адреса в таблице.
ColumnDefinition	macAddress(string $column) Создать новый столбец 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) Создать новый столбец множества многоугольников в таблице.

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.
ColumnDefinition	rememberToken() Добавляет столбец `remember_token` в таблицу.
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)

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

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)

Выполнить схему по отношению к базе данных.

Параметры

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

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

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

void

void addFluentCommands(Grammar $grammar)

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

Параметры

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

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)

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

Parameters

string|array

$index

Return Value

Fluent

Fluent dropConstrainedForeignId(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent renameIndex(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

Fluent

void dropTimestamps()

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

Return Value

void

void dropTimestampsTz()

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

Return Value

void

void dropSoftDeletes(string $column = 'deleted_at')

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

Parameters

string

$column

Return Value

void

void dropSoftDeletesTz(string $column = 'deleted_at')

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

Parameters

string

$column

Return Value

void

void dropRememberToken()

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

Return Value

void

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

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

Parameters

string	$name
string\|null	$indexName

Return Value

void

Fluent rename(string $to)

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

Parameters

string

$to

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string\|null	$name

Return Value

Fluent

Fluent rawIndex(string $expression, string $name)

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

Parameters

string	$expression
string	$name

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string\|null	$name

Return Value

ForeignKeyDefinition

ColumnDefinition id(string $column = 'id')

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

Parameters

string

$column

Return Value

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

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

Параметры

string

$column

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

ColumnDefinition

ColumnDefinition longText(string $column)

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

Параметры

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 байт) в таблице.

Параметры

строка	$column
логическое	$autoIncrement
логическое	$unsigned

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

ColumnDefinition

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

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

Параметры

строка	$column
логическое	$autoIncrement

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

ColumnDefinition

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

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

Параметры

строка	$column
логическое	$autoIncrement

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

ColumnDefinition

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

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

Параметры

строка	$column
логическое	$autoIncrement

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

ColumnDefinition

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

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

Параметры

строка	$column
логическое	$autoIncrement

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

ColumnDefinition

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

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

Параметры

строка	$column
логическое	$autoIncrement

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

ColumnDefinition

ForeignIdColumnDefinition foreignId(string $column)

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

Параметры

строка

$column

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

ForeignIdColumnDefinition

ForeignIdColumnDefinition foreignIdFor(Model|string $model, string|null $column = null)

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

Параметры

Model\|строка	$model
строка\|null	$column

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

ForeignIdColumnDefinition

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

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

Параметры

строка	$column
целое	$total
целое	$places
логическое	$unsigned

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

ColumnDefinition

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

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

Параметры

строка	$column
целое\|null	$total
целое\|null	$places
логическое	$unsigned

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

ColumnDefinition

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

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

Параметры

строка	$column
целое	$total
целое	$places
логическое	$unsigned

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

ColumnDefinition

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

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

Параметры

строка	$column
целое	$total
целое	$places

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

ColumnDefinition

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

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

Параметры

строка	$column
целое	$total
целое	$places

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

ColumnDefinition

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

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

Параметры

строка	$column
целое	$total
целое	$places

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

ColumnDefinition

ColumnDefinition boolean(string $column)

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

Parameters

string

$column

Return Value

ColumnDefinition

ColumnDefinition enum(string $column, array $allowed)

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

Parameters

string	$column
array	$allowed

Return Value

ColumnDefinition

ColumnDefinition set(string $column, array $allowed)

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

Parameters

string	$column
array	$allowed

Return Value

ColumnDefinition

ColumnDefinition json(string $column)

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

Parameters

string

$column

Return Value

ColumnDefinition

ColumnDefinition jsonb(string $column)

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

Parameters

string

$column

Return Value

ColumnDefinition

ColumnDefinition date(string $column)

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

Parameters

string

$column

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

void timestamps(int $precision = 0)

Добавить создание и обновление строк в таблицу с возможностью NULL.

Parameters

int

$precision

Return Value

void

void nullableTimestamps(int $precision = 0)

Добавить создание и обновление строк в таблицу с возможностью NULL.

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

Parameters

int

$precision

Return Value

void

void timestampsTz(int $precision = 0)

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

Parameters

int

$precision

Return Value

void

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

Добавить метку удаления timestamp для таблицы.

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

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

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

Parameters

string	$column
int	$precision

Return Value

ColumnDefinition

ColumnDefinition year(string $column)

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

Параметры

string

$column

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

ColumnDefinition

ColumnDefinition binary(string $column)

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

Параметры

string

$column

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

ColumnDefinition

ColumnDefinition uuid(string $column)

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

Параметры

string

$column

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

ColumnDefinition

ForeignIdColumnDefinition foreignUuid(string $column)

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

Параметры

string

$column

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

ForeignIdColumnDefinition

ColumnDefinition ipAddress(string $column)

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

Параметры

string

$column

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

ColumnDefinition

ColumnDefinition macAddress(string $column)

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

Параметры

string

$column

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

ColumnDefinition

ColumnDefinition geometry(string $column)

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

Параметры

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)

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

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)

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

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

Parameters

string	$name
string\|null	$indexName

Return Value

void

ColumnDefinition rememberToken()

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

Return Value

ColumnDefinition

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 = [])

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

Parameters

string	$name
array	$parameters

Return Value

Fluent

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

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

Parameters

string	$name
array	$parameters

Return Value

Fluent

string getTable()

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

Return Value

string

ColumnDefinition[] getColumns()

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

Return Value

ColumnDefinition[]

Fluent[] getCommands()

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

Return Value

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/8.x/Illuminate/Database/Schema/Blueprint.html