MySqlGrammar
class MySqlGrammar extends Grammar (View source)
Особенности
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected string | $tablePrefix | Префикс таблицы грамматики. | from Grammar |
| protected bool | $transactions | Поддерживает ли эта грамматика изменения схемы, заключённые в транзакцию. | from Grammar |
| protected array | $fluentCommands | Команды, которые должны быть выполнены вне команды create или alter. | from Grammar |
| protected array | $modifiers | Возможные модификаторы столбцов. | |
| protected array | $serials | Возможные последовательности столбцов. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | 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 |
| 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 |
| string | quoteString(string|array $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 |
| void | typeComputed(Fluent $column)
Создать определение столбца для типа генерируемого, вычисляемого столбца. | |
| 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)
Добавить префикс к массиву значений. | из Grammar |
| string | getDefaultValue(mixed $value)
Форматировать значение так, чтобы его можно было использовать в предложениях "default". | из Grammar |
| TableDiff | getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)
Создать пустой Doctrine DBAL TableDiff из Blueprint. | из Grammar |
| array | getFluentCommands()
Получить команды fluent для грамматики. | из Grammar |
| bool | supportsSchemaTransactions()
Проверить, поддерживает ли эта грамматика изменения схемы, заключенные в транзакцию. | из 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 | compileSpatialIndex(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 | compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)
Скомпилировать команду удаления пространственного индекса. | |
| string | compileDropForeign(Blueprint $blueprint, Fluent $command)
Скомпилировать команду удаления внешнего ключа. | |
| string | compileRename(Blueprint $blueprint, Fluent $command)
Скомпилировать команду переименования таблицы. | |
| string | compileRenameIndex(Blueprint $blueprint, Fluent $command)
Скомпилировать команду переименования индекса. | |
| string | compileDropAllTables(array $tables)
Скомпилировать SQL-код, необходимый для удаления всех таблиц. | |
| string | compileDropAllViews(array $views)
Скомпилировать SQL-код, необходимый для удаления всех представлений. | |
| string | compileGetAllTables()
Скомпилировать SQL-код, необходимый для получения всех имен таблиц. | |
| string | compileGetAllViews()
Скомпилировать SQL-код, необходимый для получения всех имен представлений. |
| string | compileEnableForeignKeyConstraints()
Компилировать команду для включения ограничений внешнего ключа. | |
| string | compileDisableForeignKeyConstraints()
Компилировать команду для отключения ограничений внешнего ключа. | |
| string | typeChar(Fluent $column)
Создать определение столбца для типа char. | |
| string | typeString(Fluent $column)
Создать определение столбца для типа string. | |
| string | typeText(Fluent $column)
Создать определение столбца для типа text. | |
| 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)
Создать определение столбца для типа перечисления. | |
| string | typeSet(Fluent $column)
Создать определение столбца для типа перечисления set. | |
| string | typeJson(Fluent $column)
Создать определение столбца для типа json. | |
| string | typeJsonb(Fluent $column)
Создать определение столбца для типа jsonb. | |
| string | typeDate(Fluent $column)
Создать определение столбца для типа date. | |
| string | typeDateTime(Fluent $column)
Создать определение столбца для типа datetime. | |
| string | typeDateTimeTz(Fluent $column)
Создать определение столбца для типа datetime с часовым поясом. | |
| string | typeTime(Fluent $column)
Создать определение столбца для типа time. | |
| string | typeTimeTz(Fluent $column)
Создать определение столбца для типа time с часовым поясом. | |
| string | typeTimestamp(Fluent $column)
Создать определение столбца для типа timestamp. | |
| string | typeTimestampTz(Fluent $column)
Создать определение столбца для типа timestamp с часовым поясом. | |
| string | typeYear(Fluent $column)
Создать определение столбца для типа year. | |
| string | typeBinary(Fluent $column)
Создать определение столбца для типа binary. | |
| string | typeUuid(Fluent $column)
Создать определение столбца для типа uuid. | |
| string | typeIpAddress(Fluent $column)
Создать определение столбца для типа IP-адрес. | |
| string | typeMacAddress(Fluent $column)
Создать определение столбца для типа MAC-адрес. | |
| string | typeGeometry(Fluent $column)
Создать определение столбца для пространственного типа Geometry. | |
| string | typePoint(Fluent $column)
Создать определение столбца для пространственного типа Point. | |
| string | typeLineString(Fluent $column)
Создать определение столбца для пространственного типа LineString. | |
| string | typePolygon(Fluent $column)
Создать определение столбца для пространственного типа Polygon. | |
| string | typeGeometryCollection(Fluent $column)
Создать определение столбца для пространственного типа GeometryCollection. | |
| string | typeMultiPoint(Fluent $column)
Создать определение столбца для пространственного типа MultiPoint. |
| строка | typeMultiLineString(Fluent $column)
Создать определение столбца для типа пространственных MultiLineString. | |
| строка | typeMultiPolygon(Fluent $column)
Создать определение столбца для типа пространственных MultiPolygon. | |
| строка|null | modifyVirtualAs(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора виртуального столбца. | |
| строка|null | modifyStoredAs(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора хранимого столбца. | |
| строка|null | modifyUnsigned(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора беззнакового столбца. | |
| строка|null | modifyCharset(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора набора символов столбца. | |
| строка|null | modifyCollate(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора сортировки столбца. | |
| строка|null | modifyNullable(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора nullable столбца. | |
| строка|null | modifyDefault(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора значения по умолчанию столбца. | |
| строка|null | modifyIncrement(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора автоинкремента столбца. | |
| строка|null | modifyFirst(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора "первого" столбца. | |
| строка|null | modifyAfter(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора "после" столбца. | |
| строка|null | modifyComment(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора "комментария" столбца. | |
| строка|null | modifySrid(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора SRID столбца. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверка, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса.
mixed __call(string $method, array $parameters)
Динамическая обработка вызовов класса.
массив wrapArray(array $values)
Оборачивание массива значений.
строка wrapTable(Expression|string $table)
Оборачивание таблицы в идентификаторы ключевых слов.
строка wrap(Expression|string $value, bool $prefixAlias = false)
Оборачивание значения в идентификаторы ключевых слов.
protected строка wrapAliasedValue(string $value, bool $prefixAlias = false)
Оборачивание значения с алиасом.
protected string wrapSegments(array $segments)
Оборачивает заданные сегменты значений.
protected string wrapValue(string $value)
Оборачивает строку в идентификаторы ключевых слов.
string columnize(array $columns)
Преобразует массив имён столбцов в строку, разделенную разделителями.
string parameterize(array $values)
Создаёт плейсхолдеры параметров запроса для массива.
string parameter(mixed $value)
Возвращает соответствующий плейсхолдер параметра запроса для значения.
string quoteString(string|array $value)
Приводит заданную строковую литерал к кавычкам.
bool isExpression(mixed $value)
Определяет, является ли заданное значение сырым выражением.
string getValue(Expression $expression)
Возвращает значение сырого выражения.
string getDateFormat()
Возвращает формат дат, хранящихся в базе данных.
string getTablePrefix()
Возвращает префикс таблицы грамматики.
$this setTablePrefix(string $prefix)
Устанавливает префикс таблицы грамматики.
array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)
Компилирует команду переименования столбца.
array compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)
Компилирует команду изменения столбца в серию SQL-заявлений.
protected array getColumns(Blueprint $blueprint)
Компилирует определения столбцов проекта.
protected string getType(Fluent $column)
Возвращает SQL для типа данных столбца.
protected void typeComputed(Fluent $column)
Создаёт определение столбца для типа вычисляемого столбца.
protected string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)
Добавляет модификаторы столбца к определению.
protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)
Получить команду первичного ключа, если она существует в проекте.
protected array getCommandsByName(Blueprint $blueprint, string $name)
Получить все команды с заданным именем.
array prefixArray(string $prefix, array $values)
Добавить префикс к массиву значений.
protected string getDefaultValue(mixed $value)
Отформатировать значение для использования в операторах «по умолчанию».
TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)
Создать пустой Doctrine DBAL TableDiff из Blueprint.
array getFluentCommands()
Получить команды Fluent для грамматики.
bool supportsSchemaTransactions()
Проверить, поддерживает ли эта грамматика изменения схемы, заключённые в транзакцию.
string compileTableExists()
Скомпилировать запрос для определения списка таблиц.
string compileColumnListing()
Скомпилировать запрос для определения списка столбцов.
string compileCreate(Blueprint $blueprint, Fluent $command, Connection $connection)
Скомпилировать команду создания таблицы.
protected string compileCreateTable(Blueprint $blueprint, Fluent $command, Connection $connection)
Создать основную часть запроса CREATE TABLE.
protected string compileCreateEncoding(string $sql, Connection $connection, Blueprint $blueprint)
Добавить спецификации кодировки к команде.
protected string compileCreateEngine(string $sql, Connection $connection, Blueprint $blueprint)
Добавить спецификации движка к команде.
string compilePrimary(Blueprint $blueprint, Fluent $command)
Скомпилировать команду первичного ключа.
string compileUnique(Blueprint $blueprint, Fluent $command)
Скомпилировать команду уникального ключа.
string compileIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду создания простого индекса.
string compileSpatialIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду создания пространственного индекса.
protected string compileKey(Blueprint $blueprint, Fluent $command, string $type)
Компилировать команду создания индекса.
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 compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления пространственного индекса.
string compileDropForeign(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления внешнего ключа.
string compileRename(Blueprint $blueprint, Fluent $command)
Компилировать команду переименования таблицы.
string compileRenameIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду переименования индекса.
string compileDropAllTables(array $tables)
Скомпилировать SQL для удаления всех таблиц.
string compileDropAllViews(array $views)
Скомпилировать SQL для удаления всех представлений.
string compileGetAllTables()
Скомпилировать SQL для получения всех имён таблиц.
string compileGetAllViews()
Скомпилировать SQL для получения всех имён представлений.
string compileEnableForeignKeyConstraints()
Скомпилировать команду для включения ограничений внешних ключей.
string compileDisableForeignKeyConstraints()
Скомпилировать команду для отключения ограничений внешних ключей.
protected string typeChar(Fluent $column)
Создать определение столбца для типа char.
protected string typeString(Fluent $column)
Создать определение столбца для типа string.
protected string typeText(Fluent $column)
Создать определение столбца для типа text.
protected string typeMediumText(Fluent $column)
Создать определение столбца для типа medium text.
protected string typeLongText(Fluent $column)
Создать определение столбца для типа long text.
protected string typeBigInteger(Fluent $column)
Создать определение столбца для типа big integer.
protected string typeInteger(Fluent $column)
Создать определение столбца для типа integer.
protected string typeMediumInteger(Fluent $column)
Создать определение столбца для типа medium integer.
protected string typeTinyInteger(Fluent $column)
Создать определение столбца для типа tiny integer.
protected string typeSmallInteger(Fluent $column)
Создать определение столбца для типа small integer.
protected string typeFloat(Fluent $column)
Создать определение столбца для типа float.
protected string typeDouble(Fluent $column)
Создать определение столбца для типа double.
protected string typeDecimal(Fluent $column)
Создать определение столбца для типа decimal.
protected string typeBoolean(Fluent $column)
Создать определение столбца для булевого типа.
protected string typeEnum(Fluent $column)
Создать определение столбца для типа перечисления.
protected string typeSet(Fluent $column)
Создать определение столбца для типа перечисления множества.
protected string typeJson(Fluent $column)
Создать определение столбца для типа json.
protected string typeJsonb(Fluent $column)
Создать определение столбца для типа jsonb.
protected string typeDate(Fluent $column)
Создать определение столбца для типа даты.
protected string typeDateTime(Fluent $column)
Создать определение столбца для типа даты и времени.
protected string typeDateTimeTz(Fluent $column)
Создать определение столбца для типа даты и времени (с часовым поясом).
protected string typeTime(Fluent $column)
Создать определение столбца для типа времени.
protected string typeTimeTz(Fluent $column)
Создать определение столбца для типа времени (с часовым поясом).
protected string typeTimestamp(Fluent $column)
Создать определение столбца для типа метки времени.
protected string typeTimestampTz(Fluent $column)
Создать определение столбца для типа метки времени (с часовым поясом).
protected string typeYear(Fluent $column)
Создать определение столбца для типа года.
protected string typeBinary(Fluent $column)
Создать определение столбца для двоичного типа.
protected string typeUuid(Fluent $column)
Создать определение столбца для типа uuid.
protected string typeIpAddress(Fluent $column)
Создать определение столбца для типа IP-адреса.
protected string typeMacAddress(Fluent $column)
Создать определение столбца для типа MAC-адреса.
string typeGeometry(Fluent $column)
Создать определение столбца для типа пространственных геометрий.
string typePoint(Fluent $column)
Создать определение столбца для типа пространственных точек.
string typeLineString(Fluent $column)
Создать определение столбца для типа пространственных линий.
string typePolygon(Fluent $column)
Создать определение столбца для типа пространственных многоугольников.
string typeGeometryCollection(Fluent $column)
Создать определение столбца для типа пространственных коллекций геометрий.
string typeMultiPoint(Fluent $column)
Создать определение столбца для типа пространственных множеств точек.
string typeMultiLineString(Fluent $column)
Создать определение столбца для типа пространственных множеств линий.
string typeMultiPolygon(Fluent $column)
Создать определение столбца для типа пространственных множеств многоугольников.
protected string|null modifyVirtualAs(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора виртуального столбца.
protected string|null modifyStoredAs(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора сохранённого столбца.
protected string|null modifyUnsigned(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора беззнакового столбца.
protected string|null modifyCharset(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора набора символов столбца.
protected string|null modifyCollate(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора сортировки столбца.
protected string|null modifyNullable(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора допускающего null столбца.
protected string|null modifyDefault(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора значения по умолчанию столбца.
protected string|null modifyIncrement(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца с автоинкрементом.
protected string|null modifyFirst(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца "первый".
protected string|null modifyAfter(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца "после".
protected string|null modifyComment(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца "комментарий".
protected string|null modifySrid(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца SRID.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Schema/Grammars/MySqlGrammar.html