CDbSchema

Package	system.db.schema
Inheritance	abstract class CDbSchema » CComponent
Subclasses	CCubridSchema, CMssqlSchema, CMysqlSchema, COciSchema, CPgsqlSchema, CSqliteSchema
Since	1.0
Source Code	framework/db/schema/CDbSchema.php

Property Details

the abstract column types mapped to physical column types.

the SQL command builder for this connection.

database connection. The connection is active.

Returns all table names in the database.

Returns the metadata for all tables in the database.

Method Details

public void __construct(CDbConnection $conn)
$conn	CDbConnection	database connection.

Constructor.

public string addColumn(string $table, string $column, string $type)
$table	string	the table that the new column will be added to. The table name will be properly quoted by the method.
$column	string	the name of the new column. The name will be properly quoted by the method.
$type	string	the 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 adding a new column.

Builds a SQL statement for adding a new DB column.

public string addForeignKey(string $name, string $table, string|array $columns, string $refTable, string|array $refColumns, string $delete=NULL, string $update=NULL)
$name	string	the name of the foreign key constraint.
$table	string	the table that the foreign key constraint will be added to.
$columns	string|array	the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or pass as an array of column names.
$refTable	string	the table that the foreign key references to.
$refColumns	string|array	the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or pass as an array of column names.
$delete	string	the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
$update	string	the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
{return}	string	the SQL statement for adding a foreign key constraint to an existing table.

Builds a SQL statement for adding a foreign key constraint to an existing table. The method will properly quote the table and column names.

public string addPrimaryKey(string $name, string $table, string|array $columns)
$name	string	the name of the primary key constraint.
$table	string	the table that the primary key constraint will be added to.
$columns	string|array	comma separated string or array of columns that the primary key will consist of. Array value can be passed since 1.1.14.
{return}	string	the SQL statement for adding a primary key constraint to an existing table.

Builds a SQL statement for adding a primary key constraint to an existing table.

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 CDbCommandBuilder createCommandBuilder()
{return}	CDbCommandBuilder	command builder instance

Creates a command builder for the database. This method may be overridden by child classes to create a DBMS-specific command builder.

public string createIndex(string $name, string $table, string|array $columns, boolean $unique=false)
$name	string	the name of the index. The name will be properly quoted by the method.
$table	string	the table that the new index will be created for. The table name will be properly quoted by the method.
$columns	string|array	the column(s) that should be included in the index. If there are multiple columns, please separate them by commas or pass as an array of column names. Each column name will be properly quoted by the method, unless a parenthesis is found in the name.
$unique	boolean	whether to add UNIQUE constraint on the created index.
{return}	string	the SQL statement for creating a new index.

Builds a SQL statement for creating a new index.

public string createTable(string $table, array $columns, string $options=NULL)
$table	string	the name of the table to be created. The name will be properly quoted by the method.
$columns	array	the columns (name=>definition) in the new table.
$options	string	additional SQL fragment that will be appended to the generated SQL.
{return}	string	the SQL statement for creating a new DB table.

Builds a SQL statement for creating a new DB table.

The columns in the new table should be specified as name-definition pairs (e.g. 'name'=>'string'), where name stands for a column name which will be properly quoted by the method, and definition stands for the column type which can contain an abstract DB type. The getColumnType method will be invoked to convert any abstract type into a physical one.

If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly inserted into the generated SQL.

public string dropColumn(string $table, string $column)
$table	string	the table whose column is to be dropped. The name will be properly quoted by the method.
$column	string	the name of the column to be dropped. The name will be properly quoted by the method.
{return}	string	the SQL statement for dropping a DB column.

Builds a SQL statement for dropping a DB column.

public string dropForeignKey(string $name, string $table)
$name	string	the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
$table	string	the table whose foreign is to be dropped. The name will be properly quoted by the method.
{return}	string	the SQL statement for dropping a foreign key constraint.

Builds a SQL statement for dropping a foreign key constraint.

public string dropIndex(string $name, string $table)
$name	string	the name of the index to be dropped. The name will be properly quoted by the method.
$table	string	the table whose index is to be dropped. The name will be properly quoted by the method.
{return}	string	the SQL statement for dropping an index.

Builds a SQL statement for dropping an index.

public string dropPrimaryKey(string $name, string $table)
$name	string	the name of the primary key constraint to be removed.
$table	string	the table that the primary key constraint will be removed from.
{return}	string	the SQL statement for removing a primary key constraint from an existing table.

Builds a SQL statement for removing a primary key constraint to an existing table.

public string dropTable(string $table)
$table	string	the table to be dropped. The name will be properly quoted by the method.
{return}	string	the SQL statement for dropping a DB table.

Builds a SQL statement for dropping a DB table.

protected array findTableNames(string $schema='')
$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.
{return}	array	all table names in the database.

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.

public string getColumnType(string $type)
$type	string	abstract column type
{return}	string	physical column type.

Converts an abstract column type into a physical column type. The conversion is done using the type map specified in columnTypes. These abstract column types are supported (using MySQL as example to explain the corresponding physical types):

• pk and bigpk: an auto-incremental primary key type, will be converted into "int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY" or "bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY"
• string: string type, will be converted into "varchar(255)"
• text: a long string type, will be converted into "text"
• integer: integer type, will be converted into "int(11)"
• bigint: integer type, will be converted into "bigint(20)"
• boolean: boolean type, will be converted into "tinyint(1)"
• float: float number type, will be converted into "float"
• decimal: decimal number type, will be converted into "decimal"
• datetime: datetime type, will be converted into "datetime"
• timestamp: timestamp type, will be converted into "timestamp"
• time: time type, will be converted into "time"
• date: date type, will be converted into "date"
• binary: binary data type, will be converted into "blob"

If the abstract type contains two or more parts separated by spaces (e.g. "string NOT NULL"), then only the first part will be converted, and the rest of the parts will be appended to the conversion result. For example, 'string NOT NULL' is converted to 'varchar(255) NOT NULL'.

public CDbCommandBuilder getCommandBuilder()
{return}	CDbCommandBuilder	the SQL command builder for this connection.

public CDbConnection getDbConnection()
{return}	CDbConnection	database connection. The connection is active.

public CDbTableSchema getTable(string $name, boolean $refresh=false)
$name	string	table name
$refresh	boolean	if we need to refresh schema cache for a table. Parameter available since 1.1.9
{return}	CDbTableSchema	table metadata. Null if the named table does not exist.

Obtains the metadata for the named table.

public array getTableNames(string $schema='')
$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.
{return}	array	all table names in the database.

Returns all table names in the database.

public array getTables(string $schema='')
$schema	string	the schema of the tables. Defaults to empty string, meaning the current or default schema.
{return}	array	the metadata for all tables in the database. Each array element is an instance of CDbTableSchema (or its child class). The array keys are table names.

Returns the metadata for all tables in the database.

abstract protected CDbTableSchema loadTable(string $name)
$name	string	table name
{return}	CDbTableSchema	driver dependent table metadata, null if the table does not exist.

Loads the metadata for the specified table.

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

Quotes a column name for use in a query. If the column name contains prefix, the prefix will also be properly quoted.

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

Quotes a simple 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 simple table name for use in a query. A simple table name does not schema prefix.

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

Quotes a table name for use in a query. If the table name contains schema prefix, the prefix will also be properly quoted.

public void refresh()

Refreshes the schema. This method resets the loaded table metadata and command builder so that they can be recreated to reflect the change of schema.

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).

public string truncateTable(string $table)
$table	string	the table to be truncated. The name will be properly quoted by the method.
{return}	string	the SQL statement for truncating a DB table.

Builds a SQL statement for truncating a DB table.