Spec-Zone.ru › CakePHP 3.8

Класс SqlserverSchema

Функции управления и рефлексии схемой SQLServer.

Cake\Database\Schema\BaseSchema
Расширенный Cake\Database\Schema\SqlserverSchema
Пространство имён: Cake\Database\Schema
Расположение: Database/Schema/SqlserverSchema.php

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

  • string

    DEFAULT_SCHEMA_NAME
    'dbo'

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

  • _driver

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

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

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

_convertColumn()исходный код protected

_convertColumn( string $col , integer|null $length = null , integer|null $precision = null , integer|null $scale = null )

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

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

Параметры

строка $col
Тип столбца
целое число|null $length необязательный null
длина столбца
целое число|null $precision необязательный null
точность столбца
целое число|null $scale необязательный null
масштаб столбца

Возвращаемое значение

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

Ссылка

https://technet.microsoft.com/ru-ru/library/ms187752.aspx

_convertOnClause()исходный код protected

_convertOnClause( string $clause )

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

Параметры

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

Возвращаемое значение

строка|null

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

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

_defaultValue()исходный код protected

_defaultValue( string|null $default )

Изменить значение по умолчанию.

Sqlite включает кавычки и значения NULL в значениях по умолчанию. Нам нужно их удалить.

Параметры

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

Возвращаемое значение

строка|null

_foreignOnClause()исходный код protected

_foreignOnClause( string|null $on )

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

Параметры

строка|null $on
Условие ON

Возвращаемое значение

строка

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

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

_keySql()исходный код protected

_keySql( string $prefix , array $data )

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

Параметры

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

Возвращаемое значение

строка

addConstraintSql()исходный код public

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

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

Параметры

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

Возвращаемое значение

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

columnSql()исходный код public

columnSql( Cake\Database\Schema\TableSchema $schema , string $name )

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

Параметры

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

Возвращаемое значение

строка
SQL фрагмент.

constraintSql()исходный код public

constraintSql( Cake\Database\Schema\TableSchema $schema , string $name )

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

Параметры

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

Возвращаемое значение

строка
SQL фрагмент.

convertColumnDescription()исходный код public

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

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

Параметры

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

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-фрагмент.

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

Возвращает

строка

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

dropTableSql()source public

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

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

Параметры

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

Возвращает

массив
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.SqlserverSchema.html

Spec-Zone.ru

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