Класс MysqlSchema
Функции генерации/отражения схемы для MySQL
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\MysqlSchema
Наследуемые свойства
Краткое описание методов
- _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\Table $table )
Сгенерировать SQL-запросы, необходимые для добавления ограничений внешних ключей к таблице
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, к которому относятся ограничения внешних ключей.
Возвращаемое значение
массивФрагмент SQL.
columnSql()source public
columnSql( Cake\Database\Schema\Table $table , string $name )
Сгенерировать фрагмент SQL для отдельного столбца в таблице.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращаемое значение
строкаФрагмент SQL.
constraintSql()source public
constraintSql( Cake\Database\Schema\Table $table , string $name )
Сгенерировать фрагменты SQL для определения ограничений таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращаемое значение
строкаФрагмент SQL.
convertColumnDescription()source public
convertColumnDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать результаты описания поля в абстрактные поля схемы.
Параметры
-
Cake\Database\Schema\Table$table - Объект таблицы, к которому нужно добавить поля.
- массив
$row - Данные строки из
describeColumnSql.
convertForeignKeyDescription()source public
convertForeignKeyDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать описание внешнего ключа в ограничения объекта Table.
Параметры
-
Cake\Database\Schema\Table$table Объект таблицы, к которому необходимо добавить ограничение.
- массив
$row - Данные строки из
describeForeignKeySql.
convertIndexDescription()source public
convertIndexDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать результаты описания индекса в абстрактные индексы или ограничения схемы.
Параметры
-
Cake\Database\Schema\Table$table Объект таблицы, к которому необходимо добавить индекс или ограничение.
- массив
$row - Данные строки из
describeIndexSql.
convertOptionsDescription()source public
convertOptionsDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать данные параметров в параметры таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
- массив
$row - Строка данных.
Переопределяет
Cake\Database\Schema\BaseSchema::convertOptionsDescription() createTableSql()source public
createTableSql( Cake\Database\Schema\Table $table , array $columns , array $constraints , array $indexes )
Сгенерировать SQL для создания таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
- массив
$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\Table $table )
Сгенерировать SQL запросы для удаления ограничений внешнего ключа из таблицы
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, у которой нужно удалить ограничения внешних ключей.
Возвращаемое значение
массивSQL фрагмент.
indexSql()source public
indexSql( Cake\Database\Schema\Table $table , string $name )
Сгенерировать SQL фрагмент для отдельного индекса в таблице.
Параметры
-
Cake\Database\Schema\Table$table - Объект таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращаемое значение
строкаSQL фрагмент.
listTablesSql()source public
listTablesSql( array $config )
Сгенерировать SQL для перечисления таблиц.
Параметры
- массив
$config Настройки подключения для получения таблиц.
Возвращаемое значение
массивМассив (sql, params) для выполнения.
truncateTableSql()source public
truncateTableSql( Cake\Database\Schema\Table $table )
Сгенерировать SQL для усечения таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
Возвращаемое значение
массив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\Table $table )
Сгенерировать SQL для удаления таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы
Возвращаемое значение
массивSQL запросы для удаления таблицы.
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Database.Schema.MysqlSchema.html