Класс SqlserverSchema
Функции управления схемой/отражения схемы для SQLServer.
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\SqlserverSchema
Краткое описание констант
-
stringDEFAULT_SCHEMA_NAME'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–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.7/class-Cake.Database.Schema.SqlserverSchema.html