0 关注者

类 yii\db\oci\Schema

继承yii\db\oci\Schema » yii\db\Schema » yii\base\BaseObject
实现yii\base\Configurable, yii\db\ConstraintFinderInterface
使用 Traitsyii\db\ConstraintFinderTrait
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/oci/Schema.php

Schema 是用于从 Oracle 数据库检索元数据的类。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$columnQuoteCharacter string|string[] 用于引用列名的字符。 yii\db\Schema
$columnSchemaClass string|array 列模式类或类配置 yii\db\Schema
$db yii\db\Connection 数据库连接 yii\db\Schema
$defaultSchema string 当前会话使用的默认模式名称。 yii\db\Schema
$exceptionMap array DB 错误与对应异常的映射 如果在 DB 错误消息中找到左侧部分,则使用右侧部分的异常类。 yii\db\oci\Schema
$lastInsertID string 插入的最后一行行 ID,或从序列对象检索的最后值。 yii\db\oci\Schema
$queryBuilder yii\db\QueryBuilder 此连接的查询构建器。 yii\db\Schema
$schemaChecks \yii\db\CheckConstraint[][] 数据库中所有表的检查约束。 yii\db\ConstraintFinderTrait
$schemaDefaultValues yii\db\DefaultValueConstraint[] 数据库中所有表的默认值约束。 yii\db\ConstraintFinderTrait
$schemaForeignKeys \yii\db\ForeignKeyConstraint[][] 数据库中所有表的外部键。 yii\db\ConstraintFinderTrait
$schemaIndexes \yii\db\IndexConstraint[][] 数据库中所有表的索引。 yii\db\ConstraintFinderTrait
$schemaNames string[] 数据库中的所有模式名称,除了系统模式。 yii\db\Schema
$schemaPrimaryKeys yii\db\Constraint[] 数据库中所有表的主键。 yii\db\ConstraintFinderTrait
$schemaUniques \yii\db\IndexConstraint[][] 数据库中所有表的唯一约束。 yii\db\ConstraintFinderTrait
$serverVersion string 服务器版本作为字符串。 yii\db\Schema
$tableNames string[] 数据库中的所有表名。 yii\db\Schema
$tableQuoteCharacter string|string[] 用于引用模式、表等的字符。 yii\db\oci\Schema
$tableSchemas yii\db\TableSchema[] 数据库中所有表的元数据。 yii\db\Schema
$transactionIsolationLevel string 此事务要使用的事务隔离级别。 yii\db\Schema

受保护的属性

隐藏继承的属性

属性 类型 描述 定义于

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置,即定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
convertException() 尽可能将 DB 异常转换为更具体的异常。 yii\db\Schema
createColumnSchemaBuilder() 创建列模式构建器实例,提供类型和值精度。 yii\db\oci\Schema
createQueryBuilder() 为数据库创建查询构建器。 yii\db\oci\Schema
createSavepoint() 创建一个新的保存点。 yii\db\Schema
findUniqueIndexes() 返回给定表的所以唯一索引。 yii\db\oci\Schema
getLastInsertID() yii\db\oci\Schema
getPdoType() 确定给定 PHP 数据值的 PDO 类型。 yii\db\Schema
getQueryBuilder() yii\db\Schema
getRawTableName() 返回给定表名的实际名称。 yii\db\Schema
getSchemaChecks() 返回数据库中所有表的检查约束。 yii\db\ConstraintFinderTrait
getSchemaDefaultValues() 返回数据库中所有表的默认值约束。 yii\db\ConstraintFinderTrait
getSchemaForeignKeys() 返回数据库中所有表的外部键。 yii\db\ConstraintFinderTrait
getSchemaIndexes() 返回数据库中所有表的索引。 yii\db\ConstraintFinderTrait
getSchemaNames() 返回数据库中的所有模式名称,除了系统模式。 yii\db\Schema
getSchemaPrimaryKeys() 返回数据库中所有表的主键。 yii\db\ConstraintFinderTrait
getSchemaUniques() 返回数据库中所有表的唯一约束。 yii\db\ConstraintFinderTrait
getServerVersion() 返回一个服务器版本作为字符串,可通过 \version_compare() 进行比较。 yii\db\Schema
getTableChecks() 获取命名表的检查约束信息。 yii\db\ConstraintFinderTrait
getTableDefaultValues() 获取命名表的默认值约束信息。 yii\db\ConstraintFinderTrait
getTableForeignKeys() 获取命名表的外部键信息。 yii\db\ConstraintFinderTrait
getTableIndexes() 获取命名表的索引信息。 yii\db\ConstraintFinderTrait
getTableNames() 返回数据库中的所有表名。 yii\db\Schema
getTablePrimaryKey() 获取命名表的主键。 yii\db\ConstraintFinderTrait
getTableSchema() 获取命名表的元数据。 yii\db\Schema
getTableSchemas() 返回数据库中所有表的元数据。 yii\db\Schema
getTableUniques() 获取命名表的唯一约束信息。 yii\db\ConstraintFinderTrait
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\BaseObject
hasProperty() 返回一个值,指示是否定义了属性。 yii\base\BaseObject
init() 初始化对象。 yii\db\oci\Schema
insert() 执行 INSERT 命令,返回主键值。 yii\db\oci\Schema
isReadQuery() 返回一个值,指示 SQL 语句是否用于读取目的。 yii\db\Schema
quoteColumnName() 引用查询中使用的列名。 yii\db\Schema
quoteSimpleColumnName() 引用查询中使用的简单列名。 yii\db\Schema
quoteSimpleTableName() 引用查询中使用的简单表名。 yii\db\oci\Schema
quoteTableName() 引用查询中使用的表名。 yii\db\Schema
quoteValue() 引用查询中使用的字符串值。 yii\db\Schema
refresh() 刷新模式。 yii\db\Schema
refreshTableSchema() 刷新特定表模式。 yii\db\Schema
releaseSavepoint() 释放现有的保存点。 yii\db\oci\Schema
rollBackSavepoint() 回滚到之前创建的保存点。 yii\db\Schema
setTransactionIsolationLevel() 设置当前事务的隔离级别。 yii\db\Schema
supportsSavepoint() yii\db\Schema
unquoteSimpleColumnName() 取消引用简单列名。 yii\db\Schema
unquoteSimpleTableName() 取消引用简单表名。 yii\db\Schema

受保护的方法

隐藏继承的方法

方法 描述 定义于
createColumn() 创建 ColumnSchema 实例。 yii\db\oci\Schema
createColumnSchema() 为数据库创建列模式。 yii\db\Schema
extractColumnSize() 从列的 DB 类型中提取大小、精度和比例信息。 yii\db\oci\Schema
extractColumnType() 提取给定列的数据类型。 yii\db\oci\Schema
findColumns() 收集表列元数据。 yii\db\oci\Schema
findConstraints() 查找约束并将它们填充到传递的 TableSchema 对象中。 yii\db\oci\Schema
findSchemaNames() 返回数据库中的所有模式名称,包括默认模式,但不包括系统模式。 yii\db\oci\Schema
findTableNames() 返回数据库中的所有表名。 yii\db\oci\Schema
getCacheKey() 返回指定表名的缓存键。 yii\db\Schema
getCacheTag() 返回缓存标签名称。 yii\db\Schema
getColumnPhpType() 从抽象数据库类型中提取 PHP 类型。 yii\db\Schema
getSchemaMetadata() 返回给定类型的所有表在给定模式中的元数据。 yii\db\ConstraintFinderTrait
getTableMetadata() 返回给定类型在给定表的元数据。 yii\db\ConstraintFinderTrait
getTableNameParts() 将完整表名称拆分为多个部分。 yii\db\Schema
loadTableChecks() yii\db\oci\Schema
loadTableDefaultValues() yii\db\oci\Schema
loadTableForeignKeys() yii\db\oci\Schema
loadTableIndexes() yii\db\oci\Schema
loadTablePrimaryKey() yii\db\oci\Schema
loadTableSchema() 加载指定表的元数据。 yii\db\oci\Schema
loadTableUniques() yii\db\oci\Schema
normalizePdoRowKeyCase() 如果 PDO 的键大小写设置为大写,则将行数组键大小写更改为小写。 yii\db\Schema
resolveTableName() 解析表名和模式名(如果有)。 yii\db\oci\Schema
resolveTableNames() 解析表名和模式名(如果有)。 yii\db\oci\Schema
setTableMetadata() 设置给定类型在给定表的元数据。 yii\db\Schema

常量

隐藏继承的常量

常量 描述 定义于
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

属性详情

隐藏继承的属性

$exceptionMap 公共属性

DB 错误与对应异常的映射 如果在 DB 错误消息中找到左侧部分,则使用右侧部分的异常类。

public array $exceptionMap = [
    
'ORA-00001: unique constraint' => 'yii\db\IntegrityException',
]
$lastInsertID 公共属性

插入的最后一行行 ID,或从序列对象检索的最后值。

public string $lastInsertID null
$tableQuoteCharacter 受保护属性 (available since version 2.0.14)

用于引用模式、表等名称的字符。如果开始字符和结束字符不同,则可以使用包含 2 个字符的数组。

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

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()");
}

            
__construct() 公共方法

定义于: 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();
}

            
__get() 公共方法

定义于: 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);
}

            
__isset() 公共方法

定义于: yii\base\BaseObject::__isset()

检查属性是否已设置,即定义且不为空。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($object->property) 时会隐式调用。

注意,如果属性未定义,则将返回 false。

另请参见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

命名的属性是否设置(非 null)。

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}

            
__set() 公共方法

定义于: 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);
    }
}

            
__unset() 公共方法

定义于: yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 unset($object->property) 时会隐式调用。

注意,如果属性未定义,则此方法将不执行任何操作。如果属性是只读属性,则将抛出异常。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

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);
    }
}

            
canGetProperty() 公共方法

定义于: yii\base\BaseObject::canGetProperty()

返回一个值,指示是否可以读取属性。

一个属性是可读的,如果

  • 类有一个与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);

另请参阅 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);
}

            
canSetProperty() 公共方法

定义于: yii\base\BaseObject::canSetProperty()

返回一个值,指示是否可以设置属性。

一个属性是可写的,如果

  • 类有一个与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);

另请参阅 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);
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 中,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
convertException() 公共方法

定义于: yii\db\Schema::convertException()

尽可能将 DB 异常转换为更具体的异常。

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);
}

            
createColumn() 受保护方法

创建 ColumnSchema 实例。

protected yii\db\ColumnSchema createColumn ( $column )
$column array

                protected function createColumn($column)
{
    $c = $this->createColumnSchema();
    $c->name = $column['COLUMN_NAME'];
    $c->allowNull = $column['NULLABLE'] === 'Y';
    $c->comment = $column['COLUMN_COMMENT'] === null ? '' : $column['COLUMN_COMMENT'];
    $c->isPrimaryKey = false;
    $this->extractColumnType($c, $column['DATA_TYPE'], $column['DATA_PRECISION'], $column['DATA_SCALE'], $column['DATA_LENGTH']);
    $this->extractColumnSize($c, $column['DATA_TYPE'], $column['DATA_PRECISION'], $column['DATA_SCALE'], $column['DATA_LENGTH']);
    $c->phpType = $this->getColumnPhpType($c);
    if (!$c->isPrimaryKey) {
        if (stripos((string) $column['DATA_DEFAULT'], 'timestamp') !== false) {
            $c->defaultValue = null;
        } else {
            $defaultValue = (string) $column['DATA_DEFAULT'];
            if ($c->type === 'timestamp' && $defaultValue === 'CURRENT_TIMESTAMP') {
                $c->defaultValue = new Expression('CURRENT_TIMESTAMP');
            } else {
                if ($defaultValue !== null) {
                    if (
                        strlen($defaultValue) > 2
                        && strncmp($defaultValue, "'", 1) === 0
                        && substr($defaultValue, -1) === "'"
                    ) {
                        $defaultValue = substr($defaultValue, 1, -1);
                    } else {
                        $defaultValue = trim($defaultValue);
                    }
                }
                $c->defaultValue = $c->phpTypecast($defaultValue);
            }
        }
    }
    return $c;
}

            
createColumnSchema() 受保护方法

定义于: yii\db\Schema::createColumnSchema()

为数据库创建列模式。

子类可以重写此方法以创建特定于 DBMS 的列模式。

protected yii\db\ColumnSchema createColumnSchema ( )
返回值 yii\db\ColumnSchema

列模式实例。

抛出异常 yii\base\InvalidConfigException

如果无法创建列模式类。

                protected function createColumnSchema()
{
    return Yii::createObject($this->columnSchemaClass);
}

            
createColumnSchemaBuilder() 公共方法 (自版本 2.0.6 起可用)

创建列模式构建器实例,提供类型和值精度。

子类可以重写此方法以创建特定于 DBMS 的列模式构建器。

public yii\db\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length null )
$type string

列的类型。请参阅 yii\db\oci\ColumnSchemaBuilder::$type.

$length integer|string|array|null

列的长度或精度。请参阅 yii\db\oci\ColumnSchemaBuilder::$length.

返回值 yii\db\ColumnSchemaBuilder

列模式构建器实例

                public function createColumnSchemaBuilder($type, $length = null)
{
    return Yii::createObject(ColumnSchemaBuilder::className(), [$type, $length]);
}

            
createQueryBuilder() 公共方法

为数据库创建查询构建器。

子类可以重写此方法以创建特定于 DBMS 的查询构建器。

public yii\db\QueryBuilder createQueryBuilder ( )
返回值 yii\db\QueryBuilder

查询构建器实例

                public function createQueryBuilder()
{
    return Yii::createObject(QueryBuilder::className(), [$this->db]);
}

            
createSavepoint() 公共方法

定义于: yii\db\Schema::createSavepoint()

创建一个新的保存点。

public void createSavepoint ( $name )
$name string

保存点的名称

                public function createSavepoint($name)
{
    $this->db->createCommand("SAVEPOINT $name")->execute();
}

            
extractColumnSize() 受保护方法

从列的 DB 类型中提取大小、精度和比例信息。

protected void extractColumnSize ( $column, $dbType, $precision, $scale, $length )
$column yii\db\ColumnSchema
$dbType string

列的 DB 类型

$precision string

总共的位数。此参数自版本 2.0.4 起可用。

$scale string

小数点右侧的位数。此参数自版本 2.0.4 起可用。

$length string

字符类型的长度。此参数自版本 2.0.4 起可用。

                protected function extractColumnSize($column, $dbType, $precision, $scale, $length)
{
    $column->size = trim((string) $length) === '' ? null : (int) $length;
    $column->precision = trim((string) $precision) === '' ? null : (int) $precision;
    $column->scale = trim((string) $scale) === '' ? null : (int) $scale;
}

            
extractColumnType() 受保护方法

提取给定列的数据类型。

protected void extractColumnType ( $column, $dbType, $precision, $scale, $length )
$column yii\db\ColumnSchema
$dbType string

DB 类型

$precision string

总共的位数。此参数自版本 2.0.4 起可用。

$scale string

小数点右侧的位数。此参数自版本 2.0.4 起可用。

$length string

字符类型的长度。此参数自版本 2.0.4 起可用。

                protected function extractColumnType($column, $dbType, $precision, $scale, $length)
{
    $column->dbType = $dbType;
    if (strpos($dbType, 'FLOAT') !== false || strpos($dbType, 'DOUBLE') !== false) {
        $column->type = 'double';
    } elseif (strpos($dbType, 'NUMBER') !== false) {
        if ($scale === null || $scale > 0) {
            $column->type = 'decimal';
        } else {
            $column->type = 'integer';
        }
    } elseif (strpos($dbType, 'INTEGER') !== false) {
        $column->type = 'integer';
    } elseif (strpos($dbType, 'BLOB') !== false) {
        $column->type = 'binary';
    } elseif (strpos($dbType, 'CLOB') !== false) {
        $column->type = 'text';
    } elseif (strpos($dbType, 'TIMESTAMP') !== false) {
        $column->type = 'timestamp';
    } else {
        $column->type = 'string';
    }
}

            
findColumns() 受保护方法

收集表列元数据。

protected boolean findColumns ( $table )
$table yii\db\TableSchema

表模式

返回值 boolean

表是否存在

                protected function findColumns($table)
{
    $sql = <<<'SQL'
CT
A.COLUMN_NAME,
A.DATA_TYPE,
A.DATA_PRECISION,
A.DATA_SCALE,
(
  CASE A.CHAR_USED WHEN 'C' THEN A.CHAR_LENGTH
    ELSE A.DATA_LENGTH
  END
) AS DATA_LENGTH,
A.NULLABLE,
A.DATA_DEFAULT,
COM.COMMENTS AS COLUMN_COMMENT
 ALL_TAB_COLUMNS A
INNER JOIN ALL_OBJECTS B ON B.OWNER = A.OWNER AND LTRIM(B.OBJECT_NAME) = LTRIM(A.TABLE_NAME)
LEFT JOIN ALL_COL_COMMENTS COM ON (A.OWNER = COM.OWNER AND A.TABLE_NAME = COM.TABLE_NAME AND A.COLUMN_NAME = COM.COLUMN_NAME)
E
A.OWNER = :schemaName
AND B.OBJECT_TYPE IN ('TABLE', 'VIEW', 'MATERIALIZED VIEW')
AND B.OBJECT_NAME = :tableName
R BY A.COLUMN_ID

    try {
        $columns = $this->db->createCommand($sql, [
            ':tableName' => $table->name,
            ':schemaName' => $table->schemaName,
        ])->queryAll();
    } catch (\Exception $e) {
        return false;
    }
    if (empty($columns)) {
        return false;
    }
    foreach ($columns as $column) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $column = array_change_key_case($column, CASE_UPPER);
        }
        $c = $this->createColumn($column);
        $table->columns[$c->name] = $c;
    }
    return true;
}

            
findConstraints() 受保护方法

查找约束并将它们填充到传递的 TableSchema 对象中。

protected void findConstraints ( $table )
$table yii\db\TableSchema

                protected function findConstraints($table)
{
    $sql = <<<'SQL'
CT
/*+ PUSH_PRED(C) PUSH_PRED(D) PUSH_PRED(E) */
D.CONSTRAINT_NAME,
D.CONSTRAINT_TYPE,
C.COLUMN_NAME,
C.POSITION,
D.R_CONSTRAINT_NAME,
E.TABLE_NAME AS TABLE_REF,
F.COLUMN_NAME AS COLUMN_REF,
C.TABLE_NAME
 ALL_CONS_COLUMNS C
INNER JOIN ALL_CONSTRAINTS D ON D.OWNER = C.OWNER AND D.CONSTRAINT_NAME = C.CONSTRAINT_NAME
LEFT JOIN ALL_CONSTRAINTS E ON E.OWNER = D.R_OWNER AND E.CONSTRAINT_NAME = D.R_CONSTRAINT_NAME
LEFT JOIN ALL_CONS_COLUMNS F ON F.OWNER = E.OWNER AND F.CONSTRAINT_NAME = E.CONSTRAINT_NAME AND F.POSITION = C.POSITION
E
C.OWNER = :schemaName
AND C.TABLE_NAME = :tableName
R BY D.CONSTRAINT_NAME, C.POSITION

    $command = $this->db->createCommand($sql, [
        ':tableName' => $table->name,
        ':schemaName' => $table->schemaName,
    ]);
    $constraints = [];
    foreach ($command->queryAll() as $row) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $row = array_change_key_case($row, CASE_UPPER);
        }
        if ($row['CONSTRAINT_TYPE'] === 'P') {
            $table->columns[$row['COLUMN_NAME']]->isPrimaryKey = true;
            $table->primaryKey[] = $row['COLUMN_NAME'];
            if (empty($table->sequenceName)) {
                $table->sequenceName = $this->getTableSequenceName($table->name);
            }
        }
        if ($row['CONSTRAINT_TYPE'] !== 'R') {
            // this condition is not checked in SQL WHERE because of an Oracle Bug:
            // see https://github.com/yiisoft/yii2/pull/8844
            continue;
        }
        $name = $row['CONSTRAINT_NAME'];
        if (!isset($constraints[$name])) {
            $constraints[$name] = [
                'tableName' => $row['TABLE_REF'],
                'columns' => [],
            ];
        }
        $constraints[$name]['columns'][$row['COLUMN_NAME']] = $row['COLUMN_REF'];
    }
    foreach ($constraints as $constraint) {
        $name = current(array_keys($constraint));
        $table->foreignKeys[$name] = array_merge([$constraint['tableName']], $constraint['columns']);
    }
}

            
findSchemaNames() 受保护方法 (版本 2.0.4 起可用)

返回数据库中的所有模式名称,包括默认模式,但不包括系统模式。

为了支持此功能,子类应该重写此方法,因为默认实现只是抛出异常。

另请参见 https://docs.oracle.com/cd/B28359_01/server.111/b28337/tdpsg_user_accounts.htm

protected array findSchemaNames ( )
返回值 array

数据库中的所有模式名称,除了系统模式。

抛出异常 yii\base\NotSupportedException

如果此方法不受 DBMS 支持。

                protected function findSchemaNames()
{
    static $sql = <<<'SQL'
CT "u"."USERNAME"
 "DBA_USERS" "u"
E "u"."DEFAULT_TABLESPACE" NOT IN ('SYSTEM', 'SYSAUX')
R BY "u"."USERNAME" ASC

    return $this->db->createCommand($sql)->queryColumn();
}

            
findTableNames() 受保护方法

返回数据库中的所有表名。

为了支持此功能,子类应该重写此方法,因为默认实现只是抛出异常。

protected array findTableNames ( $schema '' )
$schema string

表的模式。默认为空字符串,表示当前或默认模式。

返回值 array

数据库中的所有表名。名称没有模式名前缀。

抛出异常 yii\base\NotSupportedException

如果此方法不受 DBMS 支持。

                protected function findTableNames($schema = '')
{
    if ($schema === '') {
        $sql = <<<'SQL'
CT
TABLE_NAME
 USER_TABLES
N ALL
CT
VIEW_NAME AS TABLE_NAME
 USER_VIEWS
N ALL
CT
MVIEW_NAME AS TABLE_NAME
 USER_MVIEWS
R BY TABLE_NAME

        $command = $this->db->createCommand($sql);
    } else {
        $sql = <<<'SQL'
CT
OBJECT_NAME AS TABLE_NAME
 ALL_OBJECTS
E
OBJECT_TYPE IN ('TABLE', 'VIEW', 'MATERIALIZED VIEW')
AND OWNER = :schema
R BY OBJECT_NAME

        $command = $this->db->createCommand($sql, [':schema' => $schema]);
    }
    $rows = $command->queryAll();
    $names = [];
    foreach ($rows as $row) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $row = array_change_key_case($row, CASE_UPPER);
        }
        $names[] = $row['TABLE_NAME'];
    }
    return $names;
}

            
findUniqueIndexes() 公共方法 (版本 2.0.4 起可用)

返回给定表的所以唯一索引。

每个数组元素的结构如下:.

[
    'IndexName1' => ['col1' [, ...]],
    'IndexName2' => ['col2' [, ...]],
]
public array findUniqueIndexes ( $table )
$table yii\db\TableSchema

表元数据

返回值 array

给定表的所有唯一索引。

                public function findUniqueIndexes($table)
{
    $query = <<<'SQL'
CT
DIC.INDEX_NAME,
DIC.COLUMN_NAME
 ALL_INDEXES DI
INNER JOIN ALL_IND_COLUMNS DIC ON DI.TABLE_NAME = DIC.TABLE_NAME AND DI.INDEX_NAME = DIC.INDEX_NAME
E
DI.UNIQUENESS = 'UNIQUE'
AND DIC.TABLE_OWNER = :schemaName
AND DIC.TABLE_NAME = :tableName
R BY DIC.TABLE_NAME, DIC.INDEX_NAME, DIC.COLUMN_POSITION

    $result = [];
    $command = $this->db->createCommand($query, [
        ':tableName' => $table->name,
        ':schemaName' => $table->schemaName,
    ]);
    foreach ($command->queryAll() as $row) {
        $result[$row['INDEX_NAME']][] = $row['COLUMN_NAME'];
    }
    return $result;
}

            
getCacheKey() 受保护方法

定义于: 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),
    ];
}

            
getCacheTag() 受保护方法

定义于: yii\db\Schema::getCacheTag()

返回缓存标签名称。

这允许 refresh() 使所有缓存的表架构失效。

protected string getCacheTag ( )
返回值 string

缓存标签名称

                protected function getCacheTag()
{
    return md5(serialize([
        __CLASS__,
        $this->db->dsn,
        $this->db->username,
    ]));
}

            
getColumnPhpType() 受保护方法

定义于: 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';
}

            
getLastInsertID() 公共方法

另请参见 https://php.ac.cn/manual/en/function.PDO-lastInsertId.php -> Oracle 不支持此功能 返回最后插入的行或序列值的 ID。

public string getLastInsertID ( $sequenceName '' )
$sequenceName string

序列对象的名称(某些 DBMS 需要)

返回值 string

最后插入行的行 ID 或从序列对象检索的最后一个值

抛出异常 yii\base\InvalidCallException

如果 DB 连接未激活

                public function getLastInsertID($sequenceName = '')
{
    if ($this->db->isActive) {
        // get the last insert id from the master connection
        $sequenceName = $this->quoteSimpleTableName($sequenceName);
        return $this->db->useMaster(function (Connection $db) use ($sequenceName) {
            return $db->createCommand("SELECT {$sequenceName}.CURRVAL FROM DUAL")->queryScalar();
        });
    } else {
        throw new InvalidCallException('DB Connection is not active.');
    }
}

            
getPdoType() 公共方法

定义于: yii\db\Schema::getPdoType()

确定给定 PHP 数据值的 PDO 类型。

另请参见 https://php.ac.cn/manual/en/pdo.constants.php

public integer getPdoType ( $data )
$data mixed

要确定其 PDO 类型的 data

返回值 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;
}

            
getQueryBuilder() 公共方法
public yii\db\QueryBuilder getQueryBuilder ( )
返回值 yii\db\QueryBuilder

此连接的查询构建器。

                public function getQueryBuilder()
{
    if ($this->_builder === null) {
        $this->_builder = $this->createQueryBuilder();
    }
    return $this->_builder;
}

            
getRawTableName() 公共方法

定义于: 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;
}

            
getSchemaChecks() 公共方法

定义于: 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);
}

            
getSchemaDefaultValues() 公共方法

定义于: 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);
}

            
getSchemaForeignKeys() public method

定义于: 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);
}

            
getSchemaIndexes() public method

定义于: 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);
}

            
getSchemaMetadata() protected abstract method

定义于: yii\db\ConstraintFinderTrait::getSchemaMetadata()

返回给定类型的所有表在给定模式中的元数据。

protected abstract array getSchemaMetadata ( $schema, $type, $refresh )
$schema string

元数据的模式。默认为空字符串,表示当前或默认模式名称。

$type string

元数据类型。

$refresh boolean

是否获取最新的可用表元数据。如果为 `false`,则在可用时返回缓存的数据。

返回值 array

元数据的数组。

                abstract protected function getSchemaMetadata($schema, $type, $refresh);

            
getSchemaNames() public method (available since version 2.0.4)

定义于: 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;
}

            
getSchemaPrimaryKeys() public method

定义于: yii\db\ConstraintFinderTrait::getSchemaPrimaryKeys()

返回数据库中所有表的主键。

public yii\db\Constraint[] getSchemaPrimaryKeys ( $schema '', $refresh false )
$schema string

表的模式。默认为空字符串,表示当前或默认模式名。

$refresh boolean

是否获取最新的可用表模式。如果为 `false`,则在可用时返回缓存的数据。

返回值 yii\db\Constraint[]

数据库中所有表的主键。每个数组元素都是 yii\db\Constraint 或其子类的实例。

                public function getSchemaPrimaryKeys($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'primaryKey', $refresh);
}

            
getSchemaUniques() public method

定义于: 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);
}

            
getServerVersion() public method (available since version 2.0.14)

定义于: 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;
}

            
getTableChecks() public method

定义于: 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);
}

            
getTableDefaultValues() public method

定义于: 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);
}

            
getTableForeignKeys() public method

定义于: 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);
}

            
getTableIndexes() public method

定义于: 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);
}

            
getTableMetadata() protected abstract method

定义于: 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);

            
getTableNameParts() protected method (available since version 2.0.22)

定义于: yii\db\Schema::getTableNameParts()

将完整表名称拆分为多个部分。

protected array getTableNameParts ( $name )
$name string

                protected function getTableNameParts($name)
{
    return explode('.', $name);
}

            
getTableNames() public method

定义于: 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];
}

            
getTablePrimaryKey() public method

定义于: yii\db\ConstraintFinderTrait::getTablePrimaryKey()

获取命名表的主键。

public yii\db\Constraint|null getTablePrimaryKey ( $name, $refresh false )
$name string

表名。表名可以包含模式名称(如果有)。不要引用表名。

$refresh boolean

是否即使在缓存中找到信息也要重新加载信息。

返回值 yii\db\Constraint|null

表主键,如果表没有主键,则为 null

                public function getTablePrimaryKey($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'primaryKey', $refresh);
}

            
getTableSchema() public method

定义于: yii\db\Schema::getTableSchema()

获取命名表的元数据。

public yii\db\TableSchema|null getTableSchema ( $name, $refresh false )
$name string

表名。表名可以包含模式名称(如果有)。不要引用表名。

$refresh boolean

是否即使在缓存中找到也要重新加载表模式。

返回值 yii\db\TableSchema|null

表元数据。如果指定的表不存在,则为 null

                public function getTableSchema($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'schema', $refresh);
}

            
getTableSchemas() public method

定义于: yii\db\Schema::getTableSchemas()

返回数据库中所有表的元数据。

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

表的模式。默认为空字符串,表示当前或默认模式名。

$refresh boolean

是否获取最新的可用表模式。如果为 `false`,则在可用时返回缓存的数据。

返回值 yii\db\TableSchema[]

数据库中所有表的元数据。每个数组元素都是 yii\db\TableSchema 或其子类的实例。

                public function getTableSchemas($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'schema', $refresh);
}

            
getTableUniques() public method

定义于: 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);
}

            
hasMethod() public method

定义于: 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);
}

            
hasProperty() public method

定义于: yii\base\BaseObject::hasProperty()

返回一个值,指示是否定义了属性。

属性定义如下:

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);

另请参见

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);
}

            
init() public method

初始化对象。

此方法在构造函数结束时调用,在对象使用给定配置初始化后调用。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->defaultSchema === null) {
        $username = $this->db->username;
        if (empty($username)) {
            $username = isset($this->db->masters[0]['username']) ? $this->db->masters[0]['username'] : '';
        }
        $this->defaultSchema = strtoupper($username);
    }
}

            
insert() public method (available since version 2.0.4)

执行 INSERT 命令,返回主键值。

public array|false insert ( $table, $columns )
$table string

将要插入新行的表。

$columns array

要插入表中的列数据(名称 => 值)。

返回值 array|false

主键值,如果命令失败则为 false

                public function insert($table, $columns)
{
    $params = [];
    $returnParams = [];
    $sql = $this->db->getQueryBuilder()->insert($table, $columns, $params);
    $tableSchema = $this->getTableSchema($table);
    $returnColumns = $tableSchema->primaryKey;
    if (!empty($returnColumns)) {
        $columnSchemas = $tableSchema->columns;
        $returning = [];
        foreach ((array) $returnColumns as $name) {
            $phName = QueryBuilder::PARAM_PREFIX . (count($params) + count($returnParams));
            $returnParams[$phName] = [
                'column' => $name,
                'value' => '',
            ];
            if (!isset($columnSchemas[$name]) || $columnSchemas[$name]->phpType !== 'integer') {
                $returnParams[$phName]['dataType'] = \PDO::PARAM_STR;
            } else {
                $returnParams[$phName]['dataType'] = \PDO::PARAM_INT;
            }
            $returnParams[$phName]['size'] = isset($columnSchemas[$name]->size) ? $columnSchemas[$name]->size : -1;
            $returning[] = $this->quoteColumnName($name);
        }
        $sql .= ' RETURNING ' . implode(', ', $returning) . ' INTO ' . implode(', ', array_keys($returnParams));
    }
    $command = $this->db->createCommand($sql, $params);
    $command->prepare(false);
    foreach ($returnParams as $name => &$value) {
        $command->pdoStatement->bindParam($name, $value['value'], $value['dataType'], $value['size']);
    }
    if (!$command->execute()) {
        return false;
    }
    $result = [];
    foreach ($returnParams as $value) {
        $result[$value['column']] = $value['value'];
    }
    return $result;
}

            
isReadQuery() 公共方法

定义于: 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;
}

            
loadTableChecks() 受保护方法

protected void loadTableChecks ( $tableName )
$tableName

                protected function loadTableChecks($tableName)
{
    return $this->loadTableConstraints($tableName, 'checks');
}

            
loadTableDefaultValues() 受保护方法

protected void loadTableDefaultValues ( $tableName )
$tableName
抛出异常 yii\base\NotSupportedException

如果调用此方法。

                protected function loadTableDefaultValues($tableName)
{
    throw new NotSupportedException('Oracle does not support default value constraints.');
}

            
loadTableForeignKeys() 受保护方法

protected void loadTableForeignKeys ( $tableName )
$tableName

                protected function loadTableForeignKeys($tableName)
{
    return $this->loadTableConstraints($tableName, 'foreignKeys');
}

            
loadTableIndexes() 受保护方法

protected void loadTableIndexes ( $tableName )
$tableName

                protected function loadTableIndexes($tableName)
{
    static $sql = <<<'SQL'
CT
/*+ PUSH_PRED("ui") PUSH_PRED("uicol") PUSH_PRED("uc") */
"ui"."INDEX_NAME" AS "name",
"uicol"."COLUMN_NAME" AS "column_name",
CASE "ui"."UNIQUENESS" WHEN 'UNIQUE' THEN 1 ELSE 0 END AS "index_is_unique",
CASE WHEN "uc"."CONSTRAINT_NAME" IS NOT NULL THEN 1 ELSE 0 END AS "index_is_primary"
 "SYS"."USER_INDEXES" "ui"
 JOIN "SYS"."USER_IND_COLUMNS" "uicol"
ON "uicol"."INDEX_NAME" = "ui"."INDEX_NAME"
 JOIN "SYS"."USER_CONSTRAINTS" "uc"
ON "uc"."OWNER" = "ui"."TABLE_OWNER" AND "uc"."CONSTRAINT_NAME" = "ui"."INDEX_NAME" AND "uc"."CONSTRAINT_TYPE" = 'P'
E "ui"."TABLE_OWNER" = :schemaName AND "ui"."TABLE_NAME" = :tableName
R BY "uicol"."COLUMN_POSITION" ASC

    $resolvedName = $this->resolveTableName($tableName);
    $indexes = $this->db->createCommand($sql, [
        ':schemaName' => $resolvedName->schemaName,
        ':tableName' => $resolvedName->name,
    ])->queryAll();
    $indexes = $this->normalizePdoRowKeyCase($indexes, true);
    $indexes = ArrayHelper::index($indexes, null, 'name');
    $result = [];
    foreach ($indexes as $name => $index) {
        $result[] = new IndexConstraint([
            'isPrimary' => (bool) $index[0]['index_is_primary'],
            'isUnique' => (bool) $index[0]['index_is_unique'],
            'name' => $name,
            'columnNames' => ArrayHelper::getColumn($index, 'column_name'),
        ]);
    }
    return $result;
}

            
loadTablePrimaryKey() 受保护方法

protected void loadTablePrimaryKey ( $tableName )
$tableName

                protected function loadTablePrimaryKey($tableName)
{
    return $this->loadTableConstraints($tableName, 'primaryKey');
}

            
loadTableSchema() 受保护方法

加载指定表的元数据。

protected yii\db\TableSchema|null loadTableSchema ( $name )
$name string

表名

返回值 yii\db\TableSchema|null

DBMS 相关的表元数据,如果表不存在,则为 null

                protected function loadTableSchema($name)
{
    $table = new TableSchema();
    $this->resolveTableNames($table, $name);
    if ($this->findColumns($table)) {
        $this->findConstraints($table);
        return $table;
    }
    return null;
}

            
loadTableUniques() 受保护方法

protected void loadTableUniques ( $tableName )
$tableName

                protected function loadTableUniques($tableName)
{
    return $this->loadTableConstraints($tableName, 'uniques');
}

            
normalizePdoRowKeyCase() 受保护方法 (自版本 2.0.13 起可用)

定义于: 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);
}

            
quoteColumnName() 公共方法

定义于: yii\db\Schema::quoteColumnName()

引用查询中使用的列名。

如果列名包含前缀,则前缀也会被正确地引用。如果列名已经被引用或包含 '(', '[[' 或 '{{',那么此方法将不做任何事。

另见 quoteSimpleColumnName()

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);
}

            
quoteSimpleColumnName() 公共方法

定义于: 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;
}

            
quoteSimpleTableName() 公共方法

引用查询中使用的简单表名。

一个简单的表名应该只包含表名,不包含任何模式前缀。如果表名已经被引用,那么此方法将不做任何事。

public string quoteSimpleTableName ( $name )
$name string

表名

返回值 string

正确引用的表名

                public function quoteSimpleTableName($name)
{
    return strpos($name, '"') !== false ? $name : '"' . $name . '"';
}

            
quoteTableName() 公共方法

定义于: 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);
}

            
quoteValue() 公共方法

定义于: yii\db\Schema::quoteValue()

引用查询中使用的字符串值。

注意,如果参数不是字符串,它将被原样返回。

另见 https://php.ac.cn/manual/en/function.PDO-quote.php.

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") . "'";
}

            
refresh() 公共方法

定义于: yii\db\Schema::refresh()

刷新模式。

此方法清理所有缓存的表模式,以便稍后重新创建它们以反映数据库模式更改。

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 = [];
}

            
refreshTableSchema() 公共方法 (自版本 2.0.6 可用)

定义于: yii\db\Schema::refreshTableSchema()

刷新特定表模式。

此方法清理缓存的表模式,以便稍后重新创建它们以反映数据库模式更改。

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));
    }
}

            
releaseSavepoint() 公共方法

释放现有的保存点。

public void releaseSavepoint ( $name )
$name string

保存点的名称

                public function releaseSavepoint($name)
{
    // does nothing as Oracle does not support this
}

            
resolveTableName() 受保护方法 (自版本 2.0.13 可用)

解析表名和模式名(如果有)。

protected yii\db\TableSchema resolveTableName ( $name )
$name string

表名

返回值 yii\db\TableSchema

yii\db\TableSchema,包含已解析的表、模式等名称。

抛出异常 yii\base\NotSupportedException

如果此方法不受 DBMS 支持。

                protected function resolveTableName($name)
{
    $resolvedName = new TableSchema();
    $parts = explode('.', str_replace('"', '', $name));
    if (isset($parts[1])) {
        $resolvedName->schemaName = $parts[0];
        $resolvedName->name = $parts[1];
    } else {
        $resolvedName->schemaName = $this->defaultSchema;
        $resolvedName->name = $name;
    }
    $resolvedName->fullName = ($resolvedName->schemaName !== $this->defaultSchema ? $resolvedName->schemaName . '.' : '') . $resolvedName->name;
    return $resolvedName;
}

            
resolveTableNames() 受保护方法

解析表名和模式名(如果有)。

protected void resolveTableNames ( $table, $name )
$table yii\db\TableSchema

表元数据对象

$name string

表名

                protected function resolveTableNames($table, $name)
{
    $parts = explode('.', str_replace('"', '', $name));
    if (isset($parts[1])) {
        $table->schemaName = $parts[0];
        $table->name = $parts[1];
    } else {
        $table->schemaName = $this->defaultSchema;
        $table->name = $name;
    }
    $table->fullName = $table->schemaName !== $this->defaultSchema ? $table->schemaName . '.' . $table->name : $table->name;
}

            
rollBackSavepoint() 公共方法

定义于: yii\db\Schema::rollBackSavepoint()

回滚到之前创建的保存点。

public void rollBackSavepoint ( $name )
$name string

保存点的名称

                public function rollBackSavepoint($name)
{
    $this->db->createCommand("ROLLBACK TO SAVEPOINT $name")->execute();
}

            
setTableMetadata() 受保护方法 (自版本 2.0.13 可用)

定义于: 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;
}

            
setTransactionIsolationLevel() 公共方法
public void setTransactionIsolationLevel ( $level )
$level string

要在此事务中使用的交易隔离级别。它可以是 yii\db\Transaction::READ_UNCOMMITTEDyii\db\Transaction::READ_COMMITTEDyii\db\Transaction::REPEATABLE_READyii\db\Transaction::SERIALIZABLE,但也可以是包含 DBMS 特定语法的字符串,该字符串将在 SET TRANSACTION ISOLATION LEVEL 之后使用。

                public function setTransactionIsolationLevel($level)
{
    $this->db->createCommand("SET TRANSACTION ISOLATION LEVEL $level")->execute();
}

            
supportsSavepoint() 公共方法
public boolean supportsSavepoint ( )
返回值 boolean

此 DBMS 是否支持 保存点

                public function supportsSavepoint()
{
    return $this->db->enableSavepoint;
}

            
unquoteSimpleColumnName() 公共方法 (自版本 2.0.14 可用)

定义于: 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);
}

            
unquoteSimpleTableName() 公共方法 (自版本 2.0.14 可用)

定义于: 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);
}