类 yii\db\sqlite\Schema
Schema 是一个用于从 SQLite (2/3) 数据库中检索元数据的类。
公共属性
公共方法
受保护的方法
常量
常量 | 值 | 描述 | 定义于 |
---|---|---|---|
SCHEMA_CACHE_VERSION | 1 | 模式缓存版本,用于在缓存数据格式更改时检测缓存值的兼容性问题。 | yii\db\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_JSON | 'json' | 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_TINYINT | 'tinyint' | yii\db\Schema | |
TYPE_UBIGPK | 'ubigpk' | yii\db\Schema | |
TYPE_UPK | 'upk' | yii\db\Schema |
属性详情
用于引用列名的字符。如果起始字符和结束字符不同,则可以使用包含 2 个字符的数组。
用于引用模式、表等的字符。如果起始字符和结束字符不同,则可以使用包含 2 个字符的数组。
此事务要使用的隔离级别。可以是 yii\db\Transaction::READ_UNCOMMITTED 或 yii\db\Transaction::SERIALIZABLE。
物理列类型 (键) 到抽象列类型 (值) 的映射
'tinyint' => self::TYPE_TINYINT,
'bit' => self::TYPE_SMALLINT,
'boolean' => self::TYPE_BOOLEAN,
'bool' => self::TYPE_BOOLEAN,
'smallint' => self::TYPE_SMALLINT,
'mediumint' => self::TYPE_INTEGER,
'int' => self::TYPE_INTEGER,
'integer' => self::TYPE_INTEGER,
'bigint' => self::TYPE_BIGINT,
'float' => self::TYPE_FLOAT,
'double' => self::TYPE_DOUBLE,
'real' => self::TYPE_FLOAT,
'decimal' => self::TYPE_DECIMAL,
'numeric' => self::TYPE_DECIMAL,
'tinytext' => self::TYPE_TEXT,
'mediumtext' => self::TYPE_TEXT,
'longtext' => self::TYPE_TEXT,
'text' => self::TYPE_TEXT,
'varchar' => self::TYPE_STRING,
'string' => self::TYPE_STRING,
'char' => self::TYPE_CHAR,
'blob' => self::TYPE_BINARY,
'datetime' => self::TYPE_DATETIME,
'year' => self::TYPE_DATE,
'date' => self::TYPE_DATE,
'time' => self::TYPE_TIME,
'timestamp' => self::TYPE_TIMESTAMP,
'enum' => self::TYPE_STRING,
]
方法详情
public mixed __call ( $name, $params ) | ||
$name | string |
方法名 |
$params | array |
方法参数 |
返回值 | mixed |
方法返回值 |
---|---|---|
抛出 | yii\base\UnknownMethodException |
当调用未知方法时 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现做了两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果该方法在子类中被重写,建议
- 构造函数的最后一个参数是一个配置数组,如这里的
$config
。 - 在构造函数末尾调用父级实现。
public void __construct ( $config = [] ) | ||
$config | array |
将用于初始化对象属性的键值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于: yii\base\BaseObject::__get()
返回对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 $value = $object->property;
时被隐式调用。
另见 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
返回值 | mixed |
属性值 |
---|---|---|
抛出 | yii\base\UnknownPropertyException |
如果属性未定义 |
抛出 | yii\base\InvalidCallException |
如果属性为只写 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\BaseObject::__isset()
检查属性是否已设置,即定义且不为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 isset($object->property)
时被隐式调用。
请注意,如果属性未定义,将返回 false。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | boolean |
命名的属性是否已设置(非空)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定义于: yii\base\BaseObject::__set()
设置对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 $object->property = $value;
时被隐式调用。
另见 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
抛出 | yii\base\UnknownPropertyException |
如果属性未定义 |
---|---|---|
抛出 | yii\base\InvalidCallException |
如果属性为只读 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定义于: yii\base\BaseObject::__unset()
将对象属性设置为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 unset($object->property)
时被隐式调用。
请注意,如果属性未定义,此方法将不执行任何操作。如果属性为只读,它将抛出异常。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
抛出 | yii\base\InvalidCallException |
如果属性为只读。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定义于: yii\base\BaseObject::canGetProperty()
返回一个值,指示属性是否可读。
一个属性是可读的,如果
- 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为真时);
另见 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定义于: yii\base\BaseObject::canSetProperty()
返回一个值,指示属性是否可写。
一个属性是可写的,如果
- 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为真时);
另见 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
代替。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名。
public static string className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
定义于: yii\db\Schema::convertException()
如果可能,将数据库异常转换为更具体的异常。
public yii\db\Exception convertException ( Exception $e, $rawSql ) | ||
$e | 异常 | |
$rawSql | string |
产生异常的 SQL |
public function convertException(\Exception $e, $rawSql)
{
if ($e instanceof Exception) {
return $e;
}
$exceptionClass = '\yii\db\Exception';
foreach ($this->exceptionMap as $error => $class) {
if (strpos($e->getMessage(), $error) !== false) {
$exceptionClass = $class;
}
}
$message = $e->getMessage() . "\nThe SQL being executed was: $rawSql";
$errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
return new $exceptionClass($message, $errorInfo, $e->getCode(), $e);
}
protected yii\db\ColumnSchema createColumnSchema ( ) | ||
返回值 | yii\db\ColumnSchema |
列架构实例。 |
---|---|---|
抛出 | yii\base\InvalidConfigException |
如果无法创建列架构类。 |
protected function createColumnSchema()
{
return Yii::createObject($this->columnSchemaClass);
}
创建列模式构建器实例,提供类型和值精度。
子类可以重写此方法以创建特定于DBMS的列模式生成器。
public yii\db\sqlite\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length = null ) | ||
$type | string | |
$length | integer|string|array|null |
列的长度或精度。参见 yii\db\sqlite\ColumnSchemaBuilder::$length。 |
返回值 | yii\db\sqlite\ColumnSchemaBuilder |
列模式生成器实例 |
---|
public function createColumnSchemaBuilder($type, $length = null)
{
return Yii::createObject(ColumnSchemaBuilder::className(), [$type, $length]);
}
为 MySQL 数据库创建一个查询构建器。
子类可以重写此方法以创建特定于DBMS的查询生成器。
public yii\db\sqlite\QueryBuilder createQueryBuilder ( ) | ||
返回值 | yii\db\sqlite\QueryBuilder |
查询生成器实例 |
---|
public function createQueryBuilder()
{
return Yii::createObject(QueryBuilder::className(), [$this->db]);
}
定义于: yii\db\Schema::createSavepoint()
创建一个新的保存点。
public void createSavepoint ( $name ) | ||
$name | string |
保存点的名称 |
public function createSavepoint($name)
{
$this->db->createCommand("SAVEPOINT $name")->execute();
}
收集表的列元数据。
protected boolean findColumns ( $table ) | ||
$table | yii\db\TableSchema |
表元数据 |
返回值 | boolean |
表是否存在于数据库中 |
---|
protected function findColumns($table)
{
$sql = 'PRAGMA table_info(' . $this->quoteSimpleTableName($table->name) . ')';
$columns = $this->db->createCommand($sql)->queryAll();
if (empty($columns)) {
return false;
}
foreach ($columns as $info) {
$column = $this->loadColumnSchema($info);
$table->columns[$column->name] = $column;
if ($column->isPrimaryKey) {
$table->primaryKey[] = $column->name;
}
}
if (count($table->primaryKey) === 1 && !strncasecmp($table->columns[$table->primaryKey[0]]->dbType, 'int', 3)) {
$table->sequenceName = '';
$table->columns[$table->primaryKey[0]]->autoIncrement = true;
}
return true;
}
收集给定表的外部键列详细信息。
protected void findConstraints ( $table ) | ||
$table | yii\db\TableSchema |
表元数据 |
protected function findConstraints($table)
{
$sql = 'PRAGMA foreign_key_list(' . $this->quoteSimpleTableName($table->name) . ')';
$keys = $this->db->createCommand($sql)->queryAll();
foreach ($keys as $key) {
$id = (int) $key['id'];
if (!isset($table->foreignKeys[$id])) {
$table->foreignKeys[$id] = [$key['table'], $key['from'] => $key['to']];
} else {
// composite FK
$table->foreignKeys[$id][$key['from']] = $key['to'];
}
}
}
protected array findSchemaNames ( ) | ||
返回值 | array |
数据库中所有模式名称,不包括系统模式。 |
---|---|---|
抛出 | yii\base\NotSupportedException |
如果此方法不受DBMS支持。 |
protected function findSchemaNames()
{
throw new NotSupportedException(get_class($this) . ' does not support fetching all schema names.');
}
返回数据库中所有表名。
为了支持此功能,子类应重写此方法,因为默认实现只抛出异常。
protected array findTableNames ( $schema = '' ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式。 |
返回值 | array |
数据库中的所有表名。名称没有模式名称前缀。 |
---|---|---|
抛出 | yii\base\NotSupportedException |
如果此方法不受DBMS支持。 |
protected function findTableNames($schema = '')
{
$sql = "SELECT DISTINCT tbl_name FROM sqlite_master WHERE tbl_name<>'sqlite_sequence' ORDER BY tbl_name";
return $this->db->createCommand($sql)->queryColumn();
}
返回给定表的全部唯一索引。
每个数组元素具有以下结构
[
'IndexName1' => ['col1' [, ...]],
'IndexName2' => ['col2' [, ...]],
]
public array findUniqueIndexes ( $table ) | ||
$table | yii\db\TableSchema |
表元数据 |
返回值 | array |
给定表的全部唯一索引。 |
---|
public function findUniqueIndexes($table)
{
$sql = 'PRAGMA index_list(' . $this->quoteSimpleTableName($table->name) . ')';
$indexes = $this->db->createCommand($sql)->queryAll();
$uniqueIndexes = [];
foreach ($indexes as $index) {
$indexName = $index['name'];
$indexInfo = $this->db->createCommand('PRAGMA index_info(' . $this->quoteValue($index['name']) . ')')->queryAll();
if ($index['unique']) {
$uniqueIndexes[$indexName] = [];
foreach ($indexInfo as $row) {
$uniqueIndexes[$indexName][] = $row['name'];
}
}
}
return $uniqueIndexes;
}
定义于: yii\db\Schema::getCacheKey()
返回指定表名的缓存键。
protected mixed getCacheKey ( $name ) | ||
$name | string |
表名。 |
返回值 | mixed |
缓存键。 |
---|
protected function getCacheKey($name)
{
return [
__CLASS__,
$this->db->dsn,
$this->db->username,
$this->getRawTableName($name),
];
}
protected string getCacheTag ( ) | ||
返回值 | string |
缓存标签名 |
---|
protected function getCacheTag()
{
return md5(serialize([
__CLASS__,
$this->db->dsn,
$this->db->username,
]));
}
定义于: yii\db\Schema::getColumnPhpType()
从抽象数据库类型中提取 PHP 类型。
protected string getColumnPhpType ( $column ) | ||
$column | yii\db\ColumnSchema |
列模式信息 |
返回值 | string |
PHP 类型名 |
---|
protected function getColumnPhpType($column)
{
static $typeMap = [
// abstract type => php type
self::TYPE_TINYINT => 'integer',
self::TYPE_SMALLINT => 'integer',
self::TYPE_INTEGER => 'integer',
self::TYPE_BIGINT => 'integer',
self::TYPE_BOOLEAN => 'boolean',
self::TYPE_FLOAT => 'double',
self::TYPE_DOUBLE => 'double',
self::TYPE_BINARY => 'resource',
self::TYPE_JSON => 'array',
];
if (isset($typeMap[$column->type])) {
if ($column->type === 'bigint') {
return PHP_INT_SIZE === 8 && !$column->unsigned ? 'integer' : 'string';
} elseif ($column->type === 'integer') {
return PHP_INT_SIZE === 4 && $column->unsigned ? 'string' : 'integer';
}
return $typeMap[$column->type];
}
return 'string';
}
定义于: yii\db\Schema::getLastInsertID()
返回最后插入行的 ID 或序列值。
另请参见 https://php.ac.cn/manual/en/function.PDO-lastInsertId.php。
public string getLastInsertID ( $sequenceName = '' ) | ||
$sequenceName | string |
序列对象的名称(某些DBMS需要) |
返回值 | string |
插入的最后一行行 ID,或从序列对象检索的最后一个值 |
---|---|---|
抛出 | yii\base\InvalidCallException |
如果DB连接未处于活动状态 |
public function getLastInsertID($sequenceName = '')
{
if ($this->db->isActive) {
return $this->db->pdo->lastInsertId($sequenceName === '' ? null : $this->quoteTableName($sequenceName));
}
throw new InvalidCallException('DB Connection is not active.');
}
定义于: yii\db\Schema::getPdoType()
确定给定 PHP 数据值的 PDO 类型。
public integer getPdoType ( $data ) | ||
$data | mixed |
要确定其PDO类型的數據 |
返回值 | integer |
PDO 类型 |
---|
public function getPdoType($data)
{
static $typeMap = [
// php type => PDO type
'boolean' => \PDO::PARAM_BOOL,
'integer' => \PDO::PARAM_INT,
'string' => \PDO::PARAM_STR,
'resource' => \PDO::PARAM_LOB,
'NULL' => \PDO::PARAM_NULL,
];
$type = gettype($data);
return isset($typeMap[$type]) ? $typeMap[$type] : \PDO::PARAM_STR;
}
public yii\db\QueryBuilder getQueryBuilder ( ) | ||
返回值 | yii\db\QueryBuilder |
此连接的查询构建器。 |
---|
public function getQueryBuilder()
{
if ($this->_builder === null) {
$this->_builder = $this->createQueryBuilder();
}
return $this->_builder;
}
定义于: yii\db\Schema::getRawTableName()
返回给定表名的实际名称。
此方法将从给定的表名中剥离花括号,并将百分比字符“%”替换为 yii\db\Connection::$tablePrefix。
public string getRawTableName ( $name ) | ||
$name | string |
要转换的表名 |
返回值 | string |
给定表名的真实名称 |
---|
public function getRawTableName($name)
{
if (strpos($name, '{{') !== false) {
$name = preg_replace('/\\{\\{(.*?)\\}\\}/', '\1', $name);
return str_replace('%', $this->db->tablePrefix, $name);
}
return $name;
}
定义于: yii\db\ConstraintFinderTrait::getSchemaChecks()
返回数据库中所有表的检查约束。
public \yii\db\CheckConstraint[][] getSchemaChecks ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 false,则可能会返回缓存的数据(如果可用)。 |
返回值 | \yii\db\CheckConstraint[][] |
数据库中所有表的检查约束。每个数组元素都是一个包含 yii\db\CheckConstraint 或其子类的数组。 |
---|
public function getSchemaChecks($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'checks', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getSchemaDefaultValues()
返回数据库中所有表的默认值约束。
public yii\db\DefaultValueConstraint[] getSchemaDefaultValues ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 false,则可能会返回缓存的数据(如果可用)。 |
返回值 | yii\db\DefaultValueConstraint[] |
数据库中所有表的默认值约束。每个数组元素都是一个包含 yii\db\DefaultValueConstraint 或其子类的数组。 |
---|
public function getSchemaDefaultValues($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'defaultValues', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getSchemaForeignKeys()
返回数据库中所有表的外部键。
public \yii\db\ForeignKeyConstraint[][] getSchemaForeignKeys ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 false,则可能会返回缓存的数据(如果可用)。 |
返回值 | \yii\db\ForeignKeyConstraint[][] |
数据库中所有表的外部键。每个数组元素都是一个包含 yii\db\ForeignKeyConstraint 或其子类的数组。 |
---|
public function getSchemaForeignKeys($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'foreignKeys', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getSchemaIndexes()
返回数据库中所有表的索引。
public \yii\db\IndexConstraint[][] getSchemaIndexes ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 false,则可能会返回缓存的数据(如果可用)。 |
返回值 | \yii\db\IndexConstraint[][] |
数据库中所有表的索引。每个数组元素都是一个包含 yii\db\IndexConstraint 或其子类的数组。 |
---|
public function getSchemaIndexes($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'indexes', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getSchemaMetadata()
返回给定模式中所有表的给定类型的元数据。
protected abstract array getSchemaMetadata ( $schema, $type, $refresh ) | ||
$schema | string |
元数据的模式。默认为空字符串,表示当前或默认模式名称。 |
$type | string |
元数据类型。 |
$refresh | boolean |
是否获取最新可用的表元数据。如果为 |
返回值 | array |
元数据的数组。 |
---|
abstract protected function getSchemaMetadata($schema, $type, $refresh);
定义于: yii\db\Schema::getSchemaNames()
返回数据库中所有模式名称,不包括系统模式。
public string[] getSchemaNames ( $refresh = false ) | ||
$refresh | boolean |
是否获取最新可用的模式名称。如果为 false,则将返回之前获取的模式名称(如果可用)。 |
返回值 | string[] |
数据库中所有模式名称,不包括系统模式。 |
---|
public function getSchemaNames($refresh = false)
{
if ($this->_schemaNames === null || $refresh) {
$this->_schemaNames = $this->findSchemaNames();
}
return $this->_schemaNames;
}
定义于: yii\db\ConstraintFinderTrait::getSchemaPrimaryKeys()
返回数据库中所有表的主键。
public yii\db\Constraint[] getSchemaPrimaryKeys ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 |
返回值 | yii\db\Constraint[] |
数据库中所有表的主键。每个数组元素都是 yii\db\Constraint 或其子类的实例。 |
---|
public function getSchemaPrimaryKeys($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'primaryKey', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getSchemaUniques()
返回数据库中所有表的唯一约束。
public \yii\db\Constraint[][] getSchemaUniques ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 false,则可能会返回缓存的数据(如果可用)。 |
返回值 | \yii\db\Constraint[][] |
数据库中所有表的唯一约束。每个数组元素都是一个包含 yii\db\Constraint 或其子类的数组。 |
---|
public function getSchemaUniques($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'uniques', $refresh);
}
定义于: yii\db\Schema::getServerVersion()
返回一个服务器版本,以字符串形式表示,可以通过 \version_compare() 进行比较。
public string getServerVersion ( ) | ||
返回值 | string |
服务器版本,以字符串形式表示。 |
---|
public function getServerVersion()
{
if ($this->_serverVersion === null) {
$this->_serverVersion = $this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_SERVER_VERSION);
}
return $this->_serverVersion;
}
定义于: yii\db\ConstraintFinderTrait::getTableChecks()
获取指定表的检查约束信息。
public yii\db\CheckConstraint[] getTableChecks ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\CheckConstraint[] |
表检查约束。 |
---|
public function getTableChecks($name, $refresh = false)
{
return $this->getTableMetadata($name, 'checks', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getTableDefaultValues()
获取指定表的默认值约束信息。
public yii\db\DefaultValueConstraint[] getTableDefaultValues ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\DefaultValueConstraint[] |
表默认值约束。 |
---|
public function getTableDefaultValues($name, $refresh = false)
{
return $this->getTableMetadata($name, 'defaultValues', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getTableForeignKeys()
获取指定表的外部键信息。
public yii\db\ForeignKeyConstraint[] getTableForeignKeys ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\ForeignKeyConstraint[] |
表外键。 |
---|
public function getTableForeignKeys($name, $refresh = false)
{
return $this->getTableMetadata($name, 'foreignKeys', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getTableIndexes()
获取指定表的索引信息。
public yii\db\IndexConstraint[] getTableIndexes ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\IndexConstraint[] |
表索引。 |
---|
public function getTableIndexes($name, $refresh = false)
{
return $this->getTableMetadata($name, 'indexes', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getTableMetadata()
返回给定表的给定类型的元数据。
protected abstract mixed getTableMetadata ( $name, $type, $refresh ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$type | string |
元数据类型。 |
$refresh | boolean |
是否即使在缓存中找到表元数据也要重新加载。 |
返回值 | mixed |
元数据。 |
---|
abstract protected function getTableMetadata($name, $type, $refresh);
定义于: yii\db\Schema::getTableNameParts()
将完整的表名拆分为部分
protected array getTableNameParts ( $name ) | ||
$name | string |
protected function getTableNameParts($name)
{
return explode('.', $name);
}
定义于: yii\db\Schema::getTableNames()
返回数据库中所有表名。
public string[] getTableNames ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。如果不为空,则返回的表名将以模式名称为前缀。 |
$refresh | boolean |
是否获取最新的可用表名。如果为 false,则返回之前获取的表名(如果有)。 |
返回值 | string[] |
数据库中所有表名。 |
---|
public function getTableNames($schema = '', $refresh = false)
{
if (!isset($this->_tableNames[$schema]) || $refresh) {
$this->_tableNames[$schema] = $this->findTableNames($schema);
}
return $this->_tableNames[$schema];
}
定义于: yii\db\ConstraintFinderTrait::getTablePrimaryKey()
获取指定表的主键。
public yii\db\Constraint|null getTablePrimaryKey ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\Constraint|null |
表主键,如果表没有主键,则为 |
---|
public function getTablePrimaryKey($name, $refresh = false)
{
return $this->getTableMetadata($name, 'primaryKey', $refresh);
}
定义于: yii\db\Schema::getTableSchema()
获取指定表的元数据。
public yii\db\TableSchema|null getTableSchema ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到表模式也要重新加载。 |
返回值 | yii\db\TableSchema|null |
表元数据。如果命名表不存在,则为 |
---|
public function getTableSchema($name, $refresh = false)
{
return $this->getTableMetadata($name, 'schema', $refresh);
}
定义于: yii\db\Schema::getTableSchemas()
返回数据库中所有表的元数据。
public yii\db\TableSchema[] getTableSchemas ( $schema = '', $refresh = false ) | ||
$schema | string |
表的模式。默认为空字符串,表示当前或默认模式名称。 |
$refresh | boolean |
是否获取最新可用的表模式。如果为 |
返回值 | yii\db\TableSchema[] |
数据库中所有表的元数据。每个数组元素都是 yii\db\TableSchema 或其子类的实例。 |
---|
public function getTableSchemas($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'schema', $refresh);
}
定义于: yii\db\ConstraintFinderTrait::getTableUniques()
获取指定表的唯一约束信息。
public yii\db\Constraint[] getTableUniques ( $name, $refresh = false ) | ||
$name | string |
表名。表名可能包含模式名称(如果有)。不要引用表名。 |
$refresh | boolean |
是否即使在缓存中找到信息也要重新加载信息。 |
返回值 | yii\db\Constraint[] |
表唯一约束。 |
---|
public function getTableUniques($name, $refresh = false)
{
return $this->getTableMetadata($name, 'uniques', $refresh);
}
定义于: yii\base\BaseObject::hasMethod()
返回一个值,指示方法是否已定义。
默认实现是调用 php 函数 method_exists()
。当您实现 php 魔术方法 __call()
时,您可以覆盖此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名 |
返回值 | boolean |
该方法是否已定义 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定义于: yii\base\BaseObject::hasProperty()
返回一个值,指示属性是否已定义。
如果属性被定义,则
- 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 该类具有与指定名称相同的成员变量(当
$checkVars
为真时);
另见
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否被定义 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
执行 INSERT 命令,返回主键值。
public array|false insert ( $table, $columns ) | ||
$table | string |
新行将被插入的表。 |
$columns | array |
要插入表中的列数据(名称 => 值)。 |
返回值 | array|false |
主键值或 false(如果命令失败) |
---|
public function insert($table, $columns)
{
$command = $this->db->createCommand()->insert($table, $columns);
if (!$command->execute()) {
return false;
}
$tableSchema = $this->getTableSchema($table);
$result = [];
foreach ($tableSchema->primaryKey as $name) {
if ($tableSchema->columns[$name]->autoIncrement) {
$result[$name] = $this->getLastInsertID($tableSchema->sequenceName);
break;
}
$result[$name] = isset($columns[$name]) ? $columns[$name] : $tableSchema->columns[$name]->defaultValue;
}
return $result;
}
定义于: yii\db\Schema::isReadQuery()
返回一个值,指示 SQL 语句是否用于读取目的。
public boolean isReadQuery ( $sql ) | ||
$sql | string |
SQL 语句 |
返回值 | boolean |
SQL 语句是否用于读取目的。 |
---|
public function isReadQuery($sql)
{
$pattern = '/^\s*(SELECT|SHOW|DESCRIBE)\b/i';
return preg_match($pattern, $sql) > 0;
}
将列信息加载到 yii\db\ColumnSchema 对象中。
protected yii\db\ColumnSchema loadColumnSchema ( $info ) | ||
$info | array |
列信息 |
返回值 | yii\db\ColumnSchema |
列模式对象 |
---|
protected function loadColumnSchema($info)
{
$column = $this->createColumnSchema();
$column->name = $info['name'];
$column->allowNull = !$info['notnull'];
$column->isPrimaryKey = $info['pk'] != 0;
$column->dbType = strtolower($info['type']);
$column->unsigned = strpos($column->dbType, 'unsigned') !== false;
$column->type = self::TYPE_STRING;
if (preg_match('/^(\w+)(?:\(([^\)]+)\))?/', $column->dbType, $matches)) {
$type = strtolower($matches[1]);
if (isset($this->typeMap[$type])) {
$column->type = $this->typeMap[$type];
}
if (!empty($matches[2])) {
$values = explode(',', $matches[2]);
$column->size = $column->precision = (int) $values[0];
if (isset($values[1])) {
$column->scale = (int) $values[1];
}
if ($column->size === 1 && ($type === 'tinyint' || $type === 'bit')) {
$column->type = 'boolean';
} elseif ($type === 'bit') {
if ($column->size > 32) {
$column->type = 'bigint';
} elseif ($column->size === 32) {
$column->type = 'integer';
}
}
}
}
$column->phpType = $this->getColumnPhpType($column);
if (!$column->isPrimaryKey) {
if ($info['dflt_value'] === 'null' || $info['dflt_value'] === '' || $info['dflt_value'] === null) {
$column->defaultValue = null;
} elseif ($column->type === 'timestamp' && $info['dflt_value'] === 'CURRENT_TIMESTAMP') {
$column->defaultValue = new Expression('CURRENT_TIMESTAMP');
} else {
$value = trim($info['dflt_value'], "'\"");
$column->defaultValue = $column->phpTypecast($value);
}
}
return $column;
}
protected void loadTableChecks ( $tableName ) | ||
$tableName |
protected function loadTableChecks($tableName)
{
$sql = $this->db->createCommand('SELECT `sql` FROM `sqlite_master` WHERE name = :tableName', [
':tableName' => $tableName,
])->queryScalar();
/** @var $code SqlToken[]|SqlToken[][]|SqlToken[][][] */
$code = (new SqlTokenizer($sql))->tokenize();
$pattern = (new SqlTokenizer('any CREATE any TABLE any()'))->tokenize();
if (!$code[0]->matches($pattern, 0, $firstMatchIndex, $lastMatchIndex)) {
return [];
}
$createTableToken = $code[0][$lastMatchIndex - 1];
$result = [];
$offset = 0;
while (true) {
$pattern = (new SqlTokenizer('any CHECK()'))->tokenize();
if (!$createTableToken->matches($pattern, $offset, $firstMatchIndex, $offset)) {
break;
}
$checkSql = $createTableToken[$offset - 1]->getSql();
$name = null;
$pattern = (new SqlTokenizer('CONSTRAINT any'))->tokenize();
if (isset($createTableToken[$firstMatchIndex - 2]) && $createTableToken->matches($pattern, $firstMatchIndex - 2)) {
$name = $createTableToken[$firstMatchIndex - 1]->content;
}
$result[] = new CheckConstraint([
'name' => $name,
'expression' => $checkSql,
]);
}
return $result;
}
protected void loadTableDefaultValues ( $tableName ) | ||
$tableName | ||
抛出 | yii\base\NotSupportedException |
如果调用此方法。 |
---|
protected function loadTableDefaultValues($tableName)
{
throw new NotSupportedException('SQLite does not support default value constraints.');
}
protected void loadTableForeignKeys ( $tableName ) | ||
$tableName |
protected function loadTableForeignKeys($tableName)
{
$foreignKeys = $this->db->createCommand('PRAGMA FOREIGN_KEY_LIST (' . $this->quoteValue($tableName) . ')')->queryAll();
$foreignKeys = $this->normalizePdoRowKeyCase($foreignKeys, true);
$foreignKeys = ArrayHelper::index($foreignKeys, null, 'table');
ArrayHelper::multisort($foreignKeys, 'seq', SORT_ASC, SORT_NUMERIC);
$result = [];
foreach ($foreignKeys as $table => $foreignKey) {
$result[] = new ForeignKeyConstraint([
'columnNames' => ArrayHelper::getColumn($foreignKey, 'from'),
'foreignTableName' => $table,
'foreignColumnNames' => ArrayHelper::getColumn($foreignKey, 'to'),
'onDelete' => isset($foreignKey[0]['on_delete']) ? $foreignKey[0]['on_delete'] : null,
'onUpdate' => isset($foreignKey[0]['on_update']) ? $foreignKey[0]['on_update'] : null,
]);
}
return $result;
}
protected void loadTableIndexes ( $tableName ) | ||
$tableName |
protected function loadTableIndexes($tableName)
{
return $this->loadTableConstraints($tableName, 'indexes');
}
protected void loadTablePrimaryKey ( $tableName ) | ||
$tableName |
protected function loadTablePrimaryKey($tableName)
{
return $this->loadTableConstraints($tableName, 'primaryKey');
}
加载指定表的元数据。
protected yii\db\TableSchema|null loadTableSchema ( $name ) | ||
$name | string |
表名称 |
返回值 | yii\db\TableSchema|null |
依赖于 DBMS 的表元数据,如果表不存在,则为 |
---|
protected function loadTableSchema($name)
{
$table = new TableSchema();
$table->name = $name;
$table->fullName = $name;
if ($this->findColumns($table)) {
$this->findConstraints($table);
return $table;
}
return null;
}
protected void loadTableUniques ( $tableName ) | ||
$tableName |
protected function loadTableUniques($tableName)
{
return $this->loadTableConstraints($tableName, 'uniques');
}
定义于: yii\db\Schema::normalizePdoRowKeyCase()
如果 PDO 的键名是大写,则将行数组键名更改为小写。
protected array normalizePdoRowKeyCase ( array $row, $multiple ) | ||
$row | array |
行的数组或行的数组的数组。 |
$multiple | boolean |
是否传递了多行或单行。 |
返回值 | array |
规范化的行或行。 |
---|
protected function normalizePdoRowKeyCase(array $row, $multiple)
{
if ($this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_CASE) !== \PDO::CASE_UPPER) {
return $row;
}
if ($multiple) {
return array_map(function (array $row) {
return array_change_key_case($row, CASE_LOWER);
}, $row);
}
return array_change_key_case($row, CASE_LOWER);
}
定义于: yii\db\Schema::quoteColumnName()
引用查询中使用的列名。
如果列名包含前缀,则前缀也会被正确引用。如果列名已引用或包含 '(', '[[' 或 '{{',则此方法将不做任何事情。
public string quoteColumnName ( $name ) | ||
$name | string |
列名 |
返回值 | string |
正确引用的列名 |
---|
public function quoteColumnName($name)
{
if (strpos($name, '(') !== false || strpos($name, '[[') !== false) {
return $name;
}
if (($pos = strrpos($name, '.')) !== false) {
$prefix = $this->quoteTableName(substr($name, 0, $pos)) . '.';
$name = substr($name, $pos + 1);
} else {
$prefix = '';
}
if (strpos($name, '{{') !== false) {
return $name;
}
return $prefix . $this->quoteSimpleColumnName($name);
}
定义于: yii\db\Schema::quoteSimpleColumnName()
引用查询中使用的简单列名。
一个简单的列名应该只包含列名,不包含任何前缀。如果列名已被引用或为星号 '*',则此方法不会执行任何操作。
public string quoteSimpleColumnName ( $name ) | ||
$name | string |
列名 |
返回值 | string |
正确引用的列名 |
---|
public function quoteSimpleColumnName($name)
{
if (is_string($this->columnQuoteCharacter)) {
$startingCharacter = $endingCharacter = $this->columnQuoteCharacter;
} else {
list($startingCharacter, $endingCharacter) = $this->columnQuoteCharacter;
}
return $name === '*' || strpos($name, $startingCharacter) !== false ? $name : $startingCharacter . $name . $endingCharacter;
}
定义在: yii\db\Schema::quoteSimpleTableName()
引用查询中使用的简单表名。
一个简单的表名应该只包含表名,不包含任何模式前缀。如果表名已被引用,则此方法不会执行任何操作。
public string quoteSimpleTableName ( $name ) | ||
$name | string |
表名称 |
返回值 | string |
正确引用的表名 |
---|
public function quoteSimpleTableName($name)
{
if (is_string($this->tableQuoteCharacter)) {
$startingCharacter = $endingCharacter = $this->tableQuoteCharacter;
} else {
list($startingCharacter, $endingCharacter) = $this->tableQuoteCharacter;
}
return strpos($name, $startingCharacter) !== false ? $name : $startingCharacter . $name . $endingCharacter;
}
定义在: yii\db\Schema::quoteTableName()
引用查询中使用的表名。
如果表名包含模式前缀,则前缀也将被正确引用。如果表名已被引用或包含 '(' 或 '{{',则此方法不会执行任何操作。
另请参阅 quoteSimpleTableName().
public string quoteTableName ( $name ) | ||
$name | string |
表名称 |
返回值 | string |
正确引用的表名 |
---|
public function quoteTableName($name)
{
if (strncmp($name, '(', 1) === 0 && strpos($name, ')') === strlen($name) - 1) {
return $name;
}
if (strpos($name, '{{') !== false) {
return $name;
}
if (strpos($name, '.') === false) {
return $this->quoteSimpleTableName($name);
}
$parts = $this->getTableNameParts($name);
foreach ($parts as $i => $part) {
$parts[$i] = $this->quoteSimpleTableName($part);
}
return implode('.', $parts);
}
public string quoteValue ( $str ) | ||
$str | string |
要引用的字符串 |
返回值 | string |
正确引用的字符串 |
---|
public function quoteValue($str)
{
if (!is_string($str)) {
return $str;
}
if (mb_stripos((string)$this->db->dsn, 'odbc:') === false && ($value = $this->db->getSlavePdo(true)->quote($str)) !== false) {
return $value;
}
// the driver doesn't support quote (e.g. oci)
return "'" . addcslashes(str_replace("'", "''", $str), "\000\n\r\\\032") . "'";
}
public void refresh ( ) |
public function refresh()
{
/* @var $cache CacheInterface */
$cache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
if ($this->db->enableSchemaCache && $cache instanceof CacheInterface) {
TagDependency::invalidate($cache, $this->getCacheTag());
}
$this->_tableNames = [];
$this->_tableMetadata = [];
}
public void refreshTableSchema ( $name ) | ||
$name | string |
表名。 |
public function refreshTableSchema($name)
{
$rawName = $this->getRawTableName($name);
unset($this->_tableMetadata[$rawName]);
$this->_tableNames = [];
/* @var $cache CacheInterface */
$cache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
if ($this->db->enableSchemaCache && $cache instanceof CacheInterface) {
$cache->delete($this->getCacheKey($rawName));
}
}
定义在: yii\db\Schema::releaseSavepoint()
释放现有保存点。
public void releaseSavepoint ( $name ) | ||
$name | string |
保存点的名称 |
public function releaseSavepoint($name)
{
$this->db->createCommand("RELEASE SAVEPOINT $name")->execute();
}
定义在: yii\db\Schema::resolveTableName()
解析表名和模式名(如果有)。
protected yii\db\TableSchema resolveTableName ( $name ) | ||
$name | string |
表名 |
返回值 | yii\db\TableSchema |
yii\db\TableSchema,包含解析后的表名、模式名等。 |
---|---|---|
抛出 | yii\base\NotSupportedException |
如果此方法不受DBMS支持。 |
protected function resolveTableName($name)
{
throw new NotSupportedException(get_class($this) . ' does not support resolving table names.');
}
定义在: yii\db\Schema::rollBackSavepoint()
回滚到先前创建的保存点。
public void rollBackSavepoint ( $name ) | ||
$name | string |
保存点的名称 |
public function rollBackSavepoint($name)
{
$this->db->createCommand("ROLLBACK TO SAVEPOINT $name")->execute();
}
定义在: yii\db\Schema::setTableMetadata()
设置给定表中给定类型的元数据。
protected void setTableMetadata ( $name, $type, $data ) | ||
$name | string |
表名。 |
$type | string |
元数据类型。 |
$data | mixed |
元数据。 |
protected function setTableMetadata($name, $type, $data)
{
$this->_tableMetadata[$this->getRawTableName($name)][$type] = $data;
}
设置当前事务的隔离级别。
另请参阅 https://www.sqlite.org/pragma.html#pragma_read_uncommitted.
public void setTransactionIsolationLevel ( $level ) | ||
$level | string |
此事务要使用的隔离级别。可以是 yii\db\Transaction::READ_UNCOMMITTED 或 yii\db\Transaction::SERIALIZABLE。 |
抛出 | yii\base\NotSupportedException |
当使用不支持的隔离级别时。SQLite 仅支持 SERIALIZABLE 和 READ UNCOMMITTED。 |
---|
public function setTransactionIsolationLevel($level)
{
switch ($level) {
case Transaction::SERIALIZABLE:
$this->db->createCommand('PRAGMA read_uncommitted = False;')->execute();
break;
case Transaction::READ_UNCOMMITTED:
$this->db->createCommand('PRAGMA read_uncommitted = True;')->execute();
break;
default:
throw new NotSupportedException(get_class($this) . ' only supports transaction isolation levels READ UNCOMMITTED and SERIALIZABLE.');
}
}
public boolean supportsSavepoint ( ) | ||
返回值 | boolean |
此 DBMS 是否支持 保存点. |
---|
public function supportsSavepoint()
{
return $this->db->enableSavepoint;
}
定义在: yii\db\Schema::unquoteSimpleColumnName()
取消引用简单列名。
一个简单的列名应该只包含列名,不包含任何前缀。如果列名未被引用或为星号 '*',则此方法不会执行任何操作。
public string unquoteSimpleColumnName ( $name ) | ||
$name | string |
列名。 |
返回值 | string |
未引用的列名。 |
---|
public function unquoteSimpleColumnName($name)
{
if (is_string($this->columnQuoteCharacter)) {
$startingCharacter = $this->columnQuoteCharacter;
} else {
$startingCharacter = $this->columnQuoteCharacter[0];
}
return strpos($name, $startingCharacter) === false ? $name : substr($name, 1, -1);
}
定义于: yii\db\Schema::unquoteSimpleTableName()
取消引用简单表名。
一个简单的表名应该只包含表名,不包含任何模式前缀。如果表名没有引号,此方法将不做任何操作。
public string unquoteSimpleTableName ( $name ) | ||
$name | string |
表名。 |
返回值 | string |
未引用的表名。 |
---|
public function unquoteSimpleTableName($name)
{
if (is_string($this->tableQuoteCharacter)) {
$startingCharacter = $this->tableQuoteCharacter;
} else {
$startingCharacter = $this->tableQuoteCharacter[0];
}
return strpos($name, $startingCharacter) === false ? $name : substr($name, 1, -1);
}
注册 或 登录 发表评论。