Класс MysqlSchema
Функции генерации/отражения схем для MySQL
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\MysqlSchema
Краткое описание свойств
- Экземпляр используемого драйвера.
$_driverprotected
Краткое описание методов
- _convertColumn() protectedПреобразование типа столбца MySQL в абстрактный тип.
- _keySql() protectedВспомогательный метод для генерации фрагментов SQL для ключей.
- addConstraintSql() publicГенерация SQL-запросов для добавления ограничений внешнего ключа к таблице.
- columnSql() publicГенерация фрагмента SQL для отдельного столбца в таблице.
- constraintSql() publicГенерация фрагментов SQL для определения ограничений таблицы.
- convertColumnDescription() publicПреобразование результатов описания поля в абстрактные поля схемы.
- Преобразование описания внешнего ключа в ограничения объекта Table.
- convertIndexDescription() publicПреобразование результатов описания индекса в абстрактные индексы или ограничения схемы.
- convertOptionsDescription() publicПреобразование данных опций в параметры таблицы.
- createTableSql() publicГенерация SQL для создания таблицы.
- describeColumnSql() publicГенерация SQL для описания столбца таблицы.
- describeForeignKeySql() publicГенерация SQL для описания внешних ключей в таблице.
- describeIndexSql() publicГенерация SQL для описания индексов в таблице.
- describeOptionsSql() publicГенерация SQL для описания параметров таблицы.
- dropConstraintSql() publicГенерация SQL-запросов для удаления ограничений внешнего ключа из таблицы.
- indexSql() publicГенерация фрагмента SQL для отдельного индекса в таблице.
- listTablesSql() publicГенерация SQL для перечисления таблиц.
- truncateTableSql() publicГенерация SQL для усечения таблицы.
Подробное описание методов
_convertColumn()source protected
_convertColumn( string $column )
Преобразование типа столбца MySQL в абстрактный тип.
Возвращаемый тип будет типом, который может обрабатывать Cake\Database\Type.
Параметры
- строка
$column - Тип столбца + длина
Возвращает
массивМассив информации о столбце.
Издаёт исключения
Cake\Database\ExceptionПри невозможности парсинга типа столбца.
_keySql()source protected
_keySql( string $prefix , array $data )
Вспомогательный метод для генерации фрагментов SQL для ключей.
Параметры
- строка
$prefix - Префикс ключа
- массив
$data - Данные ключа.
Возвращает
строкаaddConstraintSql()source public
addConstraintSql( Cake\Database\Schema\TableSchema $schema )
Генерация SQL-запросов для добавления ограничений внешнего ключа к таблице
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы, для которой добавляются ограничения внешнего ключа.
Возвращает
массивSQL фрагмент.
columnSql()source public
columnSql( Cake\Database\Schema\TableSchema $schema , string $name )
Генерация фрагмента SQL для отдельного столбца в таблице.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращает
строкаSQL фрагмент.
constraintSql()source public
constraintSql( Cake\Database\Schema\TableSchema $schema , string $name )
Генерация фрагментов SQL для определения ограничений таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращает
строкаSQL фрагмент.
convertColumnDescription()source public
convertColumnDescription( Cake\Database\Schema\TableSchema $schema , array $row )
Преобразование результатов описания поля в абстрактные поля схемы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Объект таблицы, которому нужно добавить поля.
- массив
$row - Данные строки из
describeColumnSql.
convertForeignKeyDescription()source public
convertForeignKeyDescription( Cake\Database\Schema\TableSchema $schema , array $row )
Преобразование описания внешнего ключа в ограничения объекта Table.
Параметры
-
Cake\Database\Schema\TableSchema$schema Объект таблицы, которому нужно добавить ограничение.
- массив
$row - Данные строки из
describeForeignKeySql.
convertIndexDescription()source public
convertIndexDescription( Cake\Database\Schema\TableSchema $schema , array $row )
Преобразование результатов описания индекса в абстрактные индексы или ограничения схемы.
Параметры
-
Cake\Database\Schema\TableSchema$schema Объект таблицы, которому нужно добавить индекс или ограничение.
- массив
$row - Данные строки из
describeIndexSql.
convertOptionsDescription()source public
convertOptionsDescription( Cake\Database\Schema\TableSchema $schema , array $row )
Преобразование данных опций в параметры таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы.
- массив
$row - Строка данных.
Переопределяет
Cake\Database\Schema\BaseSchema::convertOptionsDescription() createTableSql()source public
createTableSql( Cake\Database\Schema\TableSchema $schema , array $columns , array $constraints , array $indexes )
Генерация SQL для создания таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы.
- массив
$columns - Столбцы, которые нужно добавить в таблицу.
- массив
$constraints - Ограничения для таблицы.
- массив
$indexes - Индексы для таблицы.
Возвращает
массивSQL-запросы для создания таблицы.
describeColumnSql()source public
describeColumnSql( string $tableName , array $config )
Сгенерировать SQL для описания таблицы.
Параметры
- строка
$tableName - Имя таблицы, для которой необходимо получить информацию.
- массив
$config - Настройка подключения.
Возвращает
массивМассив (sql, params) для выполнения.
describeForeignKeySql()source public
describeForeignKeySql( string $tableName , array $config )
Сгенерировать SQL для описания внешних ключей в таблице.
Параметры
- строка
$tableName - Имя таблицы, для которой необходимо получить информацию.
- массив
$config - Настройка подключения.
Возвращает
массивМассив (sql, params) для выполнения.
describeIndexSql()source public
describeIndexSql( string $tableName , array $config )
Сгенерировать SQL для описания индексов в таблице.
Параметры
- строка
$tableName - Имя таблицы, для которой необходимо получить информацию.
- массив
$config - Настройка подключения.
Возвращает
массивМассив (sql, params) для выполнения.
describeOptionsSql()source public
describeOptionsSql( string $tableName , array $config )
Сгенерировать SQL для описания параметров таблицы
Параметры
- строка
$tableName - Имя таблицы.
- массив
$config - Настройка подключения.
Возвращает
массивSQL запросы для получения параметров таблицы.
Переопределяет
Cake\Database\Schema\BaseSchema::describeOptionsSql() dropConstraintSql()source public
dropConstraintSql( Cake\Database\Schema\TableSchema $schema )
Сгенерировать SQL-запросы, необходимые для удаления ограничений внешнего ключа из таблицы
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы, к которому относятся ограничения внешнего ключа.
Возвращает
массивSQL фрагмент.
indexSql()source public
indexSql( Cake\Database\Schema\TableSchema $schema , string $name )
Сгенерировать SQL-фрагмент для отдельного индекса в таблице.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Объект таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращает
строкаSQL фрагмент.
listTablesSql()source public
listTablesSql( array $config )
Сгенерировать SQL для вывода списка таблиц.
Параметры
- массив
$config Настройка подключения, используемая для получения таблиц.
Возвращает
массивМассив (sql, params) для выполнения.
truncateTableSql()source public
truncateTableSql( Cake\Database\Schema\TableSchema $schema )
Сгенерировать SQL для усечения таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы.
Возвращает
массивSQL-запросы для усечения таблицы.
Методы, унаследованные от Cake\Database\Schema\BaseSchema
__construct()source public
__construct( Cake\Database\Driver $driver )
Конструктор
Этот конструктор подключит драйвер, так что методы вроде columnSql() и другие будут выдавать ошибку, если драйвер не подключён.
Параметры
-
Cake\Database\Driver$driver - Используемый драйвер.
_convertConstraintColumns()source protected
_convertConstraintColumns( string|array $references )
Преобразовать ссылки ограничений внешних ключей в корректный строковый список
Параметры
- строка|массив
$references - Столбцы, на которые ссылается ограничение внешнего ключа
Возвращает
строка_convertOnClause()source protected
_convertOnClause( string $clause )
Преобразовать строковые фрагменты ON в абстрактные.
Параметры
- строка
$clause - Фрагмент ON для преобразования.
Возвращает
строка|null_foreignOnClause()source protected
_foreignOnClause( string|null $on )
Сгенерировать фрагмент ON для внешнего ключа.
Параметры
- строка|null
$on - Фрагмент ON
Возвращает
строкаdropTableSql()source public
dropTableSql( Cake\Database\Schema\TableSchema $schema )
Сгенерировать SQL для удаления таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр схемы
Возвращает
массивSQL-запросы для удаления таблицы.
Подробности свойств
© 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/3.6/class-Cake.Database.Schema.MysqlSchema.html