Класс MysqlSchemaDialect

Функции генерации/отражения схемы для MySQL

Краткое описание полей

$_driver protected

Cake\Database\Driver\Mysql

Используемый экземпляр драйвера.

Краткое описание методов

__construct() public

Конструктор
_convertColumn() protected

Преобразование типа столбца MySQL в абстрактный тип.
_convertConstraintColumns() protected

Преобразование ссылок на ограничения внешних ключей в валидный строковый список
_convertOnClause() protected

Преобразование строковых предложений ON в абстрактные.
_foreignOnClause() protected

Генерирует предложение ON для внешнего ключа.
_keySql() protected

Вспомогательный метод для генерации фрагментов SQL для ключей.
addConstraintSql() public

Генерирует SQL-запросы, необходимые для добавления ограничений внешних ключей к таблице
columnSql() public

Генерирует фрагмент SQL для одного столбца в таблице.
constraintSql() public

Генерирует фрагменты SQL для определения ограничений таблицы.
convertColumnDescription() public

Преобразует результаты описания полей в абстрактные поля схемы.
convertForeignKeyDescription() public

Преобразует описание внешнего ключа в ограничения объекта Table.
convertIndexDescription() public

Преобразует результаты описания индекса в абстрактные индексы или ограничения схемы.
convertOptionsDescription() public

Преобразует данные параметров в параметры таблицы.
createTableSql() public

Генерирует SQL для создания таблицы.
describeColumnSql() public

Генерирует SQL для описания таблицы.
describeForeignKeySql() public

Генерирует SQL для описания внешних ключей в таблице.
describeIndexSql() public

Генерирует SQL для описания индексов в таблице.
describeOptionsSql() public

Генерирует SQL для описания параметров таблицы
dropConstraintSql() public

Генерирует SQL-запросы, необходимые для удаления ограничений внешних ключей из таблицы
dropTableSql() public

Генерирует SQL для удаления таблицы.
indexSql() public

Генерирует фрагмент SQL для одного индекса в таблице.
listTablesSql() public

Генерирует SQL для получения списка таблиц.
truncateTableSql() public

Генерирует SQL для усечения таблицы.

Подробное описание методов

__construct() public

__construct(Cake\Database\DriverInterface $driver)

Конструктор

Этот конструктор подключит драйвер, поэтому методы, такие как columnSql() и другие, будут выдавать ошибку, если драйвер не подключен.

Параметры

Cake\Database\DriverInterface $driver: Драйвер для использования.

_convertColumn() protected

_convertColumn(string $column): array

Преобразует тип столбца MySQL в абстрактный тип.

Возвращаемый тип будет типом, который может обрабатывать Cake\Database\TypeFactory.

Параметры

string $column: Тип столбца + длина

Возвращает

array

Вызывает исключение

Cake\Database\Exception\DatabaseException
Когда тип столбца не может быть разобран.

_convertConstraintColumns() protected

_convertConstraintColumns(string|array $references): string

Преобразует ссылки на ограничения внешнего ключа в допустимый строковый список

Параметры

string|array $references: Ссылки на столбцы оператора ограничения внешнего ключа

Возвращает

string

_convertOnClause() protected

_convertOnClause(string $clause): string

Преобразует строковые предложения ON в абстрактные.

Параметры

string $clause: Предложение ON для преобразования.

Возвращает

string

_foreignOnClause() protected

_foreignOnClause(string $on): string

Генерирует предложение ON для внешнего ключа.

Параметры

string $on: Предложение ON

Возвращает

string

_keySql() protected

_keySql(string $prefix, array $data): string

Вспомогательный метод для генерации фрагментов SQL для ключей.

Параметры

string $prefix: Префикс ключа
array $data: Данные ключа.

Возвращает

string

addConstraintSql() public

addConstraintSql(Cake\Database\Schema\TableSchema $schema): array

Генерирует SQL-запросы, необходимые для добавления ограничений внешнего ключа к таблице

Параметры

Cake\Database\Schema\TableSchema $schema

Возвращает

array

columnSql() public

columnSql(Cake\Database\Schema\TableSchema $schema, string $name): string

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

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращает

string

constraintSql() public

constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): string

Генерирует фрагменты SQL для определения ограничений таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращает

string

convertColumnDescription() public

convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразует результаты описания поля в абстрактные поля схемы.

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertForeignKeyDescription() public

convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразует описание внешнего ключа в ограничения объекта Table.

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertIndexDescription() public

convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

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

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertOptionsDescription() public

convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

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

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

createTableSql() public

createTableSql(Cake\Database\Schema\TableSchema $schema, string[] $columns, string[] $constraints, string[] $indexes): string[]

Генерирует SQL-запрос для создания таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
string[] $columns
string[] $constraints
string[] $indexes

Возвращает

string[]

describeColumnSql() public

describeColumnSql(string $tableName, array $config): array

Генерирует SQL-запрос для описания таблицы.

Параметры

string $tableName
array $config

Возвращает

array

describeForeignKeySql() public

describeForeignKeySql(string $tableName, array $config): array

Генерирует SQL-запрос для описания внешних ключей в таблице.

Параметры

string $tableName
array $config

Возвращает

array

describeIndexSql() public

describeIndexSql(string $tableName, array $config): array

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

Параметры

string $tableName
array $config

Возвращает

array

describeOptionsSql() public

describeOptionsSql(string $tableName, array $config): array

Генерирует SQL-запрос для описания параметров таблицы

Параметры

string $tableName
array $config

Возвращает

array

dropConstraintSql() public

dropConstraintSql(Cake\Database\Schema\TableSchema $schema): array

Генерирует SQL-запросы, необходимые для удаления ограничений внешнего ключа из таблицы

Параметры

Cake\Database\Schema\TableSchema $schema

Возвращает

array

dropTableSql() public

dropTableSql(Cake\Database\Schema\TableSchema $schema): array

Генерирует SQL-запрос для удаления таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema: Экземпляр схемы

Возвращает

array

indexSql() public

indexSql(Cake\Database\Schema\TableSchema $schema, string $name): string

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

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращает

string

listTablesSql() public

listTablesSql(array $config): array

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

Параметры

array $config

Возвращает

array

truncateTableSql() public

truncateTableSql(Cake\Database\Schema\TableSchema $schema): array

Генерирует SQL запрос для усечения таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Возвращает

array

Подробное описание свойства

`$_driver` protected

Используемый экземпляр драйвера.

Тип

Cake\Database\Driver\Mysql

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Database.Schema.MysqlSchemaDialect.html