没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\db\TableSchema

所有类 | 属性 | 方法
继承yii\db\TableSchema » yii\base\BaseObject
实现yii\base\Configurable
子类yii\db\mssql\TableSchema
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/db/TableSchema.php

TableSchema 表示数据库表的元数据。

公共属性

隐藏继承的属性

属性类型描述被定义在
$columnNames array 列名列表 yii\db\TableSchema
$columns yii\db\ColumnSchema[] 表的列元数据。每个元素都是 yii\db\ColumnSchema 对象，由列名索引。 yii\db\TableSchema
$foreignKeys array 表的外键。每个数组元素具有以下结构： `php [ 'ForeignTableName', 'fk1' => 'pk1', // pk1 is in foreign table 'fk2' => 'pk2', // if composite foreign key ] ` yii\db\TableSchema
$fullName string 表的全名，包含结构名称前缀（如果有）。 请注意，如果结构名称与 default schema name 相同， 则不包括结构名称。 yii\db\TableSchema
$name string The 表名。结构名称不包括在内。使用 $fullName 获取带有结构名称前缀的名称。 yii\db\TableSchema
$primaryKey string[] 表的主键。 yii\db\TableSchema
$schemaName string 此表所属的结构的名称。 yii\db\TableSchema
$sequenceName string 主键的序列名称。如果没有序列则为空。 yii\db\TableSchema

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
fixPrimaryKey() 手动指定此表的主键。 yii\db\TableSchema
getColumn() 获取指定的列元数据。 这是一种检索命名列的便捷方法，即使它不存在也是如此。 yii\db\TableSchema
getColumnNames() 返回此表中所有列的名称。 yii\db\TableSchema
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject

属性详情

$columnNames 公共 只读 属性

列名列表

public array getColumnNames ( )
$columns 公共 属性

表的列元数据。每个元素都是 yii\db\ColumnSchema 对象，由列名索引。

public yii\db\ColumnSchema[] $columns = []
$foreignKeys 公共 属性

表的外键。每个数组元素具有以下结构：

[
 'ForeignTableName',
 'fk1' => 'pk1',  // pk1 is in foreign table
 'fk2' => 'pk2',  // if composite foreign key
]
public array $foreignKeys = []
$fullName 公共 属性

表的全名，包含结构名称前缀（如果有）。 请注意，如果结构名称与 default schema name 相同， 则不包括结构名称。

public string $fullName = null
$name 公共 属性

The 表名。结构名称不包括在内。使用 $fullName 获取带有结构名称前缀的名称。

public string $name = null
$primaryKey 公共 属性

表的主键。

public string[] $primaryKey = []
$schemaName 公共 属性

此表所属的结构的名称。

public string $schemaName = null
$sequenceName 公共 属性

主键的序列名称。如果没有序列则为空。

public string $sequenceName = null

方法详情

fixPrimaryKey() 公共 方法

手动指定此表的主键。

public void fixPrimaryKey($keys)
$keys string|array

主键（可以是复合键）
throws yii\base\InvalidArgumentException

如果在表中找不到指定的键抛出的异常。
getColumn() 公共 方法

获取指定的列元数据。 这是一种检索命名列的便捷方法，即使它不存在也是如此。

public yii\db\ColumnSchema getColumn($name)
$name string

列名
return yii\db\ColumnSchema

指定列的元数据。如果指定列不存在，则为空。
getColumnNames() 公共 方法

返回此表中所有列的名称。

public array getColumnNames()
return array

列名列表