Класс 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.6/class-Cake.Database.Schema.PostgresSchema.html