Class yii\db\mysql\Schema

所有类 | 属性 | 方法 | 常量

继承	yii\db\mysql\Schema » yii\db\Schema » yii\base\BaseObject
实现	yii\base\Configurable, yii\db\ConstraintFinderInterface
使用 Traits	yii\db\ConstraintFinderTrait
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/db/mysql/Schema.php

Schema 是用来从 MySQL 数据库（MySQL 版本：4.1.x 和 5.x）检索元数据的类。

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$columnSchemaClass	string\|array	Column schema class or class config	yii\db\mysql\Schema
$db	yii\db\Connection	The database connection	yii\db\Schema
$defaultSchema	string	The default schema name used for the current session.	yii\db\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	从物理列类型（键）到抽象列类型（值）的映射	yii\db\mysql\Schema

受保护的属性

隐藏继承的属性

属性	类型	描述	被定义在
$columnQuoteCharacter	string\|string[]	Character used to quote column names.	yii\db\mysql\Schema
$tableQuoteCharacter	string\|string[]	Character used to quote schema, table, etc.	yii\db\mysql\Schema

公共方法

隐藏继承的方法

方法	描述	被定义在
__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\mysql\Schema
createQueryBuilder()	创建 MySQL 数据库的查询构建器。	yii\db\mysql\Schema
createSavepoint()	Creates a new savepoint.	yii\db\Schema
findUniqueIndexes()	返回给定表的所有唯一索引。	yii\db\mysql\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
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()	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\Schema
rollBackSavepoint()	Rolls back to a previously created savepoint.	yii\db\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()	搜集表列的元数据。	yii\db\mysql\Schema
findConstraints()	搜集给定表的外键列的细节。	yii\db\mysql\Schema
findSchemaNames()	Returns all schema names in the database, including the default one but not system schemas.	yii\db\Schema
findTableNames()	Returns all table names in the database.	yii\db\mysql\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
getCreateTableSql()	获取 CREATE TABLE 的 sql 字符串。	yii\db\mysql\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
isOldMysql()		yii\db\mysql\Schema
loadColumnSchema()	加载列信息到 yii\db\mysql\ColumnSchema 对象。	yii\db\mysql\Schema
loadTableChecks()		yii\db\mysql\Schema
loadTableDefaultValues()		yii\db\mysql\Schema
loadTableForeignKeys()		yii\db\mysql\Schema
loadTableIndexes()		yii\db\mysql\Schema
loadTablePrimaryKey()		yii\db\mysql\Schema
loadTableSchema()	Loads the metadata for the specified table.	yii\db\mysql\Schema
loadTableUniques()		yii\db\mysql\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\mysql\Schema
resolveTableNames()	解析表明和数据库结构名称（如果存在的话）。	yii\db\mysql\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 受保护属性

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

Column schema class or class config

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

$tableQuoteCharacter 受保护属性

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 array $typeMap = ['tinyint' => self::TYPE_TINYINT, 'bit' => self::TYPE_INTEGER, 'smallint' => self::TYPE_SMALLINT, 'mediumint' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'float' => self::TYPE_FLOAT, 'double' => self::TYPE_DOUBLE, 'real' => self::TYPE_FLOAT, 'decimal' => self::TYPE_DECIMAL, 'numeric' => self::TYPE_DECIMAL, 'tinytext' => self::TYPE_TEXT, 'mediumtext' => self::TYPE_TEXT, 'longtext' => self::TYPE_TEXT, 'longblob' => self::TYPE_BINARY, 'blob' => self::TYPE_BINARY, 'text' => self::TYPE_TEXT, 'varchar' => self::TYPE_STRING, 'string' => self::TYPE_STRING, 'char' => self::TYPE_CHAR, 'datetime' => self::TYPE_DATETIME, 'year' => self::TYPE_DATE, 'date' => self::TYPE_DATE, 'time' => self::TYPE_TIME, 'timestamp' => self::TYPE_TIMESTAMP, 'enum' => self::TYPE_STRING, 'varbinary' => self::TYPE_BINARY, 'json' => self::TYPE_JSON]

方法详情

createColumnSchemaBuilder() 公共方法

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\mysql\ColumnSchemaBuilder::$type.
$length	integer\|string\|array	Length or precision of the column. See yii\db\mysql\ColumnSchemaBuilder::$length.
return	yii\db\ColumnSchemaBuilder	Column schema builder instance

createQueryBuilder() 公共方法

创建 MySQL 数据库的查询构建器。

public yii\db\mysql\QueryBuilder createQueryBuilder()
return	yii\db\mysql\QueryBuilder	查询构建器实例

findColumns() 受保护方法

搜集表列的元数据。

protected boolean findColumns($table)
$table	yii\db\TableSchema	表元数据
return	boolean	表是否存在于数据库中
throws	Exception	当 DB 查询失败时，抛出异常

findConstraints() 受保护方法

搜集给定表的外键列的细节。

protected void findConstraints($table)
$table	yii\db\TableSchema	表元数据
throws	Exception

findTableNames() 受保护方法

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() 公共方法

返回给定表的所有唯一索引。

每个数组元素的结构如下：

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

public array findUniqueIndexes($table)
$table	yii\db\TableSchema	表元数据
return	array	给定表的所有唯一索引。

getCreateTableSql() 受保护方法

获取 CREATE TABLE 的 sql 字符串。

protected string getCreateTableSql($table)
$table	yii\db\TableSchema	表元数据
return	string	$sql 'SHOW CREATE TABLE' 语句执行结果

isOldMysql() 受保护方法（自版本 2.0.13 可用）

protected boolean isOldMysql()
return	boolean	所使用的 MySQL 版本是否早于 5.1 。
throws	yii\base\InvalidConfigException
throws	yii\db\Exception

loadColumnSchema() 受保护方法

加载列信息到 yii\db\mysql\ColumnSchema 对象。

protected yii\db\mysql\ColumnSchema loadColumnSchema($info)
$info	array	列信息
return	yii\db\mysql\ColumnSchema	列架构对象

loadTableChecks() 受保护方法

protected void loadTableChecks($tableName)
$tableName
throws	yii\base\NotSupportedException	如果调用此方法，则抛出 NotSupportedException 异常。

loadTableDefaultValues() 受保护方法

protected void loadTableDefaultValues($tableName)
$tableName
throws	yii\base\NotSupportedException	如果调用此方法，则抛出 NotSupportedException 异常。

loadTableForeignKeys() 受保护方法

protected void loadTableForeignKeys($tableName)
$tableName

loadTableIndexes() 受保护方法

protected void loadTableIndexes($tableName)
$tableName

loadTablePrimaryKey() 受保护方法

protected void loadTablePrimaryKey($tableName)
$tableName

loadTableSchema() 受保护方法

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 void loadTableUniques($tableName)
$tableName

resolveTableName() 受保护方法

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

protected yii\db\TableSchema resolveTableName($name)
$name	string	The table name
return	yii\db\TableSchema	yii\db\TableSchema with resolved table, schema, etc. names.
throws	yii\base\NotSupportedException	if this method is not supported by the DBMS.

resolveTableNames() 受保护方法

解析表明和数据库结构名称（如果存在的话）。

protected void resolveTableNames($table, $name)
$table	yii\db\TableSchema	表元数据对象
$name	string	表名