Класс yii\db\cubrid\Schema
| Наследование | yii\db\cubrid\Schema » yii\db\Schema » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/cubrid/Schema.php |
Класс Schema предназначен для получения метаданных из базы данных CUBRID (версия 9.3.x и выше).
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $columnSchemaClass | строка | Класс схемы столбца | yii\db\Schema |
| $db | yii\db\Connection | Подключение к базе данных | yii\db\Schema |
| $defaultSchema | строка | Имя схемы по умолчанию, используемое для текущего сеанса. | yii\db\Schema |
| $exceptionMap | массив | Сопоставление ошибок базы данных и соответствующих исключений. Если левая часть найдена в сообщении об ошибке базы данных, используется класс исключения из правой части. | yii\db\cubrid\Schema |
| $lastInsertID | строка | Идентификатор последней вставленной строки или последнее значение, полученное из объекта последовательности | yii\db\Schema |
| $queryBuilder | yii\db\QueryBuilder | Построитель запросов для этого подключения. | yii\db\Schema |
| $schemaNames | строка[] | Все имена схем в базе данных, за исключением системных схем. | yii\db\Schema |
| $tableNames | строка[] | Все имена таблиц в базе данных. | yii\db\Schema |
| $tableSchemas | yii\db\TableSchema[] | Метаданные для всех таблиц в базе данных. | yii\db\Schema |
| $transactionIsolationLevel | строка | Уровень изоляции транзакции для использования в этой транзакции. | yii\db\cubrid\Schema |
| $typeMap | массив | Сопоставление физических типов столбцов (ключи) с абстрактными типами столбцов (значения). См. [документацию CUBRID](http://www. | yii\db\cubrid\Schema |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| convertException() | Преобразует исключение DB в более конкретное, если это возможно. | yii\db\Schema |
| createColumnSchemaBuilder() | Создаёт экземпляр билдера схемы столбца, задавая тип и точность значения. | yii\db\cubrid\Schema |
| createQueryBuilder() | Создаёт билдер запроса для базы данных CUBRID. | yii\db\cubrid\Schema |
| createSavepoint() | Создаёт новую точку сохранения. | yii\db\Schema |
| findUniqueIndexes() | Возвращает все уникальные индексы для указанной таблицы. | yii\db\Schema |
| getLastInsertID() | Возвращает ID последней вставленной строки или значения последовательности. | yii\db\Schema |
| getPdoType() | Определяет тип PDO для заданного значения PHP данных. | yii\db\cubrid\Schema |
| getQueryBuilder() | yii\db\Schema | |
| getRawTableName() | Возвращает фактическое имя заданного имени таблицы. | yii\db\Schema |
| getSchemaNames() | Возвращает все имена схем в базе данных, за исключением системных схем. | yii\db\Schema |
| getTableNames() | Возвращает все имена таблиц в базе данных. | yii\db\Schema |
| getTableSchema() | Получает метаданные для указанной таблицы. | yii\db\Schema |
| getTableSchemas() | Возвращает метаданные для всех таблиц в базе данных. | yii\db\Schema |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| insert() | Выполняет команду INSERT, возвращая значения первичных ключей. | yii\db\Schema |
| isReadQuery() | Возвращает значение, указывающее, предназначен ли SQL-запрос для чтения. | yii\db\Schema |
| quoteColumnName() | Приводит имя столбца к цитируемому виду для использования в запросе. | yii\db\Schema |
| quoteSimpleColumnName() | Приводит имя столбца к цитируемому виду для использования в запросе. | yii\db\cubrid\Schema |
| quoteSimpleTableName() | Приводит имя таблицы к цитируемому виду для использования в запросе. | yii\db\cubrid\Schema |
| quoteTableName() | Приводит имя таблицы к цитируемому виду для использования в запросе. | yii\db\Schema |
| quoteValue() | Приводит строковое значение к цитируемому виду для использования в запросе. | yii\db\Schema |
| refresh() | Обновляет схему. | yii\db\Schema |
| refreshTableSchema() | Обновляет схему конкретной таблицы. | yii\db\Schema |
| releaseSavepoint() | Освобождает существующую точку сохранения. | yii\db\cubrid\Schema |
| rollBackSavepoint() | Откатывает к ранее созданной точке сохранения. | yii\db\Schema |
| setTransactionIsolationLevel() | Устанавливает уровень изоляции текущей транзакции. | yii\db\cubrid\Schema |
| supportsSavepoint() | yii\db\Schema |
Методы Protected
| Метод | Описание | Определено в |
|---|---|---|
| createColumnSchema() | yii\db\Schema | |
| findSchemaNames() | Возвращает все имена схем в базе данных, включая основную, но не системные схемы. | yii\db\Schema |
| findTableNames() | Возвращает все имена таблиц в базе данных. | yii\db\cubrid\Schema |
| getCacheKey() | Возвращает ключ кэша для указанного имени таблицы. | yii\db\Schema |
| getCacheTag() | Возвращает имя тега кэша. | yii\db\Schema |
| getColumnPhpType() | Извлекает тип PHP из абстрактного типа DB. | yii\db\Schema |
| loadColumnSchema() | Загружает информацию о столбце в объект yii\db\ColumnSchema. | yii\db\cubrid\Schema |
| loadTableSchema() | Загружает метаданные для указанной таблицы. | yii\db\cubrid\Schema |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| TYPE_BIGINT | 'bigint' | yii\db\Schema | |
| TYPE_BIGPK | 'bigpk' | yii\db\Schema | |
| TYPE_BINARY | 'binary' | yii\db\Schema | |
| TYPE_BOOLEAN | 'boolean' | yii\db\Schema | |
| TYPE_CHAR | 'char' | yii\db\Schema | |
| TYPE_DATE | 'date' | yii\db\Schema | |
| TYPE_DATETIME | 'datetime' | yii\db\Schema | |
| TYPE_DECIMAL | 'decimal' | yii\db\Schema | |
| TYPE_DOUBLE | 'double' | yii\db\Schema | |
| TYPE_FLOAT | 'float' | yii\db\Schema | |
| TYPE_INTEGER | 'integer' | yii\db\Schema | |
| TYPE_MONEY | 'money' | yii\db\Schema | |
| TYPE_PK | 'pk' | yii\db\Schema | |
| TYPE_SMALLINT | 'smallint' | yii\db\Schema | |
| TYPE_STRING | 'string' | yii\db\Schema | |
| TYPE_TEXT | 'text' | yii\db\Schema | |
| TYPE_TIME | 'time' | yii\db\Schema | |
| TYPE_TIMESTAMP | 'timestamp' | yii\db\Schema | |
| TYPE_UBIGPK | 'ubigpk' | yii\db\Schema | |
| TYPE_UPK | 'upk' | yii\db\Schema |
Подробное описание свойств
$exceptionMap общедоступное свойство
Отображение ошибок БД и соответствующих исключений. Если левая часть найдена в сообщении об ошибке БД, используется класс исключения из правой части.
public array $exceptionMap = ['Operation would have caused one or more unique constraint violations' => 'yii\db\IntegrityException']
$transactionIsolationLevel общедоступное свойство для записи
Уровень изоляции транзакции для этой транзакции. Может быть одним из yii\db\Transaction::READ_UNCOMMITTED, yii\db\Transaction::READ_COMMITTED, yii\db\Transaction::REPEATABLE_READ и yii\db\Transaction::SERIALIZABLE, а также строкой, содержащей синтаксис, специфичный для СУБД, который будет использоваться после SET TRANSACTION ISOLATION LEVEL.
public void setTransactionIsolationLevel ( $level )
$typeMap общедоступное свойство
Отображение физических типов столбцов (ключи) на абстрактные типы столбцов (значения). Подробную информацию о типах данных см. в документации CUBRID.
public array $typeMap = ['short' => self::TYPE_SMALLINT, 'smallint' => self::TYPE_SMALLINT, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'numeric' => self::TYPE_DECIMAL, 'decimal' => self::TYPE_DECIMAL, 'float' => self::TYPE_FLOAT, 'real' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'double precision' => self::TYPE_DOUBLE, 'monetary' => self::TYPE_MONEY, 'date' => self::TYPE_DATE, 'time' => self::TYPE_TIME, 'timestamp' => self::TYPE_TIMESTAMP, 'datetime' => self::TYPE_DATETIME, 'char' => self::TYPE_CHAR, 'varchar' => self::TYPE_STRING, 'char varying' => self::TYPE_STRING, 'nchar' => self::TYPE_CHAR, 'nchar varying' => self::TYPE_STRING, 'string' => self::TYPE_STRING, 'blob' => self::TYPE_BINARY, 'clob' => self::TYPE_BINARY, 'bit' => self::TYPE_INTEGER, 'bit varying' => self::TYPE_INTEGER, 'set' => self::TYPE_STRING, 'multiset' => self::TYPE_STRING, 'list' => self::TYPE_STRING, 'sequence' => self::TYPE_STRING, 'enum' => self::TYPE_STRING]
Подробное описание методов
createColumnSchemaBuilder() public method
Создать экземпляр билдера схемы столбца, указав тип и точность значения.
Этот метод может быть переопределён дочерними классами для создания билдера схемы столбца, специфичного для СУБД.
| public yii\db\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length = null ) | ||
|---|---|---|
| $type | string |
Тип столбца. См. yii\db\cubrid\ColumnSchemaBuilder::$type. |
| $length | integer|string|array |
Длина или точность столбца. См. yii\db\cubrid\ColumnSchemaBuilder::$length. |
| return | yii\db\ColumnSchemaBuilder |
Экземпляр билдера схемы столбца |
createQueryBuilder() public method
Создаёт билдер запросов для базы данных CUBRID.
| public yii\db\cubrid\QueryBuilder createQueryBuilder ( ) | ||
|---|---|---|
| return | yii\db\cubrid\QueryBuilder |
Экземпляр билдера запросов |
findTableNames() protected method
Возвращает все имена таблиц в базе данных.
| protected array findTableNames ( $schema = '' ) | ||
|---|---|---|
| $schema | string |
Схема таблиц. По умолчанию пустая строка, что означает текущую или стандартную схему. |
| return | array |
Все имена таблиц в базе данных. Имена НЕ имеют префикса имени схемы. |
getPdoType() public method
Определяет тип PDO для заданного значения данных PHP.
См. также http://www.php.net/manual/en/pdo.constants.php.
| public integer getPdoType ( $data ) | ||
|---|---|---|
| $data | mixed |
Данные, для которых требуется определить тип PDO |
| return | integer |
Тип PDO |
loadColumnSchema() protected method
Загружает информацию о столбце в объект yii\db\ColumnSchema.
| protected yii\db\ColumnSchema loadColumnSchema ( $info ) | ||
|---|---|---|
| $info | array |
Информация о столбце |
| return | yii\db\ColumnSchema |
Объект схемы столбца |
loadTableSchema() protected method
Загружает метаданные для указанной таблицы.
| protected yii\db\TableSchema loadTableSchema ( $name ) | ||
|---|---|---|
| $name | string |
Имя таблицы |
| return | yii\db\TableSchema |
Метаданные таблицы, зависящие от драйвера. Null, если таблица не существует. |
quoteSimpleColumnName() public method
Приводит имя столбца в цитируемый вид для использования в запросе.
Простое имя столбца не имеет префикса.
| public string quoteSimpleColumnName ( $name ) | ||
|---|---|---|
| $name | string |
Имя столбца |
| return | string |
Правильно цитируемое имя столбца |
quoteSimpleTableName() public method
Приводит имя таблицы в цитируемый вид для использования в запросе.
Простое имя таблицы не имеет префикса схемы.
| public string quoteSimpleTableName ( $name ) | ||
|---|---|---|
| $name | string |
Имя таблицы |
| return | string |
Правильно цитируемое имя таблицы |
releaseSavepoint() public method
Освобождает существующую точку сохранения.
| public void releaseSavepoint ( $name ) | ||
|---|---|---|
| $name | string |
Имя точки сохранения |
setTransactionIsolationLevel() public method
Устанавливает уровень изоляции текущей транзакции.
См. также http://www.cubrid.org/manual/91/en/sql/transaction.html#database-concurrency.
| public void setTransactionIsolationLevel ( $level ) | ||
|---|---|---|
| $level | string |
Уровень изоляции транзакции для использования в этой транзакции. Может быть одним из yii\db\Transaction::READ_UNCOMMITTED, yii\db\Transaction::READ_COMMITTED, yii\db\Transaction::REPEATABLE_READ и yii\db\Transaction::SERIALIZABLE, а также строкой, содержащей специфичный для СУБД синтаксис, который будет использован после |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-cubrid-schema.html