Spec-Zone.ru › Laravel 5.4

Чертеж

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

Трейты

Macroable

Свойства

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

Методы

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

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

 from Macroable
static bool hasMacro(string $name)

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

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

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

Создать новый шаблон схемы.
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 tinyIncrements(string $column)

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

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

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

Создать новый автоинкрементируемый большой целочисленный столбец (8 байт) в таблице.
Fluent char(string $column, int $length = null)

Создать новый столбец char в таблице.
Fluent string(string $column, int $length = null)

Создать новый строковый столбец в таблице.
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 unsignedInteger(string $column, bool $autoIncrement = false)

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

Создать новый столбец с двойной точностью в таблице.
Fluent decimal(string $column, int $total = 8, int $places = 2)

Создать новый столбец десятичного типа в таблице.
Fluent unsignedDecimal(string $column, int $total = 8, int $places = 2)

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

Добавить созданные и обновлённые метки времени в таблицу.
void nullableTimestamps()

Добавить созданные и обновлённые метки времени в таблицу (возможно NULL).
void timestampsTz()

Добавить созданные и обновлённые метки времени (с часовым поясом) в таблицу.
Fluent softDeletes(string $column = 'deleted_at')

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

Добавить метку времени удаления (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)

Добавить необходимые столбцы для полиморфной таблицы.
void nullableMorphs(string $name, string|null $indexName = null)

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

Создать имя индекса по умолчанию для таблицы.
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()

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

Подробности

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

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

Parameters

string $name
callable $macro

Return Value

void

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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)

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

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

void temporary()

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

Return Value

void

Fluent drop()

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

Return Value

Fluent

Fluent dropIfExists()

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

Return Value

Fluent
END_OF_DOCUMENT_MARKER

Fluent dropColumn(array|mixed $columns)

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

Parameters

array|mixed $columns

Return Value

Fluent

Fluent renameColumn(string $from, string $to)

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

Parameters

string $from
string $to

Return Value

Fluent

Fluent dropPrimary(string|array $index = null)

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

Parameters

string|array $index

Return Value

Fluent

Fluent dropUnique(string|array $index)

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

Parameters

string|array $index

Return Value

Fluent

Fluent dropIndex(string|array $index)

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

Parameters

string|array $index

Return Value

Fluent

Fluent dropForeign(string|array $index)

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

Parameters

string|array $index

Return Value

Fluent

void dropTimestamps()

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

Return Value

void

void dropTimestampsTz()

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

Return Value

void

void dropSoftDeletes()

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

Return Value

void

void dropSoftDeletesTz()

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

Return Value

void

void dropRememberToken()

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

Return Value

void

Fluent rename(string $to)

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

Parameters

string $to

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

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

Return Value

Fluent

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

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

Parameters

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

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

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

Parameters

string $column

Return Value

Fluent

Fluent smallIncrements(string $column)

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

Parameters

string $column

Return Value

Fluent

Fluent mediumIncrements(string $column)

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

Параметры

string $column

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

Fluent

Fluent bigIncrements(string $column)

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

Параметры

string $column

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

Fluent

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

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

Параметры

string $column
int $length

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

Fluent

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

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

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

Параметры

string $column
bool $autoIncrement
bool $unsigned

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

Fluent

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 unsignedInteger(string $column, bool $autoIncrement = false)

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

Параметры

string $column
bool $autoIncrement

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

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

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

Значение результата

void

void nullableTimestamps()

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

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

Значение результата

void

void timestampsTz()

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

Значение результата

void

Fluent softDeletes(string $column = 'deleted_at')

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

Parameters

string $column

Return Value

Fluent

Fluent softDeletesTz()

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

Return Value

Fluent

Fluent binary(string $column)

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

Parameters

string $column

Return Value

Fluent

Fluent uuid(string $column)

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

Parameters

string $column

Return Value

Fluent

Fluent ipAddress(string $column)

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

Parameters

string $column

Return Value

Fluent

Fluent macAddress(string $column)

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

Parameters

string $column

Return Value

Fluent

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

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

Parameters

string $name
string|null $indexName

Return Value

void

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

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

Parameters

string $name
string|null $indexName

Return Value

void

Fluent rememberToken()

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

Return Value

Fluent

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

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

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

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

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

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

array getColumns()

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

Return Value

array

array getCommands()

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

Return Value

array

array getAddedColumns()

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

Return Value

array

массив getChangedColumns()

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

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

массив

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

Spec-Zone.ru

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