0 follower

COciSchema

Package system.db.schema.oci
Inheritance class COciSchema » CDbSchema » CComponent
Source Code framework/db/schema/oci/COciSchema.php
COciSchema is the class for retrieving metadata information from an Oracle database.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
columnTypes array the abstract column types mapped to physical column types. COciSchema
commandBuilder CDbCommandBuilder the SQL command builder for this connection. CDbSchema
dbConnection CDbConnection database connection. CDbSchema
defaultSchema string default schema. COciSchema
tableNames array Returns all table names in the database. CDbSchema
tables array Returns the metadata for all tables in the database. CDbSchema

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CDbSchema
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
addColumn() Builds a SQL statement for adding a new DB column. CDbSchema
addForeignKey() Builds a SQL statement for adding a foreign key constraint to an existing table. CDbSchema
addPrimaryKey() Builds a SQL statement for adding a primary key constraint to an existing table. CDbSchema
alterColumn() Builds a SQL statement for changing the definition of a column. COciSchema
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
checkIntegrity() Enables or disables integrity check. COciSchema
compareTableNames() Compares two table names. CDbSchema
createIndex() Builds a SQL statement for creating a new index. CDbSchema
createTable() Builds a SQL statement for creating a new DB table. CDbSchema
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
dropColumn() Builds a SQL statement for dropping a DB column. CDbSchema
dropForeignKey() Builds a SQL statement for dropping a foreign key constraint. CDbSchema
dropIndex() Builds a SQL statement for dropping an index. COciSchema
dropPrimaryKey() Builds a SQL statement for removing a primary key constraint to an existing table. CDbSchema
dropTable() Builds a SQL statement for dropping a DB table. CDbSchema
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getColumnType() Converts an abstract column type into a physical column type. CDbSchema
getCommandBuilder() Returns the SQL command builder for this connection. CDbSchema
getDbConnection() Returns database connection. The connection is active. CDbSchema
getDefaultSchema() Returns default schema. COciSchema
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getTable() Obtains the metadata for the named table. CDbSchema
getTableNames() Returns all table names in the database. CDbSchema
getTables() Returns the metadata for all tables in the database. CDbSchema
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
quoteColumnName() Quotes a column name for use in a query. CDbSchema
quoteSimpleColumnName() Quotes a column name for use in a query. COciSchema
quoteSimpleTableName() Quotes a table name for use in a query. COciSchema
quoteTableName() Quotes a table name for use in a query. CDbSchema
raiseEvent() Raises an event. CComponent
refresh() Refreshes the schema. CDbSchema
renameColumn() Builds a SQL statement for renaming a column. CDbSchema
renameTable() Builds a SQL statement for renaming a DB table. COciSchema
resetSequence() Resets the sequence value of a table's primary key. COciSchema
setDefaultSchema() Sets default schema. COciSchema
truncateTable() Builds a SQL statement for truncating a DB table. CDbSchema

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createColumn() Creates a table column. COciSchema
createCommandBuilder() Creates a command builder for the database. COciSchema
findColumns() Collects the table column metadata. COciSchema
findConstraints() Collects the primary and foreign key column details for the given table. COciSchema
findTableNames() Returns all table names in the database. COciSchema
getSchemaTableName() Returns tuple as ($schemaName,$tableName) COciSchema
loadTable() Loads the metadata for the specified table. COciSchema
resolveTableNames() Generates various kinds of table names. COciSchema

Property Details

columnTypes property (available since v1.1.6)
public array $columnTypes;

the abstract column types mapped to physical column types.

defaultSchema property
public string getDefaultSchema()
public void setDefaultSchema(string $schema)

default schema.

Method Details

alterColumn() method (available since v1.1.6)
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.
Source Code: framework/db/schema/oci/COciSchema.php#334 (show)
public function alterColumn($table, $column, $type)
{
    $type=$this->getColumnType($type);
    $sql='ALTER TABLE ' . $this->quoteTableName($table) . ' MODIFY '
        . $this->quoteColumnName($column) . ' '
        . $this->getColumnType($type);
    return $sql;
}

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

checkIntegrity() method (available since v1.1.14)
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.
Source Code: framework/db/schema/oci/COciSchema.php#397 (show)
public function checkIntegrity($check=true,$schema='')
{
    if($schema==='')
        $schema=$this->getDefaultSchema();
    $mode=$check ? 'ENABLE' : 'DISABLE';
    foreach($this->getTableNames($schema) as $table)
    {
        $constraints=$this->getDbConnection()
            ->createCommand("SELECT CONSTRAINT_NAME FROM USER_CONSTRAINTS WHERE TABLE_NAME=:t AND OWNER=:o")
            ->queryColumn(array(':t'=>$table,':o'=>$schema));
        foreach($constraints as $constraint)
            $this->getDbConnection()
                ->createCommand("ALTER TABLE \"{$schema}\".\"{$table}\" {$mode} CONSTRAINT \"{$constraint}\"")
                ->execute();
    }
}

Enables or disables integrity check.

createColumn() method
protected CDbColumnSchema createColumn(array $column)
$column array column metadata
{return} CDbColumnSchema normalized column metadata
Source Code: framework/db/schema/oci/COciSchema.php#228 (show)
protected function createColumn($column)
{
    $c=new COciColumnSchema;
    $c->name=$column['COLUMN_NAME'];
    $c->rawName=$this->quoteColumnName($c->name);
    $c->allowNull=$column['NULLABLE']==='Y';
    $c->isPrimaryKey=strpos((string)$column['KEY'],'P')!==false;
    $c->isForeignKey=false;
    $c->init($column['DATA_TYPE'],$column['DATA_DEFAULT']);
    $c->comment=$column['COLUMN_COMMENT']===null ? '' : $column['COLUMN_COMMENT'];

    return $c;
}

Creates a table column.

createCommandBuilder() method
protected CDbCommandBuilder createCommandBuilder()
{return} CDbCommandBuilder command builder instance
Source Code: framework/db/schema/oci/COciSchema.php#74 (show)
protected function createCommandBuilder()
{
    return new COciCommandBuilder($this);
}

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

dropIndex() method (available since v1.1.6)
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.
Source Code: framework/db/schema/oci/COciSchema.php#350 (show)
public function dropIndex($name, $table)
{
    return 'DROP INDEX '.$this->quoteTableName($name);
}

Builds a SQL statement for dropping an index.

findColumns() method
protected boolean findColumns(COciTableSchema $table)
$table COciTableSchema the table metadata
{return} boolean whether the table exists in the database
Source Code: framework/db/schema/oci/COciSchema.php#162 (show)
protected function findColumns($table)
{
    $schemaName=$table->schemaName;
    $tableName=$table->name;

    $sql=<<<EOD
SELECT a.column_name, a.data_type ||
case
    when data_precision is not null
        then '(' || a.data_precision ||
                case when a.data_scale > 0 then ',' || a.data_scale else '' end
            || ')'
    when data_type = 'DATE' then ''
    when data_type = 'NUMBER' then ''
    else '(' || to_char(a.data_length) || ')'
end as data_type,
a.nullable, a.data_default,
(   SELECT D.constraint_type
    FROM ALL_CONS_COLUMNS C
    inner join ALL_constraints D on D.OWNER = C.OWNER and D.constraint_name = C.constraint_name
    WHERE C.OWNER = B.OWNER
       and C.table_name = B.object_name
       and C.column_name = A.column_name
       and D.constraint_type = 'P') as Key,
com.comments as column_comment
FROM ALL_TAB_COLUMNS A
inner join ALL_OBJECTS B ON b.owner = a.owner and ltrim(B.OBJECT_NAME) = ltrim(A.TABLE_NAME)
LEFT JOIN all_col_comments com ON (A.owner = com.owner AND A.table_name = com.table_name AND A.column_name = com.column_name)
WHERE
a.owner = '{$schemaName}'
and (b.object_type = 'TABLE' or b.object_type = 'VIEW')
and b.object_name = '{$tableName}'
ORDER by a.column_id
EOD;

    $command=$this->getDbConnection()->createCommand($sql);

    if(($columns=$command->queryAll())===array()){
        return false;
    }

    foreach($columns as $column)
    {
        $c=$this->createColumn($column);

        $table->columns[$c->name]=$c;
        if($c->isPrimaryKey)
        {
            if($table->primaryKey===null)
                $table->primaryKey=$c->name;
            elseif(is_string($table->primaryKey))
                $table->primaryKey=array($table->primaryKey,$c->name);
            else
                $table->primaryKey[]=$c->name;
            $table->sequenceName='';
            $c->autoIncrement=true;
        }
    }
    return true;
}

Collects the table column metadata.

findConstraints() method
protected void findConstraints(COciTableSchema $table)
$table COciTableSchema the table metadata
Source Code: framework/db/schema/oci/COciSchema.php#246 (show)
protected function findConstraints($table)
{
    $sql=<<<EOD
    SELECT D.constraint_type as CONSTRAINT_TYPE, C.COLUMN_NAME, C.position, D.r_constraint_name,
            E.table_name as table_ref, f.column_name as column_ref,
            C.table_name
    FROM ALL_CONS_COLUMNS C
    inner join ALL_constraints D on D.OWNER = C.OWNER and D.constraint_name = C.constraint_name
    left join ALL_constraints E on E.OWNER = D.r_OWNER and E.constraint_name = D.r_constraint_name
    left join ALL_cons_columns F on F.OWNER = E.OWNER and F.constraint_name = E.constraint_name and F.position = c.position
    WHERE C.OWNER = '{$table->schemaName}'
       and C.table_name = '{$table->name}'
       and D.constraint_type <> 'P'
    order by d.constraint_name, c.position
EOD;
    $command=$this->getDbConnection()->createCommand($sql);
    foreach($command->queryAll() as $row)
    {
        if($row['CONSTRAINT_TYPE']==='R')   // foreign key
        {
            $name = $row["COLUMN_NAME"];
            $table->foreignKeys[$name]=array($row["TABLE_REF"], $row["COLUMN_REF"]);
            if(isset($table->columns[$name]))
                $table->columns[$name]->isForeignKey=true;
        }

    }
}

Collects the primary and foreign key column details for the given table.

findTableNames() method
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.
Source Code: framework/db/schema/oci/COciSchema.php#281 (show)
protected function findTableNames($schema='')
{
    if($schema==='')
    {
        $sql=<<<EOD
SELECT table_name, '{$schema}' as table_schema FROM user_tables
EOD;
        $command=$this->getDbConnection()->createCommand($sql);
    }
    else
    {
        $sql=<<<EOD
SELECT object_name as table_name, owner as table_schema FROM all_objects
WHERE object_type = 'TABLE' AND owner=:schema
EOD;
        $command=$this->getDbConnection()->createCommand($sql);
        $command->bindParam(':schema',$schema);
    }

    $rows=$command->queryAll();
    $names=array();
    foreach($rows as $row)
    {
        if($schema===$this->getDefaultSchema() || $schema==='')
            $names[]=$row['TABLE_NAME'];
        else
            $names[]=$row['TABLE_SCHEMA'].'.'.$row['TABLE_NAME'];
    }
    return $names;
}

Returns all table names in the database.

getDefaultSchema() method
public string getDefaultSchema()
{return} string default schema.
Source Code: framework/db/schema/oci/COciSchema.php#90 (show)
public function getDefaultSchema()
{
    if (!strlen($this->_defaultSchema))
    {
        $this->setDefaultSchema(strtoupper($this->getDbConnection()->username));
    }

    return $this->_defaultSchema;
}

getSchemaTableName() method
protected array getSchemaTableName(string $table)
$table string table name with optional schema name prefix, uses default schema name prefix is not provided.
{return} array tuple as ($schemaName,$tableName)
Source Code: framework/db/schema/oci/COciSchema.php#104 (show)
protected function getSchemaTableName($table)
{
    $table = strtoupper($table);
    if(count($parts= explode('.', str_replace('"','',$table))) > 1)
        return array($parts[0], $parts[1]);
    else
        return array($this->getDefaultSchema(),$parts[0]);
}

loadTable() method
protected CDbTableSchema loadTable(string $name)
$name string table name
{return} CDbTableSchema driver dependent table metadata.
Source Code: framework/db/schema/oci/COciSchema.php#118 (show)
protected function loadTable($name)
{
    $table=new COciTableSchema;
    $this->resolveTableNames($table,$name);

    if(!$this->findColumns($table))
        return null;
    $this->findConstraints($table);

    return $table;
}

Loads the metadata for the specified table.

quoteSimpleColumnName() method (available since v1.1.6)
public string quoteSimpleColumnName(string $name)
$name string column name
{return} string the properly quoted column name
Source Code: framework/db/schema/oci/COciSchema.php#64 (show)
public function quoteSimpleColumnName($name)
{
    return '"'.$name.'"';
}

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

quoteSimpleTableName() method (available since v1.1.6)
public string quoteSimpleTableName(string $name)
$name string table name
{return} string the properly quoted table name
Source Code: framework/db/schema/oci/COciSchema.php#52 (show)
public function quoteSimpleTableName($name)
{
    return '"'.$name.'"';
}

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

renameTable() method (available since v1.1.6)
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.
Source Code: framework/db/schema/oci/COciSchema.php#319 (show)
public function renameTable($table, $newName)
{
    return 'ALTER TABLE ' . $this->quoteTableName($table) . ' RENAME TO ' . $this->quoteTableName($newName);
}

Builds a SQL statement for renaming a DB table.

resetSequence() method (available since v1.1.13)
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).
Source Code: framework/db/schema/oci/COciSchema.php#369 (show)
public function resetSequence($table,$value=null)
{
    if($table->sequenceName===null)
        return;

    if($value!==null)
        $value=(int)$value;
    else
    {
        $value=(int)$this->getDbConnection()
            ->createCommand("SELECT MAX(\"{$table->primaryKey}\") FROM {$table->rawName}")
            ->queryScalar();
        $value++;
    }
    $this->getDbConnection()
        ->createCommand("DROP SEQUENCE \"{$table->name}_SEQ\"")
        ->execute();
    $this->getDbConnection()
        ->createCommand("CREATE SEQUENCE \"{$table->name}_SEQ\" START WITH {$value} INCREMENT BY 1 NOMAXVALUE NOCACHE")
        ->execute();
}

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

Note, behavior of this method has changed since 1.1.14 release. Please refer to the following issue for more details: https://github.com/yiisoft/yii/issues/2241

resolveTableNames() method
protected void resolveTableNames(COciTableSchema $table, string $name)
$table COciTableSchema the table instance
$name string the unquoted table name
Source Code: framework/db/schema/oci/COciSchema.php#135 (show)
protected function resolveTableNames($table,$name)
{
    $parts=explode('.',str_replace('"','',$name));
    if(isset($parts[1]))
    {
        $schemaName=$parts[0];
        $tableName=$parts[1];
    }
    else
    {
        $schemaName=$this->getDefaultSchema();
        $tableName=$parts[0];
    }

    $table->name=$tableName;
    $table->schemaName=$schemaName;
    if($schemaName===$this->getDefaultSchema())
        $table->rawName=$this->quoteTableName($tableName);
    else
        $table->rawName=$this->quoteTableName($schemaName).'.'.$this->quoteTableName($tableName);
}

Generates various kinds of table names.

setDefaultSchema() method
public void setDefaultSchema(string $schema)
$schema string default schema.
Source Code: framework/db/schema/oci/COciSchema.php#82 (show)
public function setDefaultSchema($schema)
{
    $this->_defaultSchema=$schema;
}