Class yii\db\mssql\Schema

All Classes | Properties | Methods | Constants

Inheritance	yii\db\mssql\Schema » yii\db\Schema » yii\base\BaseObject
Implements	yii\base\Configurable, yii\db\ConstraintFinderInterface
Uses Traits	yii\db\ConstraintFinderTrait, yii\db\ViewFinderTrait
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/Schema.php

Schema is the class for retrieving metadata from MS SQL Server databases (version 2008 and above).

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$columnSchemaClass	string\|array	Column schema class or class config	yii\db\mssql\Schema
$db	yii\db\Connection	The database connection	yii\db\Schema
$defaultSchema	string	The default schema used for the current session.	yii\db\mssql\Schema
$exceptionMap	array	Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used.	yii\db\Schema
$lastInsertID	string	The row ID of the last row inserted, or the last value retrieved from the sequence object. This property is read-only.	yii\db\Schema
$queryBuilder	yii\db\QueryBuilder	The query builder for this connection. This property is read-only.	yii\db\Schema
$schemaChecks	\yii\db\CheckConstraint[][]	Check constraints for all tables in the database.	yii\db\ConstraintFinderTrait
$schemaDefaultValues	yii\db\DefaultValueConstraint[]	Default value constraints for all tables in the database.	yii\db\ConstraintFinderTrait
$schemaForeignKeys	\yii\db\ForeignKeyConstraint[][]	Foreign keys for all tables in the database.	yii\db\ConstraintFinderTrait
$schemaIndexes	\yii\db\IndexConstraint[][]	Indexes for all tables in the database.	yii\db\ConstraintFinderTrait
$schemaNames	string[]	All schema names in the database, except system schemas. This property is read-only.	yii\db\Schema
$schemaPrimaryKeys	yii\db\Constraint[]	Primary keys for all tables in the database.	yii\db\ConstraintFinderTrait
$schemaUniques	\yii\db\Constraint[][]	Unique constraints for all tables in the database.	yii\db\ConstraintFinderTrait
$serverVersion	string	Server version as a string. This property is read-only.	yii\db\Schema
$tableNames	string[]	All table names in the database. This property is read-only.	yii\db\Schema
$tableSchemas	yii\db\TableSchema[]	The metadata for all tables in the database. Each array element is an instance of yii\db\TableSchema or its child class. This property is read-only.	yii\db\Schema
$transactionIsolationLevel	string	The transaction isolation level to use for this transaction. This can be one of yii\db\Transaction::READ_UNCOMMITTED, yii\db\Transaction::READ_COMMITTED, yii\db\Transaction::REPEATABLE_READ and yii\db\Transaction::SERIALIZABLE but also a string containing DBMS specific syntax to be used after `SET TRANSACTION ISOLATION LEVEL`. This property is write-only.	yii\db\Schema
$typeMap	array	Mapping from physical column types (keys) to abstract column types (values)	yii\db\mssql\Schema
$viewNames	string[]	All view names in the database.	yii\db\ViewFinderTrait

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$columnQuoteCharacter	string\|string[]	Character used to quote column names.	yii\db\mssql\Schema
$tableQuoteCharacter	string\|string[]	Character used to quote schema, table, etc.	yii\db\mssql\Schema

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
convertException()	Converts a DB exception to a more concrete one if possible.	yii\db\Schema
createColumnSchemaBuilder()	Create a column schema builder instance giving the type and value precision.	yii\db\mssql\Schema
createQueryBuilder()	Creates a query builder for the MSSQL database.	yii\db\mssql\Schema
createSavepoint()	Creates a new savepoint.	yii\db\mssql\Schema
findUniqueIndexes()	Returns all unique indexes for the given table.	yii\db\mssql\Schema
getLastInsertID()	Returns the ID of the last inserted row or sequence value.	yii\db\Schema
getPdoType()	Determines the PDO type for the given PHP data value.	yii\db\Schema
getQueryBuilder()		yii\db\Schema
getRawTableName()	Returns the actual name of a given table name.	yii\db\Schema
getSchemaChecks()	Returns check constraints for all tables in the database.	yii\db\ConstraintFinderTrait
getSchemaDefaultValues()	Returns default value constraints for all tables in the database.	yii\db\ConstraintFinderTrait
getSchemaForeignKeys()	Returns foreign keys for all tables in the database.	yii\db\ConstraintFinderTrait
getSchemaIndexes()	Returns indexes for all tables in the database.	yii\db\ConstraintFinderTrait
getSchemaNames()	Returns all schema names in the database, except system schemas.	yii\db\Schema
getSchemaPrimaryKeys()	Returns primary keys for all tables in the database.	yii\db\ConstraintFinderTrait
getSchemaUniques()	Returns unique constraints for all tables in the database.	yii\db\ConstraintFinderTrait
getServerVersion()	Returns a server version as a string comparable by \version_compare().	yii\db\Schema
getTableChecks()	Obtains the check constraints information for the named table.	yii\db\ConstraintFinderTrait
getTableDefaultValues()	Obtains the default value constraints information for the named table.	yii\db\ConstraintFinderTrait
getTableForeignKeys()	Obtains the foreign keys information for the named table.	yii\db\ConstraintFinderTrait
getTableIndexes()	Obtains the indexes information for the named table.	yii\db\ConstraintFinderTrait
getTableNames()	Returns all table names in the database.	yii\db\Schema
getTablePrimaryKey()	Obtains the primary key for the named table.	yii\db\ConstraintFinderTrait
getTableSchema()	Obtains the metadata for the named table.	yii\db\Schema
getTableSchemas()	Returns the metadata for all tables in the database.	yii\db\Schema
getTableUniques()	Obtains the unique constraints information for the named table.	yii\db\ConstraintFinderTrait
getViewNames()	Returns all view names in the database.	yii\db\ViewFinderTrait
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
insert()	Retrieving inserted data from a primary key request of type uniqueidentifier (for SQL Server 2005 or later) {@inheritdoc}	yii\db\mssql\Schema
isReadQuery()	Returns a value indicating whether a SQL statement is for read purpose.	yii\db\Schema
quoteColumnName()	Quotes a column name for use in a query.	yii\db\mssql\Schema
quoteSimpleColumnName()	Quotes a simple column name for use in a query.	yii\db\Schema
quoteSimpleTableName()	Quotes a simple table name for use in a query.	yii\db\Schema
quoteTableName()	Quotes a table name for use in a query.	yii\db\Schema
quoteValue()	Quotes a string value for use in a query.	yii\db\Schema
refresh()	Refreshes the schema.	yii\db\Schema
refreshTableSchema()	Refreshes the particular table schema.	yii\db\Schema
releaseSavepoint()	Releases an existing savepoint.	yii\db\mssql\Schema
rollBackSavepoint()	Rolls back to a previously created savepoint.	yii\db\mssql\Schema
setTransactionIsolationLevel()	Sets the isolation level of the current transaction.	yii\db\Schema
supportsSavepoint()		yii\db\Schema
unquoteSimpleColumnName()	Unquotes a simple column name.	yii\db\Schema
unquoteSimpleTableName()	Unquotes a simple table name.	yii\db\Schema

Protected Methods

Hide inherited methods

Method	Description	Defined By
createColumnSchema()	Creates a column schema for the database.	yii\db\Schema
findColumns()	Collects the metadata of table columns.	yii\db\mssql\Schema
findForeignKeys()	Collects the foreign key column details for the given table.	yii\db\mssql\Schema
findPrimaryKeys()	Collects the primary key column details for the given table.	yii\db\mssql\Schema
findSchemaNames()	Returns all schema names in the database, including the default one but not system schemas.	yii\db\mssql\Schema
findTableConstraints()	Collects the constraint details for the given table and constraint type.	yii\db\mssql\Schema
findTableNames()	Returns all table names in the database.	yii\db\mssql\Schema
findViewNames()		yii\db\mssql\Schema
getCacheKey()	Returns the cache key for the specified table name.	yii\db\Schema
getCacheTag()	Returns the cache tag name.	yii\db\Schema
getColumnPhpType()	Extracts the PHP type from abstract DB type.	yii\db\Schema
getSchemaMetadata()	Returns the metadata of the given type for all tables in the given schema.	yii\db\mssql\Schema
getTableMetadata()	Returns the metadata of the given type for the given table.	yii\db\ConstraintFinderTrait
getTableNameParts()	{@inheritDoc}	yii\db\mssql\Schema
loadColumnSchema()	Loads the column information into a yii\db\mssql\ColumnSchema object.	yii\db\mssql\Schema
loadTableChecks()		yii\db\mssql\Schema
loadTableDefaultValues()		yii\db\mssql\Schema
loadTableForeignKeys()		yii\db\mssql\Schema
loadTableIndexes()		yii\db\mssql\Schema
loadTablePrimaryKey()		yii\db\mssql\Schema
loadTableSchema()	Loads the metadata for the specified table.	yii\db\mssql\Schema
loadTableUniques()		yii\db\mssql\Schema
normalizePdoRowKeyCase()	Changes row's array key case to lower if PDO's one is set to uppercase.	yii\db\Schema
resolveTableName()	Resolves the table name and schema name (if any).	yii\db\mssql\Schema
resolveTableNames()	Resolves the table name and schema name (if any).	yii\db\mssql\Schema
setTableMetadata()	Sets the metadata of the given type for the given table.	yii\db\Schema

Constants

Hide inherited constants

Constant	Value	Description	Defined By
SCHEMA_CACHE_VERSION	1	Schema cache version, to detect incompatibilities in cached values when the data format of the cache changes.	yii\db\Schema
TYPE_BIGINT	'bigint'		yii\db\Schema
TYPE_BIGPK	'bigpk'		yii\db\Schema
TYPE_BINARY	'binary'		yii\db\Schema
TYPE_BOOLEAN	'boolean'		yii\db\Schema
TYPE_CHAR	'char'		yii\db\Schema
TYPE_DATE	'date'		yii\db\Schema
TYPE_DATETIME	'datetime'		yii\db\Schema
TYPE_DECIMAL	'decimal'		yii\db\Schema
TYPE_DOUBLE	'double'		yii\db\Schema
TYPE_FLOAT	'float'		yii\db\Schema
TYPE_INTEGER	'integer'		yii\db\Schema
TYPE_JSON	'json'		yii\db\Schema
TYPE_MONEY	'money'		yii\db\Schema
TYPE_PK	'pk'		yii\db\Schema
TYPE_SMALLINT	'smallint'		yii\db\Schema
TYPE_STRING	'string'		yii\db\Schema
TYPE_TEXT	'text'		yii\db\Schema
TYPE_TIME	'time'		yii\db\Schema
TYPE_TIMESTAMP	'timestamp'		yii\db\Schema
TYPE_TINYINT	'tinyint'		yii\db\Schema
TYPE_UBIGPK	'ubigpk'		yii\db\Schema
TYPE_UPK	'upk'		yii\db\Schema

Property Details

$columnQuoteCharacter protected property (available since version 2.0.14)

Character used to quote column names. An array of 2 characters can be used in case starting and ending characters are different.

protected string|string[] $columnQuoteCharacter = ['[', ']']

$columnSchemaClass public property (available since version 2.0.11)

Column schema class or class config

public string|array $columnSchemaClass = 'yii\db\mssql\ColumnSchema'

$defaultSchema public property

The default schema used for the current session.

public string $defaultSchema = 'dbo'

$tableQuoteCharacter protected property (available since version 2.0.14)

Character used to quote schema, table, etc. names. An array of 2 characters can be used in case starting and ending characters are different.

protected string|string[] $tableQuoteCharacter = ['[', ']']

$typeMap public property

Mapping from physical column types (keys) to abstract column types (values)

public array $typeMap = ['bigint' => self::TYPE_BIGINT, 'numeric' => self::TYPE_DECIMAL, 'bit' => self::TYPE_SMALLINT, 'smallint' => self::TYPE_SMALLINT, 'decimal' => self::TYPE_DECIMAL, 'smallmoney' => self::TYPE_MONEY, 'int' => self::TYPE_INTEGER, 'tinyint' => self::TYPE_TINYINT, 'money' => self::TYPE_MONEY, 'float' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'real' => self::TYPE_FLOAT, 'date' => self::TYPE_DATE, 'datetimeoffset' => self::TYPE_DATETIME, 'datetime2' => self::TYPE_DATETIME, 'smalldatetime' => self::TYPE_DATETIME, 'datetime' => self::TYPE_DATETIME, 'time' => self::TYPE_TIME, 'char' => self::TYPE_CHAR, 'varchar' => self::TYPE_STRING, 'text' => self::TYPE_TEXT, 'nchar' => self::TYPE_CHAR, 'nvarchar' => self::TYPE_STRING, 'ntext' => self::TYPE_TEXT, 'binary' => self::TYPE_BINARY, 'varbinary' => self::TYPE_BINARY, 'image' => self::TYPE_BINARY, 'timestamp' => self::TYPE_TIMESTAMP, 'hierarchyid' => self::TYPE_STRING, 'uniqueidentifier' => self::TYPE_STRING, 'sql_variant' => self::TYPE_STRING, 'xml' => self::TYPE_STRING, 'table' => self::TYPE_STRING]

Method Details

createColumnSchemaBuilder() public method (available since version 2.0.6)

Create a column schema builder instance giving the type and value precision.

This method may be overridden by child classes to create a DBMS-specific column schema builder.

public yii\db\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length = null )
$type	string	Type of the column. See yii\db\mssql\ColumnSchemaBuilder::$type.
$length	integer\|string\|array	Length or precision of the column. See yii\db\mssql\ColumnSchemaBuilder::$length.
return	yii\db\ColumnSchemaBuilder	Column schema builder instance

createQueryBuilder() public method

Creates a query builder for the MSSQL database.

public yii\db\mssql\QueryBuilder createQueryBuilder ( )
return	yii\db\mssql\QueryBuilder	Query builder interface.

createSavepoint() public method

Creates a new savepoint.

public void createSavepoint ( $name )
$name	string	The savepoint name

findColumns() protected method

Collects the metadata of table columns.

protected boolean findColumns ( $table )
$table	yii\db\mssql\TableSchema	The table metadata
return	boolean	Whether the table exists in the database

findForeignKeys() protected method

Collects the foreign key column details for the given table.

protected void findForeignKeys ( $table )
$table	yii\db\mssql\TableSchema	The table metadata

findPrimaryKeys() protected method

Collects the primary key column details for the given table.

protected void findPrimaryKeys ( $table )
$table	yii\db\mssql\TableSchema	The table metadata

findSchemaNames() protected method (available since version 2.0.4)

Returns all schema names in the database, including the default one but not system schemas.

This method should be overridden by child classes in order to support this feature because the default implementation simply throws an exception.

protected array findSchemaNames ( )
return	array	All schema names in the database, except system schemas.
throws	yii\base\NotSupportedException	if this method is not supported by the DBMS.

findTableConstraints() protected method (available since version 2.0.4)

Collects the constraint details for the given table and constraint type.

protected array findTableConstraints ( $table, $type )
$table	yii\db\mssql\TableSchema
$type	string	Either PRIMARY KEY or UNIQUE
return	array	Each entry contains index_name and field_name

findTableNames() protected method

Returns all table names in the database.

This method should be overridden by child classes in order to support this feature because the default implementation simply throws an exception.

protected array findTableNames ( $schema = '' )
$schema	string	The schema of the tables. Defaults to empty string, meaning the current or default schema.
return	array	All table names in the database. The names have NO schema name prefix.
throws	yii\base\NotSupportedException	if this method is not supported by the DBMS.

findUniqueIndexes() public method (available since version 2.0.4)

Returns all unique indexes for the given table.

Each array element is of the following structure:

[
    'IndexName1' => ['col1' [, ...]],
    'IndexName2' => ['col2' [, ...]],
]

public array findUniqueIndexes ( $table )
$table	yii\db\mssql\TableSchema	The table metadata
return	array	All unique indexes for the given table.

findViewNames() protected method

protected void findViewNames ( $schema = '' )
$schema

getSchemaMetadata() protected method (available since version 2.0.13)

Returns the metadata of the given type for all tables in the given schema.

This method will call a 'getTable' . ucfirst($type) named method with the table name and the refresh flag to obtain the metadata.

protected array getSchemaMetadata ( $schema, $type, $refresh )
$schema	string	The schema of the metadata. Defaults to empty string, meaning the current or default schema name.
$type	string	Metadata type.
$refresh	boolean	Whether to fetch the latest available table metadata. If this is `false`, cached data may be returned if available.
return	array	Array of metadata.

getTableNameParts() protected method (available since version 2.0.22)

{@inheritDoc}

protected array getTableNameParts ( $name )
$name	string

insert() public method

Retrieving inserted data from a primary key request of type uniqueidentifier (for SQL Server 2005 or later) {@inheritdoc}

public void insert ( $table, $columns )
$table
$columns

loadColumnSchema() protected method

Loads the column information into a yii\db\mssql\ColumnSchema object.

protected yii\db\mssql\ColumnSchema loadColumnSchema ( $info )
$info	array	Column information
return	yii\db\mssql\ColumnSchema	The column schema object

loadTableChecks() protected method

protected void loadTableChecks ( $tableName )
$tableName

loadTableDefaultValues() protected method

protected void loadTableDefaultValues ( $tableName )
$tableName

loadTableForeignKeys() protected method

protected void loadTableForeignKeys ( $tableName )
$tableName

loadTableIndexes() protected method

protected void loadTableIndexes ( $tableName )
$tableName

loadTablePrimaryKey() protected method

protected void loadTablePrimaryKey ( $tableName )
$tableName

loadTableSchema() protected method

Loads the metadata for the specified table.

protected yii\db\TableSchema\|null loadTableSchema ( $name )
$name	string	Table name
return	yii\db\TableSchema\|null	DBMS-dependent table metadata, `null` if the table does not exist.

loadTableUniques() protected method

protected void loadTableUniques ( $tableName )
$tableName

quoteColumnName() public method

Quotes a column name for use in a query.

If the column name contains prefix, the prefix will also be properly quoted. If the column name is already quoted or contains '(', '[[' or '{{', then this method will do nothing.

public string quoteColumnName ( $name )
$name	string	Column name
return	string	The properly quoted column name

releaseSavepoint() public method

Releases an existing savepoint.

public void releaseSavepoint ( $name )
$name	string	The savepoint name

resolveTableName() protected method

Resolves the table name and schema name (if any).

protected yii\db\mssql\TableSchema resolveTableName ( $name )
$name	string	The table name
return	yii\db\mssql\TableSchema	Resolved table, schema, etc. names.

resolveTableNames() protected method

Resolves the table name and schema name (if any).

protected void resolveTableNames ( $table, $name )
$table	yii\db\mssql\TableSchema	The table metadata object
$name	string	The table name

rollBackSavepoint() public method

Rolls back to a previously created savepoint.

public void rollBackSavepoint ( $name )
$name	string	The savepoint name