Класс 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–2017 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.4/class-Cake.Database.Schema.MysqlSchema.html