Spec-Zone.ru › CakePHP 3.1

Класс PostgresSchema

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

Cake\Database\Schema\BaseSchema
Extended by Cake\Database\Schema\PostgresSchema
Пространство имён: Cake\Database\Schema
Расположение: Database/Schema/PostgresSchema.php

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

_convertColumnsource protected

_convertColumn( string $column )

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

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

Параметры

строка $column
Тип столбца + длина

Возвращает

array
Массив информации о столбце.

Выбрасывает

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

_convertConstraintsource protected

_convertConstraint( Cake\Database\Schema\Table $table , string $name , string $type , array $row )

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

Параметры

Cake\Database\Schema\Table $table
Таблица для обновления.
строка $name
Имя индекса.
строка $type
Тип индекса.
массив $row
Запись метаданных для обновления.

_convertOnClausesource protected

_convertOnClause( string $clause )

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

Параметры

строка $clause
Условие on для преобразования.

Возвращает

string|null
строка|null

Переопределяет

Cake\Database\Schema\BaseSchema::_convertOnClause()

_defaultValuesource protected

_defaultValue( string|null $default )

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

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

Параметры

строка|null $default
Значение по умолчанию.

Возвращает

string|null
строка|null

_keySqlsource protected

_keySql( string $prefix , array $data )

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

Параметры

строка $prefix
Префикс ключа
массив $data
Данные ключа.

Возвращает

string
строка

addConstraintSqlsource public

addConstraintSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы, к которому относятся внешние ключи.

Возвращает

array
Фрагмент SQL.

columnSqlsource public

columnSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы, в которой находится столбец.
строка $name
Имя столбца.

Возвращает

string
Фрагмент SQL.

constraintSqlsource public

constraintSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы, в которой находится столбец.
строка $name
Имя столбца.

Возвращает

string
Фрагмент SQL.

convertColumnDescriptionsource public

convertColumnDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table
Объект таблицы, к которому нужно добавить поля.
массив $row
Данные строки из describeColumnSql.

convertForeignKeyDescriptionsource public

convertForeignKeyDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table
Объект таблицы, к которому нужно добавить ограничение.
массив $row
Данные строки из describeForeignKeySql.

convertIndexDescriptionsource public

convertIndexDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table
Объект таблицы, к которому нужно добавить индекс или ограничение.
массив $row
Данные строки из describeIndexSql.

createTableSqlsource public

createTableSql( Cake\Database\Schema\Table $table , array $columns , array $constraints , array $indexes )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы.
массив $columns
Столбцы, которые нужно добавить в таблицу.
массив $constraints
Ограничения для таблицы.
массив $indexes
Индексы для таблицы.

Возвращает

array
SQL-запросы для создания таблицы.

describeColumnSqlsource public

describeColumnSql( string $tableName , array $config )

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

Параметры

строка $tableName
Имя таблицы, для которой требуется информация.
массив $config
Конфигурация подключения.

Возвращает

array
Массив (sql, params) для выполнения.

describeForeignKeySqlsource public

describeForeignKeySql( string $tableName , array $config )

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

Параметры

строка $tableName
Имя таблицы, для которой требуется информация.
массив $config
Конфигурация подключения.

Возвращает

array
Массив (sql, params) для выполнения.

describeIndexSqlsource public

describeIndexSql( string $tableName , array $config )

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

Параметры

строка $tableName
Имя таблицы, для которой требуется информация.
массив $config
Конфигурация подключения.

Возвращает

array
Массив (sql, params) для выполнения.

dropConstraintSqlsource public

dropConstraintSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы, к которому относятся внешние ключи.

Возвращает

array
Фрагмент SQL.
END_OF_DOCUMENT_MARKER

dropTableSqlsource public

dropTableSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы

Возвращает

array
SQL-запросы для удаления таблицы.

Переопределяет

Cake\Database\Schema\BaseSchema::dropTableSql()

indexSqlsource public

indexSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table
Объект таблицы, к которому относится столбец.
строка $name
Имя столбца.

Возвращает

string
Фрагмент SQL.

listTablesSqlsource public

listTablesSql( array $config )

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

Параметры

массив $config
Конфигурация подключения для получения таблиц.

Возвращает

array
Массив (sql, params) для выполнения.

truncateTableSqlsource public

truncateTableSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы.

Возвращает

array
SQL-запросы для обнуления таблицы.

Наследуемые методы из Cake\Database\Schema\BaseSchema

__constructsource public

__construct( Cake\Database\Driver $driver )

Конструктор

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

Параметры

Cake\Database\Driver $driver
Используемый драйвер.

_convertConstraintColumnssource protected

_convertConstraintColumns( string|array $references )

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

Параметры

строка|массив $references
Ссылающиеся столбцы ограничения внешнего ключа

Возвращает

string
строка

_foreignOnClausesource protected

_foreignOnClause( string|null $on )

Генерировать предложение ON для внешнего ключа.

Параметры

строка|null $on
Предложение on

Возвращает

string
строка

convertOptionsDescriptionsource public

convertOptionsDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table
Экземпляр таблицы.
массив $row
Строка данных.

describeOptionsSqlsource public

describeOptionsSql( string $tableName , array $config )

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

Параметры

строка $tableName
Имя таблицы.
массив $config
Конфигурация подключения.

Возвращает

array
SQL-запросы для получения опций таблицы.

Свойства, унаследованные от Cake\Database\Schema\BaseSchema

$_driversource

protected Cake\Database\Driver

Экземпляр используемого драйвера.

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Schema.PostgresSchema.html

Spec-Zone.ru

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