Spec-Zone.ru › CakePHP 3.6

Класс MysqlSchema

Функции генерации/отражения схем для MySQL

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

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

  • $_driver protected
    Cake\Database\Driver\Mysql
    Экземпляр используемого драйвера.

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

  • _convertColumn() protected
    Преобразование типа столбца MySQL в абстрактный тип.
  • _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-запросов для удаления ограничений внешнего ключа из таблицы.
  • indexSql() public
    Генерация фрагмента SQL для отдельного индекса в таблице.
  • listTablesSql() public
    Генерация SQL для перечисления таблиц.
  • truncateTableSql() public
    Генерация SQL для усечения таблицы.

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

_convertColumn()source protected

_convertColumn( string $column )

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

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

Параметры

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

Возвращает

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

Издаёт исключения

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

_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.

convertIndexDescription()source public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

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

convertOptionsDescription()source public

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

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

Параметры

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

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

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

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-запросы для создания таблицы.
END_OF_DOCUMENT_MARKER

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) для выполнения.

describeOptionsSql()source public

describeOptionsSql( string $tableName , array $config )

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

Параметры

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

Возвращает

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

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

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

dropConstraintSql()source public

dropConstraintSql( Cake\Database\Schema\TableSchema $schema )

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

Параметры

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

Возвращает

массив
SQL фрагмент.

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
Столбцы, на которые ссылается ограничение внешнего ключа

Возвращает

строка

_convertOnClause()source protected

_convertOnClause( string $clause )

Преобразовать строковые фрагменты ON в абстрактные.

Параметры

строка $clause
Фрагмент ON для преобразования.

Возвращает

строка|null

_foreignOnClause()source protected

_foreignOnClause( string|null $on )

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

Параметры

строка|null $on
Фрагмент ON

Возвращает

строка

dropTableSql()source public

dropTableSql( Cake\Database\Schema\TableSchema $schema )

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

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр схемы

Возвращает

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

Подробности свойств

$_driversource

protected Cake\Database\Driver\Mysql

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

© 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.MysqlSchema.html

Spec-Zone.ru

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