0 关注者

接口 yii\db\ConstraintFinderInterface

所有类 | 方法
实现类yii\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 \yii\db\CheckConstraint[][] getSchemaChecks ( $schema = '', $refresh = false )
$schema string

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表模式。如果为 false，则在可用时可能会返回缓存的数据。
返回值 \yii\db\CheckConstraint[][]

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

 

                public function getSchemaChecks($schema = '', $refresh = false);
getSchemaDefaultValues() 公共抽象方法

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

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

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表模式。如果为 false，则在可用时可能会返回缓存的数据。
返回值 yii\db\DefaultValueConstraint[]

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

 

                public function getSchemaDefaultValues($schema = '', $refresh = false);
getSchemaForeignKeys() 公共抽象方法

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

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

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表模式。如果为 false，则在可用时可能会返回缓存的数据。
返回值 \yii\db\ForeignKeyConstraint[][]

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

 

                public function getSchemaForeignKeys($schema = '', $refresh = false);
getSchemaIndexes() 公共抽象方法

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

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

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表模式。如果为 false，则在可用时可能会返回缓存的数据。
返回值 \yii\db\IndexConstraint[][]

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

 

                public function getSchemaIndexes($schema = '', $refresh = false);
getSchemaPrimaryKeys() 公共抽象方法

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

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

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表架构。如果为 false，则如果可用，可能会返回缓存数据。
返回值 yii\db\Constraint[]

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

 

                public function getSchemaPrimaryKeys($schema = '', $refresh = false);
getSchemaUniques() 公共抽象方法

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

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

表的模式。默认为空字符串，表示当前或默认模式名称。
$refresh boolean

是否获取最新的可用表模式。如果为 false，则在可用时可能会返回缓存的数据。
返回值 \yii\db\Constraint[][]

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

 

                public function getSchemaUniques($schema = '', $refresh = false);
getTableChecks() 公共抽象方法

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

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\CheckConstraint[]

表检查约束。

 

                public function getTableChecks($name, $refresh = false);
getTableDefaultValues() 公共抽象方法

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

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\DefaultValueConstraint[]

表默认值约束。

 

                public function getTableDefaultValues($name, $refresh = false);
getTableForeignKeys() 公共抽象方法

获取指定表的外部键信息。

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\ForeignKeyConstraint[]

表外键。

 

                public function getTableForeignKeys($name, $refresh = false);
getTableIndexes() 公共抽象方法

获取指定表的索引信息。

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\IndexConstraint[]

表索引。

 

                public function getTableIndexes($name, $refresh = false);
getTablePrimaryKey() 公共抽象方法

获取指定表的主键。

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\Constraint|null

表主键，如果表没有主键则为 null。

 

                public function getTablePrimaryKey($name, $refresh = false);
getTableUniques() 公共抽象方法

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

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

表名。表名可以包含架构名称（如果有）。不要引用表名。
$refresh boolean

即使在缓存中找到信息，是否重新加载信息。
返回值 yii\db\Constraint[]

表唯一约束。

 

                public function getTableUniques($name, $refresh = false);