Класс SqlserverSchemaDialect
Функции управления и отражения схем для SQLServer.
Постоянные значения
-
stringDEFAULT_SCHEMA_NAME'dbo'
Краткое описание свойств
- $_driver protected
Cake\Database\DriverInterfaceИспользуемый экземпляр драйвера.
Краткое описание методов
-
__construct() public
Конструктор
-
_applyTypeSpecificColumnConversion() protected
Попытка использовать соответствующий тип базы данных для преобразования определения столбца SQL в абстрактное определение типа.
-
_convertColumn() protected
Преобразование определения столбца в абстрактные типы.
-
_convertConstraintColumns() protected
Преобразование ссылок на ограничения внешнего ключа в допустимый строковый список
-
_convertOnClause() protected
Преобразование строковых разделов ON в абстрактные.
-
_defaultValue() protected
Обработка значения по умолчанию.
-
_foreignOnClause() protected
Генерация раздела ON для внешнего ключа.
-
_getTypeSpecificColumnSql() protected
Попытка использовать соответствующий тип базы данных для генерации фрагмента SQL для одного столбца в таблице.
-
_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 для перечисления таблиц и представлений.
-
listTablesWithoutViewsSql() public
Генерация SQL для перечисления таблиц, исключая все представления.
-
truncateTableSql() public
Генерация SQL для обнуления таблицы.
Подробное описание методов
__construct() public
__construct(Cake\Database\DriverInterface $driver)
Конструктор
Этот конструктор подключит драйвер, чтобы такие методы, как columnSql(), и другие, возвращали ошибку, если драйвер не подключен.
Параметры
-
Cake\Database\DriverInterface$driver Используемый драйвер.
_applyTypeSpecificColumnConversion() protected
_applyTypeSpecificColumnConversion(string $columnType, array $definition): array|null
Пытается использовать соответствующий тип базы данных для преобразования определения SQL-столбца в определение абстрактного типа.
Параметры
-
string$columnType Тип столбца.
-
array$definition Определение столбца.
Возвращает
array|null_convertColumn() protected
_convertColumn(string $col, int|null $length = null, int|null $precision = null, int|null $scale = null): array<string, mixed>
Преобразовать определение столбца в абстрактные типы.
Возвращаемый тип будет типом, который может обработать Cake\Database\TypeFactory.
Параметры
-
string$col Тип столбца
-
int|null$length необязательный длина столбца
-
int|null$precision необязательный Точность столбца
-
int|null$scale необязательный Масштаб столбца
Возвращает
array<string, mixed>Ссылки
_convertConstraintColumns() protected
_convertConstraintColumns(array<string>|string $references): string
Преобразовать ссылки на ограничения внешнего ключа в допустимый строковый список
Параметры
-
array<string>|string$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_getTypeSpecificColumnSql() protected
_getTypeSpecificColumnSql(string $columnType, Cake\Database\Schema\TableSchemaInterface $schema, string $column): string|null
Пытается использовать соответствующий тип базы данных для генерации фрагмента SQL для одного столбца в таблице.
Параметры
-
string$columnType Тип столбца.
-
Cake\Database\Schema\TableSchemaInterface$schema Экземпляр схемы таблицы, в которой находится столбец.
-
string$column Имя столбца.
Возвращает
string|null_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, array<string> $columns, array<string> $constraints, array<string> $indexes): array<string>
Генерирует SQL для создания таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema -
array<string>$columns -
array<string>$constraints -
array<string>$indexes
Возвращает
array<string>describeColumnSql() public
describeColumnSql(string $tableName, array<string, mixed> $config): array
Генерирует SQL для описания таблицы.
Параметры
-
string$tableName -
array<string, mixed>$config
Возвращает
arraydescribeForeignKeySql() public
describeForeignKeySql(string $tableName, array<string, mixed> $config): array
Генерирует SQL для описания внешних ключей в таблице.
Параметры
-
string$tableName -
array<string, mixed>$config
Возвращает
arraydescribeIndexSql() public
describeIndexSql(string $tableName, array<string, mixed> $config): array
Сгенерировать SQL для описания индексов в таблице.
Параметры
-
string$tableName -
array<string, mixed>$config
Возвращает
arraydescribeOptionsSql() public
describeOptionsSql(string $tableName, array<string, mixed> $config): array
Сгенерировать SQL для описания параметров таблицы
Параметры
-
string$tableName Имя таблицы.
-
array<string, mixed>$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<string, mixed> $config): array
Сгенерировать SQL для вывода списка таблиц и представлений.
Параметры
-
array<string, mixed>$config Конфигурация подключения для получения таблиц.
Возвращает
arraylistTablesWithoutViewsSql() public
listTablesWithoutViewsSql(array<string, mixed> $config): array<mixed>
Сгенерировать SQL для вывода списка таблиц, исключая представления.
Параметры
-
array<string, mixed>$config Конфигурация подключения для получения таблиц.
Возвращает
array<mixed>truncateTableSql() 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.4/class-Cake.Database.Schema.SqlserverSchemaDialect.html