Class yii\db\mssql\TableSchema
| 继承 | yii\db\mssql\TableSchema » yii\db\TableSchema » yii\base\BaseObject |
|---|---|
| 实现 | yii\base\Configurable |
| 可用版本自 | 2.0 |
| 源码 | https://github.com/yiichina/yii2/blob/api/framework/db/mssql/TableSchema.php |
TableSchema 类表示数据库表的元数据。
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| $catalogName | string | 此表所属目录（数据库）的名称。 默认为 null，表示没有目录（或当前数据库不存在）。 | yii\db\mssql\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 |