Абстрактный класс yii\db\Schema

public string $columnSchemaClass = 'yii\db\ColumnSchema'

public yii\db\Connection $db = null

public string $defaultSchema = null

public array $exceptionMap = ['SQLSTATE[23' => 'yii\db\IntegrityException']

public string getLastInsertID ( $sequenceName = '' )

public yii\db\QueryBuilder getQueryBuilder ( )

public string[] getSchemaNames ( $refresh = false )

public string[] getTableNames ( $schema = '', $refresh = false )

public yii\db\TableSchema[] getTableSchemas ( $schema = '', $refresh = false )

public void setTransactionIsolationLevel ( $level )

convertException() public method

Преобразует исключение DB в более конкретное, если это возможно.

public yii\db\Exception convertException ( Exception $e, $rawSql )
$e	Exception
$rawSql	string	SQL, вызвавший исключение

createColumnSchema() protected method

protected yii\db\ColumnSchema createColumnSchema ( )
throws	yii\base\InvalidConfigException

createColumnSchemaBuilder() public method (available since version 2.0.6)

Создает экземпляр билдера схемы столбца, задавая тип и точность значения.

Этот метод может быть переопределен дочерними классами для создания билдера схемы столбца, специфичного для СУБД.

public yii\db\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length = null )
$type	string	Тип столбца. См. yii\db\ColumnSchemaBuilder::$type.
$length	integer|string|array	Длина или точность столбца. См. yii\db\ColumnSchemaBuilder::$length.
return	yii\db\ColumnSchemaBuilder	Экземпляр билдера схемы столбца

createQueryBuilder() public method

Создает билдер запросов для базы данных.

Этот метод может быть переопределен дочерними классами для создания билдера запросов, специфичного для СУБД.

public yii\db\QueryBuilder createQueryBuilder ( )
return	yii\db\QueryBuilder	Экземпляр билдера запросов

createSavepoint() public method

Создает новую точку сохранения.

public void createSavepoint ( $name )
$name	string	Имя точки сохранения

findSchemaNames() protected method (available since version 2.0.4)

Возвращает все имена схем в базе данных, включая стандартную, но не системные схемы.

Этот метод следует переопределить в дочерних классах для поддержки этой функции, потому что по умолчанию он просто выбрасывает исключение.

protected array findSchemaNames ( )
return	array	Все имена схем в базе данных, за исключением системных схем
throws	yii\base\NotSupportedException	если этот метод вызван

findTableNames() protected method

Возвращает все имена таблиц в базе данных.

Этот метод следует переопределить в дочерних классах для поддержки этой функции, потому что по умолчанию он просто выбрасывает исключение.

protected array findTableNames ( $schema = '' )
$schema	string	Схема таблиц. По умолчанию пустая строка, что означает текущую или стандартную схему.
return	array	Все имена таблиц в базе данных. Имена не имеют префикса имени схемы.
throws	yii\base\NotSupportedException	если этот метод вызван

findUniqueIndexes() public method

Возвращает все уникальные индексы для данной таблицы.

Каждый элемент массива имеет следующий структуру:

[
 'IndexName1' => ['col1' [, ...]],
 'IndexName2' => ['col2' [, ...]],
]

Этот метод следует переопределить в дочерних классах для поддержки этой функции, потому что по умолчанию он просто выбрасывает исключение

public array findUniqueIndexes ( $table )
$table	yii\db\TableSchema	Метаданные таблицы
return	array	Все уникальные индексы для данной таблицы.
throws	yii\base\NotSupportedException	если этот метод вызван

getCacheKey() protected method

Возвращает ключ кэша для указанного имени таблицы.

protected mixed getCacheKey ( $name )
$name	string	Имя таблицы
return	mixed	Ключ кэша

getCacheTag() protected method

Возвращает имя тега кэша.

Это позволяет refresh() аннулировать все кэшированные схемы таблиц.

protected string getCacheTag ( )
return	string	Имя тега кэша

getColumnPhpType() protected method

Извлекает тип PHP из абстрактного типа DB.

protected string getColumnPhpType ( $column )
$column	yii\db\ColumnSchema	Информация о схеме столбца
return	string	Имя типа PHP

getLastInsertID() public method

Возвращает ID последней вставленной строки или последовательности значений.

См. также http://www.php.net/manual/en/function.PDO-lastInsertId.php.

public string getLastInsertID ( $sequenceName = '' )
$sequenceName	string	Имя объекта последовательности (необходимо для некоторых СУБД)
return	string	Идентификатор строки последней вставленной строки или последнее значение, полученное из объекта последовательности
throws	yii\base\InvalidCallException	если соединение с БД не активно

getPdoType() public method

Определяет тип PDO для данного значения данных PHP.

См. также http://www.php.net/manual/en/pdo.constants.php.

public integer getPdoType ( $data )
$data	mixed	Данные, для которых нужно определить тип PDO
return	integer	Тип PDO

getQueryBuilder() public method

public yii\db\QueryBuilder getQueryBuilder ( )
return	yii\db\QueryBuilder	Билдер запросов для этого подключения.

getRawTableName() public method

Возвращает фактическое имя данной таблицы.

Этот метод удалит фигурные скобки из заданного имени таблицы и заменит символ процента '%' на yii\db\Connection::$tablePrefix.

public string getRawTableName ( $name )
$name	string	Имя таблицы, подлежащее преобразованию
return	string	Фактическое имя заданной таблицы

getSchemaNames() public method (available since version 2.0.4)

Возвращает все имена схем базы данных, кроме системных.

public string[] getSchemaNames ( $refresh = false )
$refresh	boolean	Указывает, нужно ли получить самые последние доступные имена схем. Если false, возвращаются имена схем, полученные ранее (если доступны).
return	string[]	Все имена схем базы данных, кроме системных.

getTableNames() public method

Возвращает все имена таблиц в базе данных.

public string[] getTableNames ( $schema = '', $refresh = false )
$schema	string	Схема таблиц. По умолчанию пустая строка, что означает текущую или схему по умолчанию. Если не пусто, возвращаемые имена таблиц будут иметь префикс имени схемы.
$refresh	boolean	Указывает, нужно ли получить самые последние доступные имена таблиц. Если false, возвращаются имена таблиц, полученные ранее (если доступны).
return	string[]	Все имена таблиц в базе данных.

getTableSchema() public method

Получает метаданные для указанной таблицы.

public null|yii\db\TableSchema getTableSchema ( $name, $refresh = false )
$name	string	Имя таблицы. Имя таблицы может содержать имя схемы, если таковое имеется. Не используйте кавычки для имени таблицы.
$refresh	boolean	Указывает, нужно ли перезагрузить схему таблицы, даже если она найдена в кэше.
return	null|yii\db\TableSchema	Метаданные таблицы. Нуль, если указанная таблица не существует.

getTableSchemas() public method

Возвращает метаданные для всех таблиц в базе данных.

public yii\db\TableSchema[] getTableSchemas ( $schema = '', $refresh = false )
$schema	string	Схема таблиц. По умолчанию пустая строка, что означает текущую или схему по умолчанию.
$refresh	boolean	Указывает, нужно ли получить самые последние доступные схемы таблиц. Если false, могут быть возвращены данные из кэша, если они доступны.
return	yii\db\TableSchema[]	Метаданные для всех таблиц в базе данных. Каждый элемент массива — экземпляр yii\db\TableSchema или его производного класса.

insert() public method (available since version 2.0.4)

Выполняет команду INSERT, возвращая значения первичных ключей.

public array|false insert ( $table, $columns )
$table	string	Таблица, в которую будут добавлены новые строки.
$columns	array	Данные столбцов (имя => значение) для вставки в таблицу.
return	array|false	Значения первичных ключей или false, если команда завершилась неудачно

isReadQuery() public method

Возвращает значение, указывающее, предназначен ли SQL-запрос для чтения.

public boolean isReadQuery ( $sql )
$sql	string	SQL-запрос
return	boolean	Является ли SQL-запрос запросом на чтение.

loadTableSchema() protected abstract method

Загружает метаданные для указанной таблицы.

protected abstract null|yii\db\TableSchema loadTableSchema ( $name )
$name	string	Имя таблицы
return	null|yii\db\TableSchema	Зависимые от СУБД метаданные таблицы, null, если таблица не существует.

quoteColumnName() public method

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

Если имя столбца содержит префикс, префикс также будет должным образом приведен к виду, пригодного для запроса. Если имя столбца уже находится в кавычках или содержит '(', '[[' или '{{', этот метод ничего не сделает.

См. также quoteSimpleColumnName().

public string quoteColumnName ( $name )
$name	string	Имя столбца
return	string	Правильно приведенное к виду имя столбца

quoteSimpleColumnName() public method

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

Простое имя столбца должно содержать только имя столбца без префикса. Если имя столбца уже находится в кавычках или является символом звёздочка '*', этот метод ничего не сделает.

public string quoteSimpleColumnName ( $name )
$name	string	Имя столбца
return	string	Правильно приведенное к виду имя столбца

quoteSimpleTableName() public method

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

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

public string quoteSimpleTableName ( $name )
$name	string	Имя таблицы
return	string	Правильно приведенное к виду имя таблицы

quoteTableName() public method

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

Если имя таблицы содержит префикс схемы, префикс также будет должным образом приведен к виду, пригодного для запроса. Если имя таблицы уже находится в кавычках или содержит '(' или '{{', этот метод ничего не сделает.

См. также quoteSimpleTableName().

public string quoteTableName ( $name )
$name	string	Имя таблицы
return	string	Правильно приведенное к виду имя таблицы

quoteValue() public method

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

Обратите внимание, что если параметр не является строкой, он будет возвращен без изменений.

См. также http://www.php.net/manual/en/function.PDO-quote.php.

public string quoteValue ( $str )
$str	string	Строка для приведения к виду, пригодного для запроса
return	string	Правильно приведенная к виду строка

refresh() public method

Обновляет схему.

Этот метод очищает все кэшированные схемы таблиц, чтобы их можно было пересоздать позже для отражения изменений в структуре базы данных.

public void refresh ( )

refreshTableSchema() public method (available since version 2.0.6)

Обновляет схему конкретной таблицы.

Этот метод очищает кэш схемы таблиц, чтобы его можно было повторно создать позже для отражения изменений схемы базы данных.

public void refreshTableSchema ( $name )
$name	string	Имя таблицы.

releaseSavepoint() public method

Освобождает существующую точку сохранения.

public void releaseSavepoint ( $name )
$name	string	Имя точки сохранения

rollBackSavepoint() public method

Откатывает транзакцию до ранее созданной точки сохранения.

public void rollBackSavepoint ( $name )
$name	string	Имя точки сохранения

setTransactionIsolationLevel() public method

Устанавливает уровень изоляции текущей транзакции.

См. также http://en.wikipedia.org/wiki/Isolation_(database_systems)#Isolation_levels.

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, а также строкой, содержащей синтаксис, специфичный для СУБД, который необходимо использовать после SET TRANSACTION ISOLATION LEVEL.

supportsSavepoint() public method

public boolean supportsSavepoint ( )
return	boolean	Поддерживает ли эта СУБД точки сохранения.