Spec-Zone.ru › CakePHP 3.4

Класс PostgresSchema

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

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

Унаследованные свойства

  • _driver

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

  • _convertColumn() protected
    Преобразует определение столбца в абстрактные типы.
  • _convertConstraint() protected
    Добавляет/обновляет ограничение в объект схемы.
  • _convertOnClause() protected
    Преобразует строковые условия on в абстрактные.
  • _defaultValue() protected
    Обрабатывает значение по умолчанию.
  • _keySql() protected
    Вспомогательный метод для генерации SQL фрагментов ключей.
  • addConstraintSql() public
    Генерирует SQL запросы для добавления ограничений внешнего ключа к таблице
  • columnSql() public
    Генерирует SQL фрагмент для отдельного столбца в таблице.
  • constraintSql() public
    Генерирует SQL фрагменты для определения ограничений таблицы.
  • convertColumnDescription() public
    Преобразует результаты описания поля в абстрактные поля схемы.
  • convertForeignKeyDescription() public
    Преобразует описание внешнего ключа в ограничения в объекте Table.
  • 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 )

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

массив $row
Данные строки из describeForeignKeySql.
END_OF_DOCUMENT_MARKER

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–2017 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.4/class-Cake.Database.Schema.PostgresSchema.html

Spec-Zone.ru

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