Класс SqlserverSchema
Функции управления и рефлексии схем для SQLServer.
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\SqlserverSchema
Краткое описание констант
-
string'dbo'
Унаследованные свойства
Краткое описание методов
- _convertColumn() protectedПреобразует определение столбца в абстрактные типы.
- _convertOnClause() protectedПреобразует строковые фрагменты ON в абстрактные.
- _defaultValue() protectedОбрабатывает значения по умолчанию.
- _foreignOnClause() protectedГенерирует фрагмент ON для внешнего ключа.
- _keySql() protectedВспомогательный метод для генерации SQL фрагментов ключей.
- addConstraintSql() publicГенерирует SQL запросы для добавления ограничений внешнего ключа к таблице.
- columnSql() publicГенерирует SQL фрагмент для отдельного столбца в таблице.
- constraintSql() publicГенерирует SQL фрагменты для определения ограничений таблицы.
- convertColumnDescription() publicПреобразует результаты описания столбцов в абстрактные поля схемы.
- Преобразует описание внешнего ключа в ограничения объекта Table.
- convertIndexDescription() publicПреобразует описание индекса в абстрактные индексы или ограничения схемы.
- createTableSql() publicГенерирует SQL для создания таблицы.
- describeColumnSql() publicГенерирует SQL для описания таблицы.
- describeForeignKeySql() publicГенерирует SQL для описания внешних ключей в таблице.
- describeIndexSql() publicГенерирует SQL для описания индексов в таблице.
- dropConstraintSql() publicГенерирует SQL запросы для удаления ограничений внешнего ключа из таблицы.
- indexSql() publicГенерирует SQL фрагмент для отдельного индекса в таблице.
- listTablesSql() publicГенерирует SQL для перечисления таблиц.
- truncateTableSql() publicГенерирует SQL для усечения таблицы.
Подробное описание методов
_convertColumn()source protected
_convertColumn( string $col , integer|null $length null , integer|null $precision null , integer|null $scale null )
Преобразует определение столбца в абстрактные типы.
Возвращаемый тип будет типом, который может обработать Cake\Database\Type.
Параметры
- строка
$col - Тип столбца
- целое число|null
$lengthопционально null - длина столбца
- целое число|null
$precisionопционально null - точность столбца
- целое число|null
$scaleопционально null - разрядность столбца
Возвращает
массивМассив информации о столбце.
Ссылка
https://technet.microsoft.com/en-us/library/ms187752.aspx_convertOnClause()source protected
_convertOnClause( string $clause )
Преобразует строковые фрагменты ON в абстрактные.
Параметры
- строка
$clause - Фрагмент ON для преобразования.
Возвращает
строка|nullПереопределяет
Cake\Database\Schema\BaseSchema::_convertOnClause() _defaultValue()source protected
_defaultValue( string|null $default )
Обрабатывает значения по умолчанию.
Sqlite включает кавычки и NULL в значениях по умолчанию. Нам нужно их удалить.
Параметры
- строка|null
$default - Значение по умолчанию.
Возвращает
строка|null_foreignOnClause()source protected
_foreignOnClause( string|null $on )
Генерирует фрагмент ON для внешнего ключа.
Параметры
- строка|null
$on - Фрагмент ON
Возвращает
строкаПереопределяет
Cake\Database\Schema\BaseSchema::_foreignOnClause() _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 )
Преобразовать описание внешнего ключа в ограничения объекта таблицы.
Параметры
-
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.
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) для выполнения.
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 - Столбцы, на которые ссылается ограничение внешнего ключа.
Возвращает
строкаconvertOptionsDescription()source public
convertOptionsDescription( Cake\Database\Schema\TableSchema $schema , array $row )
Преобразовать данные опций в параметры таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы.
- массив
$row - Строка данных.
describeOptionsSql()source public
describeOptionsSql( string $tableName , array $config )
Сгенерировать SQL для описания параметров таблицы.
Параметры
- строка
$tableName - Имя таблицы.
- массив
$config - Настройка подключения.
Возвращает
массивSQL-запросы для получения параметров таблицы.
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.SqlserverSchema.html