Чертеж

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

Свойства

защищенная строка	$table	Таблица, описываемая чертежом.
защищенный массив	$columns	Столбцы, которые должны быть добавлены в таблицу.
защищенный массив	$commands	Команды, которые должны быть выполнены для таблицы.
строка	$engine	Двигатель хранения, который должен использоваться для таблицы.

Методы

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() Указать, что таблица должна быть создана.
Fluent	drop() Указать, что таблица должна быть удалена.
Fluent	dropIfExists() Указать, что таблица должна быть удалена, если существует.
Fluent	dropColumn(string\|array $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 $index) Указать, что заданный внешний ключ должен быть удален.
void	dropTimestamps() Указать, что столбцы временных меток должны быть удалены.
void	dropSoftDeletes() Указать, что столбец мягкого удаления должен быть удален.
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) Создать новый автоинкрементирующий целочисленный столбец в таблице.
Fluent	bigIncrements(string $column) Создать новый автоинкрементирующий столбец большого целого типа в таблице.
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) Создать новый целочисленный столбец в таблице.
Fluent	bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец большого целого типа в таблице.
Fluent	mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец среднего целого типа в таблице.
Fluent	tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец малого целого типа в таблице.
Fluent	smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false) Создать новый столбец малого целого типа в таблице.
Fluent	unsignedInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый целочисленный столбец в таблице.
Fluent	unsignedBigInteger(string $column, bool $autoIncrement = false) Создать новый беззнаковый столбец большого целого типа в таблице.
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) Создать новый столбец enum в таблице.
Fluent	date(string $column) Создать новый столбец date в таблице.
Fluent	dateTime(string $column) Создать новый столбец date-time в таблице.
Fluent	time(string $column) Создать новый столбец time в таблице.
Fluent	timestamp(string $column) Создать новый столбец timestamp в таблице.
void	nullableTimestamps() Добавить nullable метки создания и обновления в таблицу.
void	timestamps() Добавить метки создания и обновления в таблицу.
Fluent	softDeletes() Добавить метку "deleted at" в таблицу.
Fluent	binary(string $column) Создать новый столбец binary в таблице.
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 = array()) Добавить новый столбец в схему.
$this	removeColumn(string $name) Удалить столбец из схемы.
Fluent	addCommand(string $name, array $parameters = array()) Добавить новую команду в схему.
Fluent	createCommand(string $name, array $parameters = array()) Создать новую команду Fluent.
string	getTable() Получить имя таблицы.
array	getColumns() Получить столбцы, которые нужно добавить.
array	getCommands() Получить команды в схеме.

Details

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

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

Parameters

string	$table
Closure	$callback

Return Value

void

void build(Connection $connection, Grammar $grammar)

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

Parameters

Connection	$connection
Grammar	$grammar

Return Value

void

array toSql(Connection $connection, Grammar $grammar)

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

Parameters

Connection	$connection
Grammar	$grammar

Return Value

array

protected void addImpliedCommands()

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

Return Value

void

protected void addFluentIndexes()

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

Return Value

void

protected bool creating()

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

Return Value

bool

Fluent create()

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

Return Value

Fluent

Fluent drop()

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

Return Value

Fluent

Fluent dropIfExists()

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

Return Value

Fluent

Fluent dropColumn(string|array $columns)

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

Параметры

string|array

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

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

Параметры

string

$index

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

Fluent

void dropTimestamps()

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

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

void

void dropSoftDeletes()

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

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

void

Fluent rename(string $to)

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

Параметры

string

$to

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

Fluent

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

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

Параметры

string\|array	$columns
string	$name

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

Fluent

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

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

Параметры

string\|array	$columns
string	$name

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

Fluent

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

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

Параметры

string\|array	$columns
string	$name

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

Fluent

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

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

Параметры

string\|array	$columns
string	$name

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

Fluent

Fluent increments(string $column)

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

Параметры

string

$column

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

Fluent

Fluent bigIncrements(string $column)

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

Параметры

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

Parameters

string

$column

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement
bool	$unsigned

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement

Return Value

Fluent

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

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

Parameters

string	$column
bool	$autoIncrement

Return Value

Fluent

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

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

Parameters

string	$column
int	$total
int	$places

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

string	$column
int	$total
int	$places

Return Value

Fluent

Fluent boolean(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent enum(string $column, array $allowed)

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

Parameters

string	$column
array	$allowed

Return Value

Fluent

Fluent date(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent dateTime(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent time(string $column)

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

Parameters

string

$column

Return Value

Fluent

Fluent timestamp(string $column)

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

Parameters

string

$column

Return Value

Fluent

void nullableTimestamps()

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

Return Value

void

void timestamps()

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

Return Value

void

Fluent softDeletes()

Добавить столбец "deleted at" в таблицу.

Return Value

Fluent

Fluent binary(string $column)

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

Parameters

string

$column

Return Value

Fluent

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

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

Parameters

string	$name
string\|null	$indexName

Return Value

void

Fluent rememberToken()

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

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 Fluent indexCommand(string $type, string|array $columns, string $index)

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

Parameters

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

Return Value

Fluent

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

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

Parameters

string	$type
array	$columns

Return Value

string

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

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

Parameters

string	$type
string	$name
array	$parameters

Return Value

Fluent

$this removeColumn(string $name)

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

Parameters

string

$name

Return Value

$this

protected Fluent addCommand(string $name, array $parameters = array())

Добавить новую команду в шаблон.

Parameters

string	$name
array	$parameters

Return Value

Fluent

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

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

Parameters

string	$name
array	$parameters

Return Value

Fluent

string getTable()

Получить имя таблицы, описываемой шаблоном.

Return Value

string

array getColumns()

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

Return Value

array

array getCommands()

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

Return Value

array

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