Spec-Zone.ru › CakePHP 4.2

Класс SchemaDialect

Базовый класс для реализации схем.

Этот класс содержит методы, общие для различных диалектов SQL.

Абстрактный
Пространство имен: Cake\Database\Schema

Краткое описание свойств

  • $_driver protected
    Cake\Database\DriverInterface

    Экземпляр драйвера, используемый в данный момент.

Краткое описание методов

  • __construct() public

    Конструктор

  • _convertConstraintColumns() protected

    Преобразование ссылок на ограничения внешнего ключа в корректный строковый список

  • _convertOnClause() protected

    Преобразование строковых условий ON в абстрактные.

  • _foreignOnClause() protected

    Генерация условия ON для внешнего ключа.

  • addConstraintSql() abstract public

    Генерация SQL-запросов для добавления ограничений внешних ключей в таблицу

  • columnSql() abstract public

    Генерация SQL-фрагмента для отдельного столбца в таблице.

  • constraintSql() abstract public

    Генерация SQL-фрагментов для определения ограничений таблицы.

  • convertColumnDescription() abstract public

    Преобразование результатов описания поля в абстрактные поля схемы.

  • convertForeignKeyDescription() abstract public

    Преобразование описания внешнего ключа в ограничения объекта таблицы.

  • convertIndexDescription() abstract public

    Преобразование результатов описания индекса в абстрактные индексы или ограничения схемы.

  • convertOptionsDescription() public

    Преобразование данных параметров в параметры таблицы.

  • createTableSql() abstract public

    Генерация SQL для создания таблицы.

  • describeColumnSql() abstract public

    Генерация SQL для описания столбца таблицы.

  • describeForeignKeySql() abstract public

    Генерация SQL для описания внешних ключей в таблице.

  • describeIndexSql() abstract public

    Генерация SQL для описания индексов в таблице.

  • describeOptionsSql() public

    Генерация SQL для описания параметров таблицы

  • dropConstraintSql() abstract public

    Генерация SQL-запросов для удаления ограничений внешних ключей из таблицы

  • dropTableSql() public

    Генерация SQL для удаления таблицы.

  • indexSql() abstract public

    Генерация SQL-фрагмента для отдельного индекса в таблице.

  • listTablesSql() abstract public

    Генерация SQL для вывода списка таблиц.

  • truncateTableSql() abstract public

    Генерация SQL для обнуления таблицы.

Подробное описание методов

__construct() public 

__construct(Cake\Database\DriverInterface $driver)

Конструктор

Этот конструктор подключит драйвер, чтобы методы, такие как columnSql() и другие, возвращали ошибку, если драйвер не подключён.

Параметры

Cake\Database\DriverInterface $driver

Используемый драйвер.

_convertConstraintColumns() protected 

_convertConstraintColumns(string|array $references): string

Преобразовать ссылки на ограничения внешних ключей в корректный строковый список

Параметры

string|array $references

Ссылаемые столбцы утверждения ограничения внешнего ключа

Возвращает

string

_convertOnClause() protected 

_convertOnClause(string $clause): string

Преобразовать строковые on-аузы в абстрактные.

Параметры

string $clause

On-аузу для преобразования.

Возвращает

string

_foreignOnClause() protected 

_foreignOnClause(string $on): string

Сгенерировать on-аузу для внешнего ключа.

Параметры

string $on

on-ауза

Возвращает

string

addConstraintSql() abstract public 

addConstraintSql(Cake\Database\Schema\TableSchema $schema): array

Сгенерировать SQL-запросы для добавления ограничений внешних ключей в таблицу

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы, к которому относятся ограничения внешних ключей.

Возвращает

array

columnSql() abstract public 

columnSql(Cake\Database\Schema\TableSchema $schema, string $name): string

Сгенерировать SQL-фрагмент для отдельного столбца в таблице.

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы, в котором находится столбец.

string $name

Имя столбца.

Возвращает

string

constraintSql() abstract public 

constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): string

Сгенерировать SQL-фрагменты для определения ограничений таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы, в котором находится столбец.

string $name

Имя столбца.

Возвращает

string

convertColumnDescription() abstract public 

convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразовать результаты описания поля в абстрактные поля схемы.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, к которому нужно добавить поля.

array $row

Данные строки из describeColumnSql.

Возвращает

void

convertForeignKeyDescription() abstract public 

convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразовать описание внешнего ключа в ограничения в объекте таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, к которому нужно добавить ограничение.

array $row

Данные строки из describeForeignKeySql.

Возвращает

void

convertIndexDescription() abstract public 

convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразовать результаты описания индекса в абстрактные индексы или ограничения схемы.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, к которому нужно добавить индекс или ограничение.

array $row

Данные строки из describeIndexSql.

Возвращает

void

convertOptionsDescription() public 

convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

Преобразовать данные параметров в параметры таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы.

array $row

Строка данных.

Возвращает

void

createTableSql() abstract 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() abstract public 

describeColumnSql(string $tableName, array $config): array

Сгенерировать SQL для описания таблицы.

Параметры

string $tableName

Имя таблицы, для которой нужно получить информацию.

array $config

Настройки подключения.

Возвращает

array

describeForeignKeySql() abstract public 

describeForeignKeySql(string $tableName, array $config): array

Сгенерировать SQL для описания внешних ключей в таблице.

Параметры

string $tableName

Имя таблицы, для которой нужно получить информацию.

array $config

Настройки подключения.

Возвращает

array

describeIndexSql() abstract public 

describeIndexSql(string $tableName, array $config): array

Сгенерировать SQL для описания индексов в таблице.

Параметры

string $tableName

Имя таблицы, для которой нужно получить информацию.

array $config

Настройки подключения.

Возвращает

array

describeOptionsSql() public 

describeOptionsSql(string $tableName, array $config): array

Сгенерировать SQL для описания параметров таблицы

Параметры

string $tableName

Имя таблицы.

array $config

Настройки подключения.

Возвращает

array

dropConstraintSql() abstract public 

dropConstraintSql(Cake\Database\Schema\TableSchema $schema): array

Сгенерировать SQL-запросы для удаления ограничений внешних ключей из таблицы

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы, к которому относятся ограничения внешних ключей.

Возвращает

array

dropTableSql() public 

dropTableSql(Cake\Database\Schema\TableSchema $schema): array

Сгенерировать SQL для удаления таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр схемы

Возвращает

array

indexSql() абстрактный общедоступный 

indexSql(Cake\Database\Schema\TableSchema $schema, string $name): string

Генерировать фрагмент SQL для одного индекса в таблице.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, в которой находится столбец.

string $name

Имя столбца.

Возвращает

string

listTablesSql() абстрактный общедоступный 

listTablesSql(array $config): array

Генерировать SQL для отображения таблиц.

Параметры

array $config

Конфигурация подключения, используемая для получения таблиц.

Возвращает

array

truncateTableSql() абстрактный общедоступный 

truncateTableSql(Cake\Database\Schema\TableSchema $schema): array

Генерировать SQL для усечения таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы.

Возвращает

array

Подробности свойств

$_driver защищённый

Используемый экземпляр драйвера.

Тип

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.SchemaDialect.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API