Класс PostgresSchemaDialect

Функции управления и отражения схем для Postgres.

Пространство имён: Cake\Database\Schema

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

$_driver protected

Cake\Database\DriverInterface

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

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

__construct() public

Конструктор
_convertColumn() protected

Преобразование определения столбца к абстрактным типам.
_convertConstraint() 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 $column): array

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

Возвращаемый тип будет типом, который может обработать Cake\Database\TypeFactory.

Параметры

string $column: Тип столбца + длина

Возвращает

array

Вызывает

Cake\Database\Exception\DatabaseException
при невозможности разбора столбца.

_convertConstraint() protected

_convertConstraint(Cake\Database\Schema\TableSchema $schema, string $name, string $type, array $row): void

Добавить/обновить ограничение в объект схемы.

Параметры

Cake\Database\Schema\TableSchema $schema: Таблица для обновления.
string $name: Имя индекса.
string $type: Тип индекса.
array $row: Запись метаданных для обновления.

Возвращает

void

_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|int|null $default): string|int|null

Обработка значения по умолчанию.

Postgres включает в значения по умолчанию данные последовательности и информацию о приведении типов. Нам нужно это удалить.

Параметры

string|int|null $default: Значение по умолчанию.

Возвращает

string|int|null

_foreignOnClause() protected

_foreignOnClause(string $on): string

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

Параметры

string $on: ON-условие

Возвращает

string

_keySql() protected

_keySql(string $prefix, array $data): string

Вспомогательный метод для генерации фрагментов SQL для ключей.

Параметры

string $prefix: Префикс ключа
array $data: Данные ключа.

Возвращает

string

addConstraintSql() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Возвращает

array

columnSql() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращает

string

constraintSql() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращает

string

convertColumnDescription() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertForeignKeyDescription() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertIndexDescription() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
array $row

Возвращает

void

convertOptionsDescription() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema: Экземпляр таблицы.
array $row: Строка данных.

Возвращает

void

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

Возвращает

array

describeForeignKeySql() public

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

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

Параметры

string $tableName
array $config

Возвращает

array

describeIndexSql() 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() 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() public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema
string $name

Возвращаемое значение

string

listTablesSql() public

listTablesSql(array $config): array

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

Параметры

array $config

Возвращаемое значение

array

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.2/class-Cake.Database.Schema.PostgresSchemaDialect.html