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