CMssqlSchema

Package	system.db.schema.mssql
Inheritance	class CMssqlSchema » CDbSchema » CComponent
Source Code	framework/db/schema/mssql/CMssqlSchema.php

Property Details

the abstract column types mapped to physical column types.

Method Details

public string alterColumn(string $table, string $column, string $type)
$table	string	the table whose column is to be changed. The table name will be properly quoted by the method.
$column	string	the name of the column to be changed. The name will be properly quoted by the method.
$type	string	the new column type. The getColumnType method will be invoked to convert abstract column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
{return}	string	the SQL statement for changing the definition of a column.

Builds a SQL statement for changing the definition of a column.

public void checkIntegrity(boolean $check=true, string $schema='')
$check	boolean	whether to turn on or off the integrity check.
$schema	string	the schema of the tables. Defaults to empty string, meaning the current or default schema.

Enables or disables integrity check.

public boolean compareTableNames(string $name1, string $name2)
$name1	string	table name 1
$name2	string	table name 2
{return}	boolean	whether the two table names refer to the same table.

Compares two table names. The table names can be either quoted or unquoted. This method will consider both cases.

protected CDbColumnSchema createColumn(array $column)
$column	array	column metadata
{return}	CDbColumnSchema	normalized column metadata

Creates a table column.

protected CDbCommandBuilder createCommandBuilder()
{return}	CDbCommandBuilder	command builder instance

Creates a command builder for the database. This method overrides parent implementation in order to create a MSSQL specific command builder

protected boolean findColumns(CMssqlTableSchema $table)
$table	CMssqlTableSchema	the table metadata
{return}	boolean	whether the table exists in the database

Collects the table column metadata.

protected array findForeignKeys(CMssqlTableSchema $table)
$table	CMssqlTableSchema	table
{return}	array	foreign relationship table name and keys.

Gets foreign relationship constraint keys and table name

protected mixed findPrimaryKey(CMssqlTableSchema $table)
$table	CMssqlTableSchema	table
{return}	mixed	primary keys (null if no pk, string if only 1 column pk, or array if composite pk)

Gets the primary key column(s) details for the given table.

protected array findTableNames(string $schema='', boolean $includeViews=true)
$schema	string	the schema of the tables. Defaults to empty string, meaning the current or default schema. If not empty, the returned table names will be prefixed with the schema name.
$includeViews	boolean	whether to include views in the result. Defaults to true.
{return}	array	all table names in the database.

Returns all table names in the database.

protected CMssqlTableSchema loadTable(string $name)
$name	string	table name
{return}	CMssqlTableSchema	driver dependent table metadata. Null if the table does not exist.

Loads the metadata for the specified table.

public string quoteSimpleColumnName(string $name)
$name	string	column name
{return}	string	the properly quoted column name

Quotes a column name for use in a query. A simple column name does not contain prefix.

public string quoteSimpleTableName(string $name)
$name	string	table name
{return}	string	the properly quoted table name

Quotes a table name for use in a query. A simple table name does not schema prefix.

public string renameColumn(string $table, string $name, string $newName)
$table	string	the table whose column is to be renamed. The name will be properly quoted by the method.
$name	string	the old name of the column. The name will be properly quoted by the method.
$newName	string	the new name of the column. The name will be properly quoted by the method.
{return}	string	the SQL statement for renaming a DB column.

Builds a SQL statement for renaming a column.

public string renameTable(string $table, string $newName)
$table	string	the table to be renamed. The name will be properly quoted by the method.
$newName	string	the new table name. The name will be properly quoted by the method.
{return}	string	the SQL statement for renaming a DB table.

Builds a SQL statement for renaming a DB table.

public void resetSequence(CDbTableSchema $table, integer|null $value=NULL)
$table	CDbTableSchema	the table schema whose primary key sequence will be reset
$value	integer|null	the value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have the max value of a primary key plus one (i.e. sequence trimming).

Resets the sequence value of a table's primary key. The sequence will be reset such that the primary key of the next new row inserted will have the specified value or max value of a primary key plus one (i.e. sequence trimming).

protected void resolveTableNames(CMssqlTableSchema $table, string $name)
$table	CMssqlTableSchema	the table instance
$name	string	the unquoted table name

Generates various kinds of table names.