Spec-Zone.ru › Laravel 5.4

MySqlGrammar

class MySqlGrammar extends Grammar (View source)

Свойства

protected string $tablePrefix Префикс таблицы грамматики. from Grammar
protected bool $transactions Если эта грамматика поддерживает изменения схемы, заключенные в транзакцию. from Grammar
protected array $modifiers Возможные модификаторы столбцов.
protected array $serials Возможные столбцы с последовательностями.

Методы

array wrapArray(array $values)

Оборачивает массив значений.

from Grammar
string wrapTable(Expression|string $table)

Оборачивает таблицу в ключевые идентификаторы.

from Grammar
string wrap(Expression|string $value, bool $prefixAlias = false)

Оборачивает значение в ключевые идентификаторы.

from Grammar
string wrapAliasedValue(string $value, bool $prefixAlias = false)

Оборачивает значение, имеющее псевдоним.

from Grammar
string wrapSegments(array $segments)

Оборачивает заданные сегменты значений.

from Grammar
string wrapValue(string $value)

Оборачивает строку в ключевые идентификаторы.

string columnize(array $columns)

Преобразует массив имён столбцов в строку, разделённую разделителем.

from Grammar
string parameterize(array $values)

Создаёт заполнитель для параметров запроса для массива.

from Grammar
string parameter(mixed $value)

Получает соответствующий заполнитель для параметра запроса для значения.

from Grammar
bool isExpression(mixed $value)

Определяет, является ли заданное значение выражением.

from Grammar
string getValue(Expression $expression)

Получает значение выражения.

from Grammar
string getDateFormat()

Получает формат для дат, хранящихся в базе данных.

from Grammar
string getTablePrefix()

Получает префикс таблицы грамматики.

from Grammar
$this setTablePrefix(string $prefix)

Устанавливает префикс таблицы грамматики.

from Grammar
array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилирует команду переименования столбца.

from Grammar
array compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилирует команду изменения столбца в серию SQL-заявлений.

from Grammar
string compileForeign(Blueprint $blueprint, Fluent $command)

Компилирует команду внешнего ключа.

from Grammar
array getColumns(Blueprint $blueprint)

Компилирует определения столбцов проекта.

from Grammar
string getType(Fluent $column)

Получает SQL для типа данных столбца.

from Grammar
string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

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

from Grammar
Fluent|null getCommandByName(Blueprint $blueprint, string $name)

Получает команду первичного ключа, если она существует в проекте.

from Grammar
array getCommandsByName(Blueprint $blueprint, string $name)

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

from Grammar
array prefixArray(string $prefix, array $values)

Добавляет префикс к массиву значений.

from Grammar
string getDefaultValue(mixed $value)

Форматирует значение, чтобы оно могло использоваться в фрагментах «default».

from Grammar
TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создаёт пустой Doctrine DBAL TableDiff из Blueprint.

from Grammar
bool supportsSchemaTransactions()

Проверяет, поддерживает ли эта грамматика изменения схемы, заключённые в транзакцию.

from Grammar
string compileTableExists()

Компилирует запрос для определения списка таблиц.

string compileColumnListing()

Компилирует запрос для определения списка столбцов.

string compileCreate(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилирует команду создания таблицы.

string compileCreateTable(Blueprint $blueprint, Fluent $command, Connection $connection)

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

string compileCreateEncoding(string $sql, Connection $connection, Blueprint $blueprint)

Добавить спецификации набора символов в команду.

string compileCreateEngine(string $sql, Connection $connection, Blueprint $blueprint)

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

string compileAdd(Blueprint $blueprint, Fluent $command)

Скомпилировать команду добавления столбца.

string compilePrimary(Blueprint $blueprint, Fluent $command)

Скомпилировать команду первичного ключа.

string compileUnique(Blueprint $blueprint, Fluent $command)

Скомпилировать команду уникального ключа.

string compileIndex(Blueprint $blueprint, Fluent $command)

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

string compileKey(Blueprint $blueprint, Fluent $command, string $type)

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

string compileDrop(Blueprint $blueprint, Fluent $command)

Скомпилировать команду удаления таблицы.

string compileDropIfExists(Blueprint $blueprint, Fluent $command)

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

string compileDropColumn(Blueprint $blueprint, Fluent $command)

Скомпилировать команду удаления столбца.

string compileDropPrimary(Blueprint $blueprint, Fluent $command)

Скомпилировать команду удаления первичного ключа.

string compileDropUnique(Blueprint $blueprint, Fluent $command)

Скомпилировать команду удаления уникального ключа.

string compileDropIndex(Blueprint $blueprint, Fluent $command)

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

string compileDropForeign(Blueprint $blueprint, Fluent $command)

Скомпилировать команду удаления внешнего ключа.

string compileRename(Blueprint $blueprint, Fluent $command)

Скомпилировать команду переименования таблицы.

string compileEnableForeignKeyConstraints()

Скомпилировать команду включения ограничений внешнего ключа.

string compileDisableForeignKeyConstraints()

Скомпилировать команду отключения ограничений внешнего ключа.

string typeChar(Fluent $column)

Создать определение столбца для типа char.

string typeString(Fluent $column)

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

string typeText(Fluent $column)

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

string typeMediumText(Fluent $column)

Создать определение столбца для типа medium text.

string typeLongText(Fluent $column)

Создать определение столбца для типа long text.

string typeBigInteger(Fluent $column)

Создать определение столбца для типа big integer.

string typeInteger(Fluent $column)

Создать определение столбца для типа integer.

string typeMediumInteger(Fluent $column)

Создать определение столбца для типа medium integer.

string typeTinyInteger(Fluent $column)

Создать определение столбца для типа tiny integer.

string typeSmallInteger(Fluent $column)

Создать определение столбца для типа small integer.

string typeFloat(Fluent $column)

Создать определение столбца для типа float.

string typeDouble(Fluent $column)

Создать определение столбца для типа double.

string typeDecimal(Fluent $column)

Создать определение столбца для типа decimal.

string typeBoolean(Fluent $column)

Создать определение столбца для типа boolean.

string typeEnum(Fluent $column)

Создать определение столбца для типа enum.

string typeJson(Fluent $column)

Создать определение столбца для типа json.

string typeJsonb(Fluent $column)

Создать определение столбца для типа jsonb.

string typeDate(Fluent $column)

Создать определение столбца для типа date.

string typeDateTime(Fluent $column)

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

string typeDateTimeTz(Fluent $column)

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

string typeTime(Fluent $column)

Создать определение столбца для типа time.

string typeTimeTz(Fluent $column)

Создать определение столбца для типа time.

string typeTimestamp(Fluent $column)

Создать определение столбца для типа timestamp.

string typeTimestampTz(Fluent $column)

Создать определение столбца для типа timestamp.

string typeBinary(Fluent $column)

Создать определение столбца для типа binary.

string typeUuid(Fluent $column)

Создать определение столбца для типа uuid.

string typeIpAddress(Fluent $column)

Создать определение столбца для типа IP-адрес.

string typeMacAddress(Fluent $column)

Создать определение столбца для типа MAC-адрес.

string|null modifyVirtualAs(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора виртуального столбца.

string|null modifyStoredAs(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора сохранённого столбца.

string|null modifyUnsigned(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора беззнакового столбца.

string|null modifyCharset(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора набора символов столбца.

string|null modifyCollate(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора сортировки столбца.

string|null modifyNullable(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора nullable столбца.

string|null modifyDefault(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора значения по умолчанию столбца.

string|null modifyIncrement(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора автоинкремента столбца.

string|null modifyFirst(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора "first" столбца.

string|null modifyAfter(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора "after" столбца.

string|null modifyComment(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора комментария столбца.

Details

array wrapArray(array $values)

Оборачивает массив значений.

Parameters

array $values

Return Value

array

string wrapTable(Expression|string $table)

Оборачивает таблицу в идентификаторы ключевых слов.

Parameters

Expression|string $table

Return Value

string

string wrap(Expression|string $value, bool $prefixAlias = false)

Оборачивает значение в идентификаторы ключевых слов.

Parameters

Expression|string $value
bool $prefixAlias

Return Value

string

protected string wrapAliasedValue(string $value, bool $prefixAlias = false)

Оборачивает значение с алиасом.

Parameters

string $value
bool $prefixAlias

Return Value

string

protected string wrapSegments(array $segments)

Оборачивает предоставленные сегменты значений.

Parameters

array $segments

Return Value

string

protected string wrapValue(string $value)

Оборачивает одну строку в идентификаторы ключевых слов.

Параметры

string $value

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

string

string columnize(array $columns)

Преобразует массив имён столбцов в строку, разделяемую разделителем.

Параметры

array $columns

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

string

string parameterize(array $values)

Создаёт плейсхолдеры для параметров запроса для массива.

Параметры

array $values

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

string

string parameter(mixed $value)

Получает соответствующий плейсхолдер параметра запроса для значения.

Параметры

mixed $value

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

string

bool isExpression(mixed $value)

Определяет, является ли данное значение сырым выражением.

Параметры

mixed $value

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

bool

string getValue(Expression $expression)

Получает значение сырого выражения.

Параметры

Expression $expression

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

string

string getDateFormat()

Получает формат для дат, хранящихся в базе данных.

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

string

string getTablePrefix()

Получает префикс таблицы грамматики.

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

string

$this setTablePrefix(string $prefix)

Устанавливает префикс таблицы грамматики.

Параметры

string $prefix

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

$this

array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилирует команду переименования столбца.

Параметры

Blueprint $blueprint
Fluent $command
Connection $connection

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

array

array compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилирует команду изменения столбца в серию SQL-команд.

Параметры

Blueprint $blueprint
Fluent $command
Connection $connection

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

array

Исключения

RuntimeException

string compileForeign(Blueprint $blueprint, Fluent $command)

Компилирует команду внешнего ключа.

Параметры

Blueprint $blueprint
Fluent $command

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

string

protected array getColumns(Blueprint $blueprint)

Компилирует определения столбцов проекта.

Параметры

Blueprint $blueprint

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

array

protected string getType(Fluent $column)

Получает SQL для типа данных столбца.

Параметры

Fluent $column

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

string

protected string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

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

Параметры

string $sql
Blueprint $blueprint
Fluent $column

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

string

protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)

Получает команду первичного ключа, если она существует в проекте.

Параметры

Blueprint $blueprint
string $name

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

Fluent|null

protected array getCommandsByName(Blueprint $blueprint, string $name)

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

Параметры

Blueprint $blueprint
string $name

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

array

array prefixArray(string $prefix, array $values)

Добавить префикс к массиву значений.

Параметры

string $prefix
array $values

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

array

protected string getDefaultValue(mixed $value)

Отформатировать значение для использования в "default" частях.

Параметры

mixed $value

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

string

TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создать пустой Doctrine DBAL TableDiff из Blueprint.

Параметры

Blueprint $blueprint
AbstractSchemaManager $schema

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

TableDiff

bool supportsSchemaTransactions()

Проверить, поддерживает ли этот Grammar изменения схемы, заключенные в транзакцию.

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

bool

string compileTableExists()

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

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

string

string compileColumnListing()

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

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

string

string compileCreate(Blueprint $blueprint, Fluent $command, Connection $connection)

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

Параметры

Blueprint $blueprint
Fluent $command
Connection $connection

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

string

protected string compileCreateTable(Blueprint $blueprint, Fluent $command, Connection $connection)

Создать основную часть запроса CREATE TABLE.

Параметры

Blueprint $blueprint
Fluent $command
Connection $connection

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

string

protected string compileCreateEncoding(string $sql, Connection $connection, Blueprint $blueprint)

Добавить спецификации кодировки к команде.

Параметры

string $sql
Connection $connection
Blueprint $blueprint

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

string

protected string compileCreateEngine(string $sql, Connection $connection, Blueprint $blueprint)

Добавить спецификации движка к команде.

Параметры

string $sql
Connection $connection
Blueprint $blueprint

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

string

string compileAdd(Blueprint $blueprint, Fluent $command)

Скомпилировать команду добавления столбца.

Параметры

Blueprint $blueprint
Fluent $command

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

string

string compilePrimary(Blueprint $blueprint, Fluent $command)

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

Параметры

Blueprint $blueprint
Fluent $command

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

string

string compileUnique(Blueprint $blueprint, Fluent $command)

Скомпилировать команду создания уникального ключа.

Параметры

Blueprint $blueprint
Fluent $command

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

string

string compileIndex(Blueprint $blueprint, Fluent $command)

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

Параметры

Blueprint $blueprint
Fluent $command

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

string

protected string compileKey(Blueprint $blueprint, Fluent $command, string $type)

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

Параметры

Blueprint $blueprint
Fluent $command
string $type

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

string
END_OF_DOCUMENT_MARKER

string compileDrop(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления таблицы.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropIfExists(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления таблицы (если она существует).

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropColumn(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления столбца.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropPrimary(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления первичного ключа.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropUnique(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления уникального ключа.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropIndex(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления индекса.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropForeign(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления внешнего ключа.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileRename(Blueprint $blueprint, Fluent $command)

Компилировать команду переименования таблицы.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileEnableForeignKeyConstraints()

Компилировать команду для включения ограничений внешних ключей.

Return Value

string

string compileDisableForeignKeyConstraints()

Компилировать команду для отключения ограничений внешних ключей.

Return Value

string

protected string typeChar(Fluent $column)

Создать определение столбца для типа char.

Parameters

Fluent $column

Return Value

string

protected string typeString(Fluent $column)

Создать определение столбца для типа string.

Parameters

Fluent $column

Return Value

string

protected string typeText(Fluent $column)

Создать определение столбца для типа text.

Parameters

Fluent $column

Return Value

string

protected string typeMediumText(Fluent $column)

Создать определение столбца для типа medium text.

Parameters

Fluent $column

Return Value

string

protected string typeLongText(Fluent $column)

Создать определение столбца для типа long text.

Parameters

Fluent $column

Return Value

string

protected string typeBigInteger(Fluent $column)

Создать определение столбца для типа big integer.

Parameters

Fluent $column

Return Value

string
END_OF_DOCUMENT_MARKER

protected string typeInteger(Fluent $column)

Создать определение столбца для целого типа.

Параметры

Fluent $column

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

string

protected string typeMediumInteger(Fluent $column)

Создать определение столбца для типа целого числа со средним размером.

Параметры

Fluent $column

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

string

protected string typeTinyInteger(Fluent $column)

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

Параметры

Fluent $column

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

string

protected string typeSmallInteger(Fluent $column)

Создать определение столбца для типа целого числа малого размера.

Параметры

Fluent $column

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

string

protected string typeFloat(Fluent $column)

Создать определение столбца для типа float.

Параметры

Fluent $column

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

string

protected string typeDouble(Fluent $column)

Создать определение столбца для типа double.

Параметры

Fluent $column

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

string

protected string typeDecimal(Fluent $column)

Создать определение столбца для типа decimal.

Параметры

Fluent $column

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

string

protected string typeBoolean(Fluent $column)

Создать определение столбца для логического типа.

Параметры

Fluent $column

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

string

protected string typeEnum(Fluent $column)

Создать определение столбца для типа перечисления.

Параметры

Fluent $column

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

string

protected string typeJson(Fluent $column)

Создать определение столбца для типа json.

Параметры

Fluent $column

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

string

protected string typeJsonb(Fluent $column)

Создать определение столбца для типа jsonb.

Параметры

Fluent $column

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

string

protected string typeDate(Fluent $column)

Создать определение столбца для типа date.

Параметры

Fluent $column

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

string

protected string typeDateTime(Fluent $column)

Создать определение столбца для типа datetime.

Параметры

Fluent $column

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

string

protected string typeDateTimeTz(Fluent $column)

Создать определение столбца для типа datetime.

Параметры

Fluent $column

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

string

protected string typeTime(Fluent $column)

Создать определение столбца для типа time.

Параметры

Fluent $column

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

string

protected string typeTimeTz(Fluent $column)

Создать определение столбца для типа time.

Параметры

Fluent $column

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

string

protected string typeTimestamp(Fluent $column)

Создать определение столбца для типа timestamp.

Параметры

Fluent $column

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

string

protected string typeTimestampTz(Fluent $column)

Создать определение столбца для типа timestamp.

Parameters

Fluent $column

Return Value

string

protected string typeBinary(Fluent $column)

Создать определение столбца для типа бинарных данных.

Parameters

Fluent $column

Return Value

string

protected string typeUuid(Fluent $column)

Создать определение столбца для типа uuid.

Parameters

Fluent $column

Return Value

string

protected string typeIpAddress(Fluent $column)

Создать определение столбца для типа IP-адреса.

Parameters

Fluent $column

Return Value

string

protected string typeMacAddress(Fluent $column)

Создать определение столбца для типа MAC-адреса.

Parameters

Fluent $column

Return Value

string

protected string|null modifyVirtualAs(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора виртуального столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyStoredAs(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора сохранённого столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyUnsigned(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора беззнакового столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyCharset(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора набора символов столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyCollate(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора сортировки столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyNullable(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора столбца как необязательного.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyDefault(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора значения по умолчанию столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyIncrement(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора автоинкремента столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

protected string|null modifyFirst(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора "первого" столбца.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null
END_OF_DOCUMENT_MARKER

protected string|null modifyAfter(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора столбца "after".

Параметры

Blueprint $blueprint
Fluent $column

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

string|null

protected string|null modifyComment(Blueprint $blueprint, Fluent $column)

Получить SQL для модификатора столбца "comment".

Параметры

Blueprint $blueprint
Fluent $column

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

string|null

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

Spec-Zone.ru

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