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) Смешать другой объект в класс. | 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 |
| 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 |
| array | getFluentCommands() Получить команды fluent для грамматики. | 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) Создать основное предложение create table. | |
| 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 | typeJson(Fluent $column) Создать определение столбца для типа json. | |
| string | typeJsonb(Fluent $column) Создать определение столбца для типа jsonb. | |
| string | typeDate(Fluent $column) Создать определение столбца для типа date. | |
| string | typeDateTime(Fluent $column) Создать определение столбца для типа date-time. | |
| string | typeDateTimeTz(Fluent $column) Создать определение столбца для типа date-time (с часовым поясом). | |
| 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. | |
| string | typeMultiLineString(Fluent $column) Создать определение столбца для пространственного типа MultiLineString. |
| string | typeMultiPolygon(Fluent $column) Создать определение столбца для типа пространственных многоугольников. | |
| 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 для модификатора "первый" столбца. | |
| string|null | modifyAfter(Blueprint $blueprint, Fluent $column) Получить SQL для модификатора "после" столбца. | |
| string|null | modifyComment(Blueprint $blueprint, Fluent $column) Получить SQL для модификатора комментария столбца. | |
| string|null | modifySrid(Blueprint $blueprint, Fluent $column) Получить SQL для модификатора SRID столбца. |
Детали
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin)
Добавить другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
array wrapArray(array $values)
Оборачивает массив значений.
string wrapTable(Expression|string $table)
Оборачивает таблицу в идентификаторы ключевых слов.
string wrap(Expression|string $value, bool $prefixAlias = false)
Оборачивает значение в идентификаторы ключевых слов.
protected string 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 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)
Создать основной фрагмент для команды создания таблицы.
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)
Сгенерировать команду уникального ключа.
строка compileSpatialIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду создания пространственного индекса.
protected строка compileKey(Blueprint $blueprint, Fluent $command, string $type)
Компилировать команду создания индекса.
строка compileDropIfExists(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления таблицы (если она существует).
строка compileDropColumn(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления столбца.
строка compileDropPrimary(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления первичного ключа.
строка compileDropUnique(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления уникального ключа.
строка compileDropIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления индекса.
строка compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления пространственного индекса.
строка compileDropForeign(Blueprint $blueprint, Fluent $command)
Компилировать команду удаления внешнего ключа.
строка compileRename(Blueprint $blueprint, Fluent $command)
Компилировать команду переименования таблицы.
строка compileRenameIndex(Blueprint $blueprint, Fluent $command)
Компилировать команду переименования индекса.
строка compileDropAllTables(array $tables)
Компилировать SQL для удаления всех таблиц.
строка 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)
Создать определение столбца для типа boolean.
protected string typeEnum(Fluent $column)
Создать определение столбца для типа перечисления.
protected string typeJson(Fluent $column)
Создать определение столбца для типа json.
protected string typeJsonb(Fluent $column)
Создать определение столбца для типа jsonb.
protected string typeDate(Fluent $column)
Создать определение столбца для типа date.
protected string typeDateTime(Fluent $column)
Создать определение столбца для типа date-time.
protected string typeDateTimeTz(Fluent $column)
Создать определение столбца для типа date-time (с часовым поясом).
protected string typeTime(Fluent $column)
Создать определение столбца для типа time.
protected string typeTimeTz(Fluent $column)
Создать определение столбца для типа time (с часовым поясом).
protected string typeTimestamp(Fluent $column)
Создать определение столбца для типа timestamp.
protected string typeTimestampTz(Fluent $column)
Создать определение столбца для типа timestamp (с часовым поясом).
protected string typeYear(Fluent $column)
Создать определение столбца для типа year.
protected string typeBinary(Fluent $column)
Создать определение столбца для типа binary.
protected string typeUuid(Fluent $column)
Создать определение столбца для типа uuid.
protected string typeIpAddress(Fluent $column)
Создать определение столбца для типа IP-адрес.
protected string typeMacAddress(Fluent $column)
Создать определение столбца для типа MAC-адрес.
string typeGeometry(Fluent $column)
Создать определение столбца для пространственного типа Geometry.
string typePoint(Fluent $column)
Создать определение столбца для пространственного типа Point.
string typeLineString(Fluent $column)
Создать определение столбца для пространственного типа LineString.
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 для модификатора столбца "after".
protected string|null modifyComment(Blueprint $blueprint, Fluent $column)
Получить SQL для модификатора столбца "comment".
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/5.6/Illuminate/Database/Schema/Grammars/MySqlGrammar.html