Класс SqlserverSchemaDialect
Функционал управления/отражения схем для SQLServer.
Константы
-
stringDEFAULT_SCHEMA_NAME'dbo'
Краткое описание свойств
- $_driver protected
Cake\Database\DriverInterfaceЭкземпляр драйвера, используемый в данный момент.
Краткое описание методов
-
__construct() public
Конструктор
-
_convertColumn() protected
Преобразовать определение столбца в абстрактные типы.
-
_convertConstraintColumns() protected
Преобразовать ссылки на ограничения внешнего ключа в корректный строковый список.
-
_convertOnClause() protected
Преобразовать строковые ON-условия в абстрактные.
-
_defaultValue() protected
Обработка значения по умолчанию.
-
_foreignOnClause() protected
Сгенерировать ON-условие для внешнего ключа.
-
_keySql() protected
Вспомогательный метод для генерации SQL фрагментов для ключей.
-
addConstraintSql() public
Сгенерировать SQL запросы для добавления ограничений внешних ключей к таблице.
-
columnSql() public
Сгенерировать SQL фрагмент для отдельного столбца в таблице.
-
constraintSql() public
Сгенерировать SQL фрагменты для определения ограничений таблицы.
-
convertColumnDescription() public
Преобразовать результаты описания столбцов в абстрактные поля схемы.
-
convertForeignKeyDescription() public
Преобразовать описание внешнего ключа в ограничения объекта Table.
-
convertIndexDescription() public
Преобразовать результаты описания индексов в абстрактные индексы или ограничения схемы.
-
convertOptionsDescription() public
Преобразовать данные опций в опции таблицы.
-
createTableSql() public
Сгенерировать SQL для создания таблицы.
-
describeColumnSql() public
Сгенерировать SQL для описания таблицы.
-
describeForeignKeySql() public
Сгенерировать SQL для описания внешних ключей в таблице.
-
describeIndexSql() public
Сгенерировать SQL для описания индексов в таблице.
-
describeOptionsSql() public
Сгенерировать SQL для описания опций таблицы.
-
dropConstraintSql() public
Сгенерировать SQL запросы для удаления ограничений внешних ключей из таблицы.
-
dropTableSql() public
Сгенерировать SQL для удаления таблицы.
-
indexSql() public
Сгенерировать SQL фрагмент для отдельного индекса в таблице.
-
listTablesSql() public
Сгенерировать SQL для вывода списка таблиц.
-
truncateTableSql() public
Сгенерировать SQL для обнуления таблицы.
Краткое описание методов
__construct() public
__construct(Cake\Database\DriverInterface $driver)
Конструктор
Этот конструктор подключит драйвер, так что методы, такие как columnSql() и другие, будут вызывать ошибку, если драйвер не был подключен.
Параметры
-
Cake\Database\DriverInterface$driver Драйвер для использования.
_convertColumn() protected
_convertColumn(string $col, int|null $length = null, int|null $precision = null, int|null $scale = null): array
Преобразовать определение столбца в абстрактные типы.
Возвращаемый тип будет типом, который может обрабатывать Cake\Database\TypeFactory.
Параметры
-
string$col Тип столбца
-
int|null$length optional Длина столбца
-
int|null$precision optional Точность столбца
-
int|null$scale optional Масштаб столбца
Возвращает
arrayСсылки
_convertConstraintColumns() protected
_convertConstraintColumns(string|array $references): string
Преобразовать ссылки на ограничения внешнего ключа в валидный строковый список
Параметры
-
string|array$references Ссылки на столбцы оператора ограничения внешнего ключа
Возвращает
string_convertOnClause() protected
_convertOnClause(string $clause): string
Преобразовать строковые on-оператор в абстрактные.
Параметры
-
string$clause
Возвращает
string_defaultValue() protected
_defaultValue(string $type, string|null $default): string|int|null
Обработка значения по умолчанию.
Удаляет скобки () из значений по умолчанию, извлекает строки из оберток N'' и текста сортировки и преобразует строки NULL.
Параметры
-
string$type Тип схемы
-
string|null$default Значение по умолчанию.
Возвращает
string|int|null_foreignOnClause() protected
_foreignOnClause(string $on): string
Генерирует ON-оператор для внешнего ключа.
Параметры
-
string$on
Возвращает
string_keySql() protected
_keySql(string $prefix, array $data): string
Вспомогательный метод для генерации фрагментов SQL-кода для ключей.
Параметры
-
string$prefix Префикс ключа
-
array$data Данные ключа.
Возвращает
stringaddConstraintSql() public
addConstraintSql(Cake\Database\Schema\TableSchema $schema): array
Генерирует SQL-запросы, необходимые для добавления ограничений внешнего ключа к таблице
Параметры
-
Cake\Database\Schema\TableSchema$schema
Возвращает
arraycolumnSql() public
columnSql(Cake\Database\Schema\TableSchema $schema, string $name): string
Генерирует фрагмент SQL для отдельного столбца в таблице.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
string$name
Возвращает
stringconstraintSql() public
constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): string
Генерирует фрагменты SQL для определения ограничений таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
string$name
Возвращает
stringconvertColumnDescription() public
convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): void
Преобразует результаты описания полей в абстрактные поля схемы.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
array$row
Возвращает
voidconvertForeignKeyDescription() public
convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): void
Преобразует описание внешнего ключа в ограничения объекта Table.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
array$row
Возвращает
voidconvertIndexDescription() public
convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): void
Преобразует результаты описания индекса в абстрактные индексы или ограничения схемы.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
array$row
Возвращает
voidconvertOptionsDescription() public
convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): void
Преобразует данные параметров в параметры таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema Экземпляр таблицы.
-
array$row Строка данных.
Возвращает
voidcreateTableSql() public
createTableSql(Cake\Database\Schema\TableSchema $schema, string[] $columns, string[] $constraints, string[] $indexes): string[]
Генерирует SQL-код для создания таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
string[]$columns -
string[]$constraints -
string[]$indexes
Возвращает
string[]describeColumnSql() public
describeColumnSql(string $tableName, array $config): array
Генерирует SQL-код для описания таблицы.
Параметры
-
string$tableName -
array$config
Возвращает
arraydescribeForeignKeySql() public
describeForeignKeySql(string $tableName, array $config): array
Генерирует SQL-код для описания внешних ключей в таблице.
Параметры
-
string$tableName -
array$config
Возвращает
arraydescribeIndexSql() public
describeIndexSql(string $tableName, array $config): array
Генерирует SQL-код для описания индексов в таблице.
Параметры
-
string$tableName -
array$config
Возвращает
arraydescribeOptionsSql() public
describeOptionsSql(string $tableName, array $config): array
Генерирует SQL-код для описания параметров таблицы
Параметры
-
string$tableName Имя таблицы.
-
array$config Конфигурация соединения.
Возвращает
arraydropConstraintSql() public
dropConstraintSql(Cake\Database\Schema\TableSchema $schema): array
Генерирует SQL-запросы, необходимые для удаления ограничений внешнего ключа из таблицы
Параметры
-
Cake\Database\Schema\TableSchema$schema
Возвращает
arraydropTableSql() public
dropTableSql(Cake\Database\Schema\TableSchema $schema): array
Сгенерировать SQL для удаления таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema Экземпляр схемы
Возвращает
arrayindexSql() public
indexSql(Cake\Database\Schema\TableSchema $schema, string $name): string
Сгенерировать фрагмент SQL для отдельного индекса в таблице.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
string$name
Возвращает
stringlistTablesSql() public
listTablesSql(array $config): array
Сгенерировать SQL для вывода списка таблиц.
Параметры
-
array$config
Возвращает
arraytruncateTableSql() public
truncateTableSql(Cake\Database\Schema\TableSchema $schema): array
Сгенерировать SQL для усечения таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema
Возвращает
arrayПодробное описание свойств
$_driver protected
Используемый экземпляр драйвера.
Тип
Cake\Database\DriverInterface
© 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/4.2/class-Cake.Database.Schema.SqlserverSchemaDialect.html