Класс MysqlSchemaDialect

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

Пространство имён: Cake\Database\Schema

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

$_driver protected

Cake\Database\Driver\Mysql

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

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

__construct() public

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

Попытка использования соответствующего типа базы данных для преобразования определения столбца SQL в абстрактное определение типа.
_convertColumn() protected

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

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

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

Генерация условия ON для внешнего ключа.
_getTypeSpecificColumnSql() protected

Попытка использования соответствующего типа базы данных для генерации фрагмента SQL для отдельного столбца в таблице.
_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 для вывода списка таблиц и представлений.
listTablesWithoutViewsSql() public

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

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

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

__construct() public

__construct(Cake\Database\DriverInterface $driver)

Конструктор

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

Параметры

Cake\Database\DriverInterface $driver: Используемый драйвер.

_applyTypeSpecificColumnConversion() protected

_applyTypeSpecificColumnConversion(string $columnType, array $definition): array|null

Попытка использовать соответствующий тип базы данных для преобразования определения SQL-столбца в абстрактное определение типа.

Параметры

string $columnType: Тип столбца.
array $definition: Определение столбца.

Возвращает

array|null

_convertColumn() protected

_convertColumn(string $column): array<string, mixed>

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

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

Параметры

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

Возвращает

array<string, mixed>

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

Cake\Database\Exception\DatabaseException
При невозможности разобрать тип столбца.

_convertConstraintColumns() protected

_convertConstraintColumns(array<string>|string $references): string

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

Параметры

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

Возвращает

string

_convertOnClause() protected

_convertOnClause(string $clause): string

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

Параметры

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

Возвращает

string

_foreignOnClause() protected

_foreignOnClause(string $on): string

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

Параметры

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

Возвращает

string

_getTypeSpecificColumnSql() protected

_getTypeSpecificColumnSql(string $columnType, Cake\Database\Schema\TableSchemaInterface $schema, string $column): string|null

Попытка использовать соответствующий тип базы данных для генерации SQL-фрагмента для одного столбца в таблице.

Параметры

string $columnType: Тип столбца.
Cake\Database\Schema\TableSchemaInterface $schema: Экземпляр схемы таблицы, в которой находится столбец.
string $column: Имя столбца.

Возвращает

string|null

_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, array<string> $columns, array<string> $constraints, array<string> $indexes): array<string>

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

Параметры

Cake\Database\Schema\TableSchema $schema
array<string> $columns
array<string> $constraints
array<string> $indexes

Возвращает

array<string>

describeColumnSql() public

describeColumnSql(string $tableName, array<string, mixed> $config): array

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

Параметры

string $tableName
array<string, mixed> $config

Возвращает

array

describeForeignKeySql() public

describeForeignKeySql(string $tableName, array<string, mixed> $config): array

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

Параметры

string $tableName
array<string, mixed> $config

Возвращает

array

describeIndexSql() public

describeIndexSql(string $tableName, array<string, mixed> $config): array

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

Параметры

string $tableName
array<string, mixed> $config

Возвращает

array

describeOptionsSql() public

describeOptionsSql(string $tableName, array<string, mixed> $config): array

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

Параметры

string $tableName
array<string, mixed> $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<string, mixed> $config): array<mixed>

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

Параметры

array<string, mixed> $config: Конфигурация подключения, используемая для получения таблиц.

Возвращает

array<mixed>

listTablesWithoutViewsSql() public

listTablesWithoutViewsSql(array<string, mixed> $config): array<mixed>

Генерировать SQL для вывода списка таблиц, исключая все представления.

Параметры

array<string, mixed> $config: Конфигурация подключения, используемая для получения таблиц.

Возвращает

array<mixed>

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.3/class-Cake.Database.Schema.MysqlSchemaDialect.html