0 关注者

特质 yii\db\ConstraintFinderTrait

所有类 | 属性 | 方法
实现者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.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/ConstraintFinderTrait.php

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

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$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
$schemaPrimaryKeys yii\db\Constraint[] 数据库中所有表的主键。 yii\db\ConstraintFinderTrait
$schemaUniques \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 公共属性

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

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

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

public yii\db\DefaultValueConstraint[] $schemaDefaultValues = null
$schemaForeignKeys 公共属性

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

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

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

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

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

public yii\db\Constraint[] $schemaPrimaryKeys = null
$schemaUniques 公共属性

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

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

方法详情

隐藏继承的方法

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() 公共方法

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

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 \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 \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 array getSchemaMetadata ( $schema, $type, $refresh )
$schema string

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

元数据类型。
$refresh boolean

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

元数据的数组。

 

                abstract protected function getSchemaMetadata($schema, $type, $refresh);
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 \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);
}
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 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 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 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 mixed getTableMetadata ( $name, $type, $refresh )
$name string

表名。 表名可以包含模式名称（如果有）。 不要引用表名。
$type string

元数据类型。
$refresh boolean

是否重新加载表元数据，即使它在缓存中找到。
返回值 mixed

元数据。

 

                abstract protected function getTableMetadata($name, $type, $refresh);
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);
}
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);
}
loadTableChecks() 受保护抽象方法

加载指定表的所有检查约束。

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

表名。
返回值 yii\db\CheckConstraint[]

给定表的检查约束。

 

                abstract protected function loadTableChecks($tableName);
loadTableDefaultValues() 受保护抽象方法

加载指定表的所有默认值约束。

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

表名。
返回值 yii\db\DefaultValueConstraint[]

给定表的默认值约束。

 

                abstract protected function loadTableDefaultValues($tableName);
loadTableForeignKeys() 受保护抽象方法

加载指定表的所有外部键。

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

表名。
返回值 yii\db\ForeignKeyConstraint[]

给定表的外部键。

 

                abstract protected function loadTableForeignKeys($tableName);
loadTableIndexes() 受保护抽象方法

加载指定表的所有索引。

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

表名。
返回值 yii\db\IndexConstraint[]

给定表的索引。

 

                abstract protected function loadTableIndexes($tableName);
loadTablePrimaryKey() 受保护抽象方法

加载指定表的主键。

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

表名。
返回值 yii\db\Constraint|null

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

 

                abstract protected function loadTablePrimaryKey($tableName);
loadTableUniques() 受保护抽象方法

加载指定表的所有唯一约束。

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

表名。
返回值 yii\db\Constraint[]

给定表的唯一约束。

 

                abstract protected function loadTableUniques($tableName);