Class yii\db\mssql\Schema

继承yii\db\mssql\Schema » yii\db\Schema » yii\base\BaseObject
实现yii\base\Configurable, yii\db\ConstraintFinderInterface
Uses Traitsyii\db\ConstraintFinderTrait, yii\db\ViewFinderTrait
可用自版本2.0
源代码 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).

公共属性

隐藏继承的属性

属性类型描述定义在
$columnSchemaClass string|array Column schema class or class config yii\db\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 yii\db\Schema
$queryBuilder yii\db\QueryBuilder The query builder for this connection. 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. 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. yii\db\Schema
$tableNames string[] All table names in the database. yii\db\Schema
$tableSchemas yii\db\TableSchema[] The metadata for all tables in the database. yii\db\Schema
$transactionIsolationLevel string The transaction isolation level to use for this transaction. 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

受保护的属性

隐藏继承的属性

属性类型描述定义在
$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

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. 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\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() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
insert() Executes the INSERT command, returning primary key values. yii\db\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\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

受保护的方法

隐藏继承的方法

方法描述定义在
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\ConstraintFinderTrait
getTableMetadata() Returns the metadata of the given type for the given table. yii\db\ConstraintFinderTrait
loadColumnSchema() Loads the column information into a yii\db\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

常量

隐藏继承的常量

常量描述定义在
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

属性详情

$columnQuoteCharacter protected 属性

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 = ['['']']
$defaultSchema public 属性

The default schema used for the current session.

public string $defaultSchema 'dbo'
$tableQuoteCharacter protected 属性

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 属性

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]

方法详情

createQueryBuilder() public 方法

Creates a query builder for the MSSQL database.

public yii\db\mssql\QueryBuilder createQueryBuilder ( )
return yii\db\mssql\QueryBuilder

Query builder interface.

createSavepoint() public 方法

Creates a new savepoint.

public void createSavepoint ( $name )
$name string

The savepoint name

findColumns() protected 方法

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 方法

Collects the foreign key column details for the given table.

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

The table metadata

findPrimaryKeys() protected 方法

Collects the primary key column details for the given table.

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

The table metadata

findSchemaNames() protected 方法

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.

参见 https://docs.microsoft.com/en-us/sql/relational-databases/system-catalog-views/sys-database-principals-transact-sql.

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 方法 (可用自版本: 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 方法

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 方法 (可用自版本: 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 方法

protected void findViewNames ( $schema '' )
$schema
loadColumnSchema() protected 方法

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

protected yii\db\ColumnSchema loadColumnSchema ( $info )
$info array

Column information

return yii\db\ColumnSchema

The column schema object

loadTableChecks() protected 方法

protected void loadTableChecks ( $tableName )
$tableName
loadTableDefaultValues() protected 方法

protected void loadTableDefaultValues ( $tableName )
$tableName
loadTableForeignKeys() protected 方法

protected void loadTableForeignKeys ( $tableName )
$tableName
loadTableIndexes() protected 方法

protected void loadTableIndexes ( $tableName )
$tableName
loadTablePrimaryKey() protected 方法

protected void loadTablePrimaryKey ( $tableName )
$tableName
loadTableSchema() protected 方法

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 方法

protected void loadTableUniques ( $tableName )
$tableName
releaseSavepoint() public 方法

Releases an existing savepoint.

public void releaseSavepoint ( $name )
$name string

The savepoint name

resolveTableName() protected 方法

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 方法

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 方法

Rolls back to a previously created savepoint.

public void rollBackSavepoint ( $name )
$name string

The savepoint name