Trait yii\db\ConstraintFinderTrait

Implemented byyii\db\cubrid\Schema, yii\db\mssql\Schema, yii\db\mysql\Schema, yii\db\oci\Schema, yii\db\pgsql\Schema, yii\db\sqlite\Schema
可用自版本2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/ConstraintFinderTrait.php

ConstraintFinderTrait 提供了获取表约束信息的方法.

公共属性

隐藏继承的属性

属性类型描述定义在
$schemaChecks \yii\db\CheckConstraint[][] 数据库中所有表的检查约束. 每个数组元素都是 yii\db\CheckConstraint 或其子类的数组. 该属性是只读的. yii\db\ConstraintFinderTrait
$schemaDefaultValues yii\db\DefaultValueConstraint[] 数据库中所有表的默认值约束. 每个数组元素都是 yii\db\DefaultValueConstraint 或其子类的数组. 该属性是只读的. yii\db\ConstraintFinderTrait
$schemaForeignKeys \yii\db\ForeignKeyConstraint[][] 数据库中所有表的外键. 每个数组元素都是 yii\db\ForeignKeyConstraint 或其子类的数组. 该属性是只读的. yii\db\ConstraintFinderTrait
$schemaIndexes \yii\db\IndexConstraint[][] 数据库中所有表的索引. 每个数组元素都是 yii\db\IndexConstraint 或其子类的数组. 该属性是只读的. yii\db\ConstraintFinderTrait
$schemaPrimaryKeys yii\db\Constraint[] 数据库中所有表的主键. 每个数组元素都是 yii\db\Constraint 或其子类的实例. 该属性是只读的. yii\db\ConstraintFinderTrait
$schemaUniques \yii\db\IndexConstraint[][] 数据库中所有表的唯一性约束. 每个数组元素都是 yii\db\IndexConstraint 或其子类的数组. 该属性是只读的. yii\db\ConstraintFinderTrait

公共方法

隐藏继承的方法

方法描述定义在
getSchemaChecks() 返回数据库中所有表的检查约束. yii\db\ConstraintFinderTrait
getSchemaDefaultValues() 返回数据库中所有表的默认值约束. yii\db\ConstraintFinderTrait
getSchemaForeignKeys() 返回数据库中所有表的外键. yii\db\ConstraintFinderTrait
getSchemaIndexes() 返回数据库中所有表的索引. yii\db\ConstraintFinderTrait
getSchemaPrimaryKeys() 返回数据库中所有表的主键. yii\db\ConstraintFinderTrait
getSchemaUniques() 返回数据库中所有表的唯一性约束. yii\db\ConstraintFinderTrait
getTableChecks() 返回指定表的检查约束信息. yii\db\ConstraintFinderTrait
getTableDefaultValues() 返回指定表的默认值约束信息. yii\db\ConstraintFinderTrait
getTableForeignKeys() 获取指定表的外键信息. yii\db\ConstraintFinderTrait
getTableIndexes() 获取指定表的索引信息. yii\db\ConstraintFinderTrait
getTablePrimaryKey() 获取指定表的主键. yii\db\ConstraintFinderTrait
getTableUniques() 获取指定表的唯一性约束信息. yii\db\ConstraintFinderTrait

受保护的方法

隐藏继承的方法

方法描述定义在
getSchemaMetadata() 返回给定模式中所有表的给定类型的元数据. yii\db\ConstraintFinderTrait
getTableMetadata() 返回给定表的给定类型的元数据. yii\db\ConstraintFinderTrait
loadTableChecks() 加载给定表的所有检查约束. yii\db\ConstraintFinderTrait
loadTableDefaultValues() 加载给定表的所有默认值约束. yii\db\ConstraintFinderTrait
loadTableForeignKeys() 加载给定表的所有外键. yii\db\ConstraintFinderTrait
loadTableIndexes() 加载给定表的所有索引. yii\db\ConstraintFinderTrait
loadTablePrimaryKey() 加载给定表的主键. yii\db\ConstraintFinderTrait
loadTableUniques() 加载给定表的所有唯一性约束. yii\db\ConstraintFinderTrait

属性详情

$schemaChecks public 属性

数据库中所有表的检查约束. 每个数组元素都是 yii\db\CheckConstraint 或其子类的数组. 该属性是只读的.

public \yii\db\CheckConstraint[][] $schemaChecks null
$schemaDefaultValues public 属性

数据库中所有表的默认值约束. 每个数组元素都是 yii\db\DefaultValueConstraint 或其子类的数组. 该属性是只读的.

$schemaForeignKeys public 属性

数据库中所有表的外键. 每个数组元素都是 yii\db\ForeignKeyConstraint 或其子类的数组. 该属性是只读的.

public \yii\db\ForeignKeyConstraint[][] $schemaForeignKeys null
$schemaIndexes public 属性

数据库中所有表的索引. 每个数组元素都是 yii\db\IndexConstraint 或其子类的数组. 该属性是只读的.

public \yii\db\IndexConstraint[][] $schemaIndexes null
$schemaPrimaryKeys public 属性

数据库中所有表的主键. 每个数组元素都是 yii\db\Constraint 或其子类的实例. 该属性是只读的.

$schemaUniques public 属性

数据库中所有表的唯一性约束. 每个数组元素都是 yii\db\IndexConstraint 或其子类的数组. 该属性是只读的.

public \yii\db\IndexConstraint[][] $schemaUniques null

方法详情

getSchemaChecks() public 方法

返回数据库中所有表的检查约束.

public \yii\db\CheckConstraint[][] getSchemaChecks ( $schema '', $refresh false )
$schema string

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据(如果可用).

return \yii\db\CheckConstraint[][]

数据库中所有表的检查约束. 每个数组元素都是 yii\db\CheckConstraint 或其子类的数组

getSchemaDefaultValues() public 方法

返回数据库中所有表的默认值约束.

public yii\db\DefaultValueConstraint[] getSchemaDefaultValues ( $schema '', $refresh false )
$schema string

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据(如果可用).

return yii\db\DefaultValueConstraint[]

数据库中所有表的默认值约束. 每个数组元素都是 yii\db\DefaultValueConstraint 或其子类的数组.

getSchemaForeignKeys() public 方法

返回数据库中所有表的外键.

public \yii\db\ForeignKeyConstraint[][] getSchemaForeignKeys ( $schema '', $refresh false )
$schema string

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据(如果可用).

return \yii\db\ForeignKeyConstraint[][]

数据库中所有表的外键. 每个数组元素都是 yii\db\ForeignKeyConstraint 或其子类的数组.

getSchemaIndexes() public 方法

返回数据库中所有表的索引.

public \yii\db\IndexConstraint[][] getSchemaIndexes ( $schema '', $refresh false )
$schema string

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据(如果可用).

return \yii\db\IndexConstraint[][]

数据库中所有表的索引. 每个数组元素都是 yii\db\IndexConstraint 或其子类的数组.

getSchemaMetadata() protected abstract 方法

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

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

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

$type string

元数据类型.

$refresh boolean

是否获取最新的可用表元数据. 如果为false, 则可能会返回缓存的数据.

return array

元数据数组.

getSchemaPrimaryKeys() public 方法

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

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

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据.

return yii\db\Constraint[]

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

getSchemaUniques() public 方法

返回数据库中所有表的唯一性约束.

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

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

$refresh boolean

是否获取最新的可用表的模式. 如果为false, 则可能会返回缓存的数据(如果可用).

return \yii\db\Constraint[][]

数据库中所有表的唯一性约束. 每个数组元素都是 yii\db\Constraint 或其子类的数组.

getTableChecks() public 方法

返回指定表的检查约束信息.

public yii\db\CheckConstraint[] getTableChecks ( $name, $refresh false )
$name string

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\CheckConstraint[]

表的检查约束.

getTableDefaultValues() public 方法

返回指定表的默认值约束信息.

public yii\db\DefaultValueConstraint[] getTableDefaultValues ( $name, $refresh false )
$name string

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\DefaultValueConstraint[]

表的默认值约束.

getTableForeignKeys() public 方法

获取指定表的外键信息.

public yii\db\ForeignKeyConstraint[] getTableForeignKeys ( $name, $refresh false )
$name string

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\ForeignKeyConstraint[]

表的外键.

getTableIndexes() public 方法

获取指定表的索引信息.

public yii\db\IndexConstraint[] getTableIndexes ( $name, $refresh false )
$name string

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\IndexConstraint[]

表的索引.

getTableMetadata() protected abstract 方法

返回给定表的给定类型的元数据.

protected abstract mixed getTableMetadata ( $name, $type, $refresh )
$name string

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

$type string

元数据类型.

$refresh boolean

是否重新加载表元数据. 即使它在缓存中找到.

return mixed

元数据.

getTablePrimaryKey() public 方法

获取指定表的主键.

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

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\Constraint|null

表的主键; 如果表没有主键, 则为null.

getTableUniques() public 方法

获取指定表的唯一性约束信息.

public yii\db\Constraint[] getTableUniques ( $name, $refresh false )
$name string

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

$refresh boolean

是否重写加载信息, 即使它在缓存中找到.

return yii\db\Constraint[]

表的唯一性约束.

loadTableChecks() protected abstract 方法

加载给定表的所有检查约束.

protected abstract yii\db\CheckConstraint[] loadTableChecks ( $tableName )
$tableName string

表名.

return yii\db\CheckConstraint[]

给定表的检查约束.

loadTableDefaultValues() protected abstract 方法

加载给定表的所有默认值约束.

protected abstract yii\db\DefaultValueConstraint[] loadTableDefaultValues ( $tableName )
$tableName string

表名.

return yii\db\DefaultValueConstraint[]

给定表的默认值约束.

loadTableForeignKeys() protected abstract 方法

加载给定表的所有外键.

protected abstract yii\db\ForeignKeyConstraint[] loadTableForeignKeys ( $tableName )
$tableName string

表名.

return yii\db\ForeignKeyConstraint[]

给定表的外键.

loadTableIndexes() protected abstract 方法

加载给定表的所有索引.

protected abstract yii\db\IndexConstraint[] loadTableIndexes ( $tableName )
$tableName string

表名.

return yii\db\IndexConstraint[]

给定表的索引.

loadTablePrimaryKey() protected abstract 方法

加载给定表的主键.

protected abstract yii\db\Constraint|null loadTablePrimaryKey ( $tableName )
$tableName string

表名.

return yii\db\Constraint|null

给定表的主键; 如果表没有主键, 则为null.

loadTableUniques() protected abstract 方法

加载给定表的所有唯一性约束.

protected abstract yii\db\Constraint[] loadTableUniques ( $tableName )
$tableName string

表名.

return yii\db\Constraint[]

给定表的唯一性约束.