Класс PostgresSchema
Функции управления/отражения схем для Postgres.
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\PostgresSchema
Унаследованные свойства
Краткое описание методов
- _convertColumn() protectedПреобразовать определение столбца в абстрактные типы.
- _convertConstraint() protectedДобавить/обновить ограничение в объект схемы.
- _convertOnClause() protectedПреобразовать строковые условия on в абстрактные.
- _defaultValue() protectedОбработать значение по умолчанию.
- _keySql() protectedВспомогательный метод для генерации фрагментов SQL для ключей.
- addConstraintSql() publicСгенерировать запросы SQL, необходимые для добавления ограничений внешнего ключа к таблице
- columnSql() publicСгенерировать фрагмент SQL для отдельного столбца в таблице.
- constraintSql() publicСгенерировать фрагменты SQL для определения ограничений таблицы.
- convertColumnDescription() publicПреобразовать результаты описания поля в абстрактные поля схемы.
- Преобразовать описание внешнего ключа в ограничения в объекте таблицы.
- convertIndexDescription() publicПреобразовать результаты описания индекса в абстрактные индексы или ограничения схемы.
- createTableSql() publicСгенерировать SQL для создания таблицы.
- describeColumnSql() publicСгенерировать SQL для описания таблицы.
- describeForeignKeySql() publicСгенерировать SQL для описания внешних ключей в таблице.
- describeIndexSql() publicСгенерировать SQL для описания индексов в таблице.
- dropConstraintSql() publicСгенерировать запросы SQL, необходимые для удаления ограничений внешнего ключа из таблицы
- dropTableSql() publicСгенерировать SQL для удаления таблицы.
- indexSql() publicСгенерировать фрагмент SQL для отдельного индекса в таблице.
- listTablesSql() publicСгенерировать SQL для отображения списка таблиц.
- truncateTableSql() publicСгенерировать SQL для обнуления таблицы.
Подробное описание методов
_convertColumn()source protected
_convertColumn( string $column )
Преобразовать определение столбца в абстрактные типы.
Возвращаемый тип будет типом, который может обработать Cake\Database\Type.
Параметры
- строка
$column - Тип столбца + длина
Возвращает
массивМассив с информацией о столбце.
Исключения
Cake\Database\Exceptionесли столбец не может быть проанализирован.
_convertConstraint()source protected
_convertConstraint( Cake\Database\Schema\TableSchema $schema , string $name , string $type , array $row )
Добавить/обновить ограничение в объект схемы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Таблица для обновления.
- строка
$name - Имя индекса.
- строка
$type - Тип индекса.
- массив
$row - Запись метаданных для обновления.
_convertOnClause()source protected
_convertOnClause( string $clause )
Преобразовать строковые условия on в абстрактные.
Параметры
- строка
$clause - Условие on для преобразования.
Возвращает
строка|nullПереопределяет
Cake\Database\Schema\BaseSchema::_convertOnClause() _defaultValue()source protected
_defaultValue( string|null $default )
Обработать значение по умолчанию.
Postgres включает данные последовательности и информацию о преобразовании в значения по умолчанию. Нам нужно их удалить.
Параметры
- строка|null
$default - Значение по умолчанию.
Возвращает
строка|null_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-фрагмент.
dropTableSql()source public
dropTableSql( Cake\Database\Schema\TableSchema $schema )
Генерировать SQL для удаления таблицы.
Параметры
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы
Возвращает
массивSQL-запросы для удаления таблицы.
Переопределяет
Cake\Database\Schema\BaseSchema::dropTableSql() 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 - Ссылка столбцов ограничения внешнего ключа
Возвращает
строка_foreignOnClause()source protected
_foreignOnClause( string|null $on )
Генерировать предложение ON для внешнего ключа.
Параметры
- строка|null
$on - Предложение on
Возвращает
строка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-запросы для получения параметров таблицы.
© 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.8/class-Cake.Database.Schema.PostgresSchema.html