Interface yii\db\ConstraintFinderInterface

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.14
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/ConstraintFinderInterface.php

ConstraintFinderInterface 定义用于获取表约束信息的方法.

公共方法

隐藏继承的方法

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

方法详情

getSchemaChecks() public abstract 方法

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

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

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

$refresh boolean

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

return \yii\db\CheckConstraint[][]

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

getSchemaDefaultValues() public abstract 方法

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

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

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

$refresh boolean

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

return yii\db\DefaultValueConstraint[]

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

getSchemaForeignKeys() public abstract 方法

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

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

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

$refresh boolean

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

return \yii\db\ForeignKeyConstraint[][]

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

getSchemaIndexes() public abstract 方法

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

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

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

$refresh boolean

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

return \yii\db\IndexConstraint[][]

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

getSchemaPrimaryKeys() public abstract 方法

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

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

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

$refresh boolean

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

return yii\db\Constraint[]

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

getSchemaUniques() public abstract 方法

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

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

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

$refresh boolean

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

return \yii\db\Constraint[][]

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

getTableChecks() public abstract 方法

获取指定表的检查约束信息.

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

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

$refresh boolean

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

return yii\db\CheckConstraint[]

表的检查约束.

getTableDefaultValues() public abstract 方法

获取指定表的默认值约束信息.

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

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

$refresh boolean

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

return yii\db\DefaultValueConstraint[]

表的默认值约束.

getTableForeignKeys() public abstract 方法

获取指定表的外键信息.

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

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

$refresh boolean

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

return yii\db\ForeignKeyConstraint[]

表的外键.

getTableIndexes() public abstract 方法

获取指定表的索引信息.

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

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

$refresh boolean

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

return yii\db\IndexConstraint[]

表的索引.

getTablePrimaryKey() public abstract 方法

获取指定表的主键.

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

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

$refresh boolean

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

return yii\db\Constraint|null

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

getTableUniques() public abstract 方法

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

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

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

$refresh boolean

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

return yii\db\Constraint[]

表的唯一性约束.