Interface 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/yiichina/yii2/blob/api/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，可以返回缓存数据（如果可用）
return	\yii\db\CheckConstraint[][]	检查数据库中所有表的约束。每一个数组元素都是 yii\db\CheckConstraint 或它的子类实例。

getSchemaDefaultValues() 公共抽象方法

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

public abstract yii\db\DefaultValueConstraint[] getSchemaDefaultValues($schema = '', $refresh = false)
$schema	string	表的结构。默认为空字符串，表示当前或默认结构名称。
$refresh	boolean	是否获取最新的可用表结构。如果为 false，可以返回缓存数据（如果可用）
return	yii\db\DefaultValueConstraint[]	数据库中所有表的默认值约束。每一个数组元素都是 yii\db\DefaultValueConstraint 或它的子类实例。

getSchemaForeignKeys() 公共抽象方法

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

public abstract \yii\db\ForeignKeyConstraint[][] getSchemaForeignKeys($schema = '', $refresh = false)
$schema	string	表的结构。默认为空字符串，表示当前或默认结构名称。
$refresh	boolean	是否获取最新的可用表结构。如果为 false，可以返回缓存数据（如果可用）。
return	\yii\db\ForeignKeyConstraint[][]	数据库中所有表的外键。每一个数组元素都是 yii\db\ForeignKeyConstraint 或它的子类实例。

getSchemaIndexes() 公共抽象方法

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

public abstract \yii\db\IndexConstraint[][] getSchemaIndexes($schema = '', $refresh = false)
$schema	string	表的结构。默认为空字符串，表示当前或默认结构名称。
$refresh	boolean	是否获取最新的可用表结构。如果为 false，可以返回缓存数据（如果可用）
return	\yii\db\IndexConstraint[][]	数据库中所有表的索引。每一个数组元素都是 yii\db\IndexConstraint 或它的子类实例。

getSchemaPrimaryKeys() 公共抽象方法

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

public abstract yii\db\Constraint[] getSchemaPrimaryKeys($schema = '', $refresh = false)
$schema	string	表的结构。默认为空字符串，表示当前或默认结构名称。
$refresh	boolean	是否获取最新的可用表结构。如果为 `false`，可以返回缓存数据（如果可用）。
return	yii\db\Constraint[]	数据库中所有表的主键。每一个数组元素都是 yii\db\Constraint 或它的子类实例。

getSchemaUniques() 公共抽象方法

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

public abstract \yii\db\Constraint[][] getSchemaUniques($schema = '', $refresh = false)
$schema	string	表的结构。默认为空字符串，表示当前或默认结构名称。
$refresh	boolean	是否获取最新的可用表结构。如果为 false，可以返回缓存数据（如果可用）
return	\yii\db\Constraint[][]	所有数据库表中的唯一约束。每一个数组元素都是 yii\db\Constraint 或它的子类实例。

getTableChecks() 公共抽象方法

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

public abstract yii\db\CheckConstraint[] getTableChecks($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\CheckConstraint[]	表检查约束。

getTableDefaultValues() 公共抽象方法

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

public abstract yii\db\DefaultValueConstraint[] getTableDefaultValues($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\DefaultValueConstraint[]	表默认值约束。

getTableForeignKeys() 公共抽象方法

获取指定表的外键信息。

public abstract yii\db\ForeignKeyConstraint[] getTableForeignKeys($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\ForeignKeyConstraint[]	表的外键。

getTableIndexes() 公共抽象方法

获取指定表的索引信息。

public abstract yii\db\IndexConstraint[] getTableIndexes($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\IndexConstraint[]	表的索引。

getTablePrimaryKey() 公共抽象方法

获取指定表的主键。

public abstract yii\db\Constraint\|null getTablePrimaryKey($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\Constraint\|null	表主键，如果表没有主键，就为 `null`。

getTableUniques() 公共抽象方法

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

public abstract yii\db\Constraint[] getTableUniques($name, $refresh = false)
$name	string	表名。表名可以包含结构名（如果有）。不要引用表名。
$refresh	boolean	是否重新加载信息（即使在缓存中找到）。
return	yii\db\Constraint[]	表唯一约束。