Блок-схема

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

Свойства

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	dropSoftDeletesTz() Указать, что столбец мягкого удаления следует удалить.
void	dropRememberToken() Указать, что столбец маркера запоминания следует удалить.
Fluent	rename(string $to) Переименовать таблицу в заданное имя.
Fluent	primary(string\|array $columns, string $name = null, string\|null $algorithm = null) Указать первичный(е) ключ(и) для таблицы.
Fluent	unique(string\|array $columns, string $name = null, string\|null $algorithm = null) Указать уникальный индекс для таблицы.
Fluent	index(string\|array $columns, string $name = null, string\|null $algorithm = 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) Создать новый строковый столбец в таблице.
Fluent	text(string $column) Создать новый текстовый столбец в таблице.
Fluent	mediumText(string $column) Создать новый столбец среднего текста в таблице.
Fluent	longText(string $column) Создать новый столбец длинного текста в таблице.
Fluent	integer(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый целочисленный столбец (4 байта) в таблице.
Fluent	tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец малых целых чисел (1 байт) в таблице.
Fluent	smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец малых целых чисел (2 байта) в таблице.

Fluent	mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец типа целого числа со средней длиной (3 байта) в таблице.
Fluent	bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец типа большого целого числа (8 байтов) в таблице.
Fluent	unsignedTinyInteger(string $column, bool $autoIncrement = false) Создать новый столбец типа беззнакового целого числа малой длины (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) Создать новый столбец типа boolean в таблице.
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() Добавить столбцы отметки времени (с часовым поясом) создания и обновления в таблицу.
Fluent	softDeletes() Добавить столбец "deleted_at" типа timestamp в таблицу.
Fluent	softDeletesTz() Добавить столбец "deleted_at" типа timestampTz в таблицу.
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) Добавить необходимые столбцы для полиморфной таблицы.
void	nullableMorphs(string $name, string\|null $indexName = null) Добавить столбцы для полиморфной таблицы с возможностью NULL.
Fluent	rememberToken() Добавляет столбец `remember_token` в таблицу.
Fluent	dropIndexCommand(string $command, string $type, string\|array $index) Создать новую команду удаления индекса в черновике.
Fluent	indexCommand(string $type, string\|array $columns, string $index, string\|null $algorithm = null) Добавить новую команду индексации в черновик.
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() Получить столбцы в схеме.
array	getCommands() Получить команды в схеме.
array	getAddedColumns() Получить столбцы в схеме, которые нужно добавить.
array	getChangedColumns() Получить столбцы в схеме, которые нужно изменить.

Подробности

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

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

Параметры

string	$table
Closure	$callback

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

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

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

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

void

protected void addFluentIndexes()

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

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

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

END_OF_DOCUMENT_MARKER

void dropSoftDeletes()

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

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

void

void dropSoftDeletesTz()

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

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

void

void dropRememberToken()

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

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

void

Fluent rename(string $to)

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

Параметры

string

$to

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

Fluent

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

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

Параметры

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

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

Fluent

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

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

Параметры

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

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

Fluent

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

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

Параметры

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

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

Fluent

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

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

Параметры

string\|array	$columns
string	$name

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

Fluent

Fluent increments(string $column)

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

Параметры

string

$column

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

Fluent

Fluent smallIncrements(string $column)

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

Параметры

string

$column

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

Fluent

Fluent mediumIncrements(string $column)

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

Параметры

string

$column

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

Fluent

Fluent bigIncrements(string $column)

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

Параметры

string

$column

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

Fluent

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

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

Параметры

string	$column
int	$length

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

Fluent

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

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

Параметры

string	$column
int	$length

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

Fluent

Fluent text(string $column)

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

Параметры

string

$column

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

Fluent

Fluent mediumText(string $column)

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

Параметры

string

$column

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

Fluent

Fluent longText(string $column)

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

Параметры

string

$column

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

END_OF_DOCUMENT_MARKER

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement
bool	$unsigned

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

Параметры

string	$column
bool	$autoIncrement

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

Fluent

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

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

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

Параметры

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

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

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

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

void

void timestamps()

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

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

void

void timestampsTz()

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

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

void

Fluent softDeletes()

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

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

Fluent

Fluent softDeletesTz()

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

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

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

void nullableMorphs(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

END_OF_DOCUMENT_MARKER

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