# Class yii\db\mssql\TableSchema

Inheritance | yii\db\mssql\TableSchema » yii\db\TableSchema » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/TableSchema.php

TableSchema represents the metadata of a database table.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$catalogName | string | Name of the catalog (database) that this table belongs to. | yii\db\mssql\TableSchema
$columnNames | array | List of column names. This property is read-only. | yii\db\TableSchema
$columns | yii\db\ColumnSchema[] | Column metadata of this table. | yii\db\TableSchema
$foreignKeys | array | Foreign keys of this table. | yii\db\TableSchema
$fullName | string | The full name of this table, which includes the schema name prefix, if any. | yii\db\TableSchema
$name | string | The name of this table. | yii\db\TableSchema
$primaryKey | string[] | Primary keys of this table. | yii\db\TableSchema
$schemaName | string | The name of the schema that this table belongs to. | yii\db\TableSchema
$sequenceName | string | Sequence name for the primary key. | yii\db\TableSchema

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__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() | Manually specifies the primary key for this table. | yii\db\TableSchema
getColumn() | Gets the named column metadata. | yii\db\TableSchema
getColumnNames() | Returns the names of all columns in this table. | 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

## Property Details

$catalogName public property

Name of the catalog (database) that this table belongs to. Defaults to null, meaning no catalog (or the current database).

public string $catalogName = null