Чертеж

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

Свойства

protected string	$table	Таблица, описываемая чертежом.
protected array	$columns	Столбцы, которые должны быть добавлены в таблицу.
protected array	$commands	Команды, которые должны быть выполнены для таблицы.
string	$engine	Двигатель хранения, который должен быть использован для таблицы.
$charset	Набор символов по умолчанию, который должен быть использован для таблицы.
$collation	Коллирование, которое должно быть использовано для таблицы.
bool	$temporary	Указывает, должна ли таблица быть временной.

Методы

void	__construct(string $table, Closure $callback = null) Создать новую схему проекта.
void	build(Connection $connection, Grammar $grammar) Выполнить проект по отношению к базе данных.
array	toSql(Connection $connection, Grammar $grammar) Получить исходные SQL-запросы для проекта.
void	addImpliedCommands() Добавить команды, подразумеваемые проектом.
void	addFluentIndexes() Добавить команды индексов, указанные в столбцах.
bool	creating() Определить, есть ли в проекте команда создания.
Fluent	create() Указать, что таблица должна быть создана.
void	temporary() Указать, что таблица должна быть временной.
Fluent	drop() Указать, что таблица должна быть удалена.
Fluent	dropIfExists() Указать, что таблица должна быть удалена, если существует.
Fluent	dropColumn(array\|mixed $columns) Указать, что заданные столбцы должны быть удалены.
Fluent	renameColumn(string $from, string $to) Указать, что заданные столбцы должны быть переименованы.
Fluent	dropPrimary(string\|array $index = null) Указать, что заданный первичный ключ должен быть удален.
Fluent	dropUnique(string\|array $index) Указать, что заданный уникальный ключ должен быть удален.
Fluent	dropIndex(string\|array $index) Указать, что заданный индекс должен быть удален.
Fluent	dropForeign(string\|array $index) Указать, что заданный внешний ключ должен быть удален.
void	dropTimestamps() Указать, что столбцы временных меток должны быть удалены.
void	dropTimestampsTz() Указать, что столбцы временных меток должны быть удалены.
void	dropSoftDeletes() Указать, что столбец мягкого удаления должен быть удален.
void	dropRememberToken() Указать, что столбец маркера запоминания должен быть удален.
Fluent	rename(string $to) Переименовать таблицу в заданное имя.
Fluent	primary(string\|array $columns, string $name = null) Указать первичный(ые) ключ(и) для таблицы.
Fluent	unique(string\|array $columns, string $name = null) Указать уникальный индекс для таблицы.
Fluent	index(string\|array $columns, string $name = null) Указать индекс для таблицы.
Fluent	foreign(string\|array $columns, string $name = null) Указать внешний ключ для таблицы.
Fluent	increments(string $column) Создать новый столбец целого типа с автоматическим увеличением (4 байта) в таблице.
Fluent	smallIncrements(string $column) Создать новый столбец малого целого типа с автоматическим увеличением (2 байта) в таблице.
Fluent	mediumIncrements(string $column) Создать новый столбец среднего целого типа с автоматическим увеличением (3 байта) в таблице.
Fluent	bigIncrements(string $column) Создать новый столбец большого целого типа с автоматическим увеличением (8 байт) в таблице.
Fluent	char(string $column, int $length = 255) Создать новый столбец char в таблице.
Fluent	string(string $column, int $length = 255) Создать новый столбец string в таблице.
Fluent	text(string $column) Создать новый столбец text в таблице.
Fluent	mediumText(string $column) Создать новый столбец medium text в таблице.
Fluent	longText(string $column) Создать новый столбец long text в таблице.
Fluent	integer(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец integer (4 байта) в таблице.
Fluent	tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец tiny integer (1 байт) в таблице.
Fluent	smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец small integer (2 байта) в таблице.
Fluent	mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец medium integer (3 байта) в таблице.

Fluent	bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец большого целого числа (8 байт) в таблице.
Fluent	unsignedTinyInteger(string $column, bool $autoIncrement = false) Создать новый столбец беззнакового целого числа tiny (1 байт) в таблице.
Fluent	unsignedSmallInteger(string $column, bool $autoIncrement = false) Создать новый столбец беззнакового малого целого числа (2 байта) в таблице.
Fluent	unsignedMediumInteger(string $column, bool $autoIncrement = false) Создать новый столбец беззнакового среднего целого числа (3 байта) в таблице.
Fluent	unsignedInteger(string $column, bool $autoIncrement = false) Создать новый столбец беззнакового целого числа (4 байта) в таблице.
Fluent	unsignedBigInteger(string $column, bool $autoIncrement = false) Создать новый столбец беззнакового большого целого числа (8 байт) в таблице.
Fluent	float(string $column, int $total = 8, int $places = 2) Создать новый столбец с плавающей точкой в таблице.
Fluent	double(string $column, int\|null $total = null, int\|null $places = null) Создать новый столбец double в таблице.
Fluent	decimal(string $column, int $total = 8, int $places = 2) Создать новый столбец decimal в таблице.
Fluent	boolean(string $column) Создать новый логический столбец в таблице.
Fluent	enum(string $column, array $allowed) Создать новый столбец типа перечисления в таблице.
Fluent	json(string $column) Создать новый столбец json в таблице.
Fluent	jsonb(string $column) Создать новый столбец jsonb в таблице.
Fluent	date(string $column) Создать новый столбец типа дата в таблице.
Fluent	dateTime(string $column) Создать новый столбец типа дата и время в таблице.
Fluent	dateTimeTz(string $column) Создать новый столбец типа дата и время (с часовым поясом) в таблице.
Fluent	time(string $column) Создать новый столбец типа время в таблице.
Fluent	timeTz(string $column) Создать новый столбец типа время (с часовым поясом) в таблице.
Fluent	timestamp(string $column) Создать новый столбец типа отметка времени в таблице.
Fluent	timestampTz(string $column) Создать новый столбец типа отметка времени (с часовым поясом) в таблице.
void	nullableTimestamps() Добавить столбцы создания и обновления с возможностью NULL в таблицу.
void	timestamps() Добавить столбцы создания и обновления с возможностью NULL в таблицу.
void	timestampsTz() Добавить столбцы создания и обновления timestampTz в таблицу.
Fluent	softDeletes() Добавить столбец "deleted at" (время удаления) в таблицу.
Fluent	binary(string $column) Создать новый бинарный столбец в таблице.
Fluent	uuid(string $column) Создать новый столбец uuid в таблице.
Fluent	ipAddress(string $column) Создать новый столбец IP-адреса в таблице.
Fluent	macAddress(string $column) Создать новый столбец MAC-адреса в таблице.
void	morphs(string $name, string\|null $indexName = null) Добавить необходимые столбцы для полиморфной таблицы.
Fluent	rememberToken() Добавляет столбец `remember_token` в таблицу.
Fluent	dropIndexCommand(string $command, string $type, string\|array $index) Создать новую команду удаления индекса в плане.
Fluent	indexCommand(string $type, string\|array $columns, string $index) Добавить новую команду индексации в план.
string	createIndexName(string $type, array $columns) Создать имя индекса по умолчанию для таблицы.
Fluent	addColumn(string $type, string $name, array $parameters = []) Добавить новый столбец в схему.
$this	removeColumn(string $name) Удалить столбец из схемы.
Fluent	addCommand(string $name, array $parameters = []) Добавить новую команду в план.
Fluent	createCommand(string $name, array $parameters = []) Создать новую команду Fluent.
string	getTable() Получить таблицу, описанную планом.
array	getColumns() Получить столбцы в плане.

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

Подробности

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

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

Параметры

string	$table
Closure	$callback

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

void

void build(Connection $connection, Grammar $grammar)

Выполнить чертёж схемы в базе данных.

Параметры

Connection	$connection
Grammar	$grammar

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

void

массив toSql(Connection $connection, Grammar $grammar)

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

Параметры

Connection	$connection
Grammar	$grammar

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

массив

protected void addImpliedCommands()

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

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

void

protected void addFluentIndexes()

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

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

void

protected 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 $index = null)

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

Параметры

string|array

$index

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

Fluent

Fluent dropUnique(string|array $index)

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

Параметры

string|array

$index

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

Fluent

Fluent dropIndex(string|array $index)

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

Параметры

string|array

$index

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

Fluent

Fluent dropForeign(string|array $index)

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

Параметры

string|array

$index

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

Fluent

void dropTimestamps()

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

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

void

void dropTimestampsTz()

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

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

void

void dropSoftDeletes()

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

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

void

void dropRememberToken()

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

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

void

END_OF_DOCUMENT_MARKER

Fluent rename(string $to)

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

Parameters

string

$to

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string	$name

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string	$name

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string	$name

Return Value

Fluent

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

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

Parameters

string\|array	$columns
string	$name

Return Value

Fluent

Fluent increments(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent smallIncrements(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent mediumIncrements(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent bigIncrements(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent char(string $column, int $length = 255)

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

Parameters

string	$column
int	$length

Return Value

Fluent

Fluent string(string $column, int $length = 255)

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

Parameters

string	$column
int	$length

Return Value

Fluent

Fluent text(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent mediumText(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent longText(string $column)

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

Parameters

string

$column

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

Fluent float(string $column, int $total = 8, int $places = 2)

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

Параметры

string	$column
int	$total
int	$places

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

Fluent

Fluent double(string $column, int|null $total = null, int|null $places = null)

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

Параметры

string	$column
int\|null	$total
int\|null	$places

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

Fluent

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

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

Параметры

string	$column
int	$total
int	$places

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

Fluent

Fluent boolean(string $column)

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

Параметры

string

$column

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

Fluent

Fluent enum(string $column, array $allowed)

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

Параметры

string	$column
array	$allowed

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

Fluent

Fluent json(string $column)

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

Параметры

string

$column

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

Fluent

Fluent jsonb(string $column)

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

Параметры

string

$column

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

Fluent

Fluent date(string $column)

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

Параметры

string

$column

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

Fluent

Fluent dateTime(string $column)

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

Параметры

string

$column

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

Fluent

Fluent dateTimeTz(string $column)

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

Параметры

string

$column

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

Fluent

Fluent time(string $column)

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

Параметры

string

$column

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

Fluent

Fluent timeTz(string $column)

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

Параметры

string

$column

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

Fluent

Fluent timestamp(string $column)

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

Параметры

string

$column

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

Fluent

Fluent timestampTz(string $column)

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

Параметры

string

$column

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

Fluent

void nullableTimestamps()

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

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

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

void

void timestamps()

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

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

void

void timestampsTz()

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

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

void

Fluent softDeletes()

Добавить столбец "deleted at" (время удаления) в таблицу.

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

Fluent

Fluent binary(string $column)

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

Параметры

string

$column

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

Fluent

Fluent uuid(string $column)

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

Параметры

string

$column

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

Fluent

Fluent ipAddress(string $column)

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

Параметры

string

$column

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

Fluent

Fluent macAddress(string $column)

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

Параметры

string

$column

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

Fluent

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

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

Параметры

string	$name
string\|null	$indexName

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

void

Fluent rememberToken()

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

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

Fluent

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

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

Параметры

string	$command
string	$type
string\|array	$index

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

Fluent

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

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

Параметры

string	$type
string\|array	$columns
string	$index

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

Fluent

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

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

Параметры

string	$type
array	$columns

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

string

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

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

Параметры

string	$type
string	$name
array	$parameters

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

Fluent

$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

array getColumns()

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

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

array

array getCommands()

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

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

array

array getAddedColumns()

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

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

array

array getChangedColumns()

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

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

array

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