0 follower

CPgsqlSchema

Package system.db.schema.pgsql
Inheritance class CPgsqlSchema » CDbSchema » CComponent
Since 1.0
Source Code framework/db/schema/pgsql/CPgsqlSchema.php
CPgsqlSchema is the class for retrieving metadata information from a PostgreSQL database.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
columnTypes array the abstract column types mapped to physical column types. CPgsqlSchema
commandBuilder CDbCommandBuilder the SQL command builder for this connection. CDbSchema
dbConnection CDbConnection database connection. CDbSchema
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. CPgsqlSchema
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. CPgsqlSchema
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. CPgsqlSchema
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. CPgsqlSchema
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
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 simple column name for use in a query. CDbSchema
quoteSimpleTableName() Quotes a table name for use in a query. CPgsqlSchema
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. CPgsqlSchema
resetSequence() Resets the sequence value of a table's primary key. CPgsqlSchema
truncateTable() Builds a SQL statement for truncating a DB table. CDbSchema

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createColumn() Creates a table column. CPgsqlSchema
createCommandBuilder() Creates a command builder for the database. CPgsqlSchema
findColumns() Collects the table column metadata. CPgsqlSchema
findConstraints() Collects the primary and foreign key column details for the given table. CPgsqlSchema
findForeignKey() Collects foreign key information. CPgsqlSchema
findPrimaryKey() Collects primary key information. CPgsqlSchema
findTableNames() Returns all table names in the database. CPgsqlSchema
loadTable() Loads the metadata for the specified table. CPgsqlSchema
resolveTableNames() Generates various kinds of table names. CPgsqlSchema

Property Details

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

the abstract column types mapped to physical column types.

Method Details

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

Builds a SQL statement for adding a new DB column.

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/pgsql/CPgsqlSchema.php#416 (show)
public function alterColumn($table, $column, $type)
{
    $type=$this->getColumnType($type);
    $sql='ALTER TABLE ' . $this->quoteTableName($table) . ' ALTER COLUMN '
        . $this->quoteColumnName($column) . ' TYPE ' . $this->getColumnType($type);
    return $sql;
}

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

checkIntegrity() method (available since v1.1)
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/pgsql/CPgsqlSchema.php#90 (show)
public function checkIntegrity($check=true,$schema='')
{
    $enable=$check ? 'ENABLE' : 'DISABLE';
    $tableNames=$this->getTableNames($schema);
    $db=$this->getDbConnection();
    foreach($tableNames as $tableName)
    {
        $tableName='"'.$tableName.'"';
        if(strpos($tableName,'.')!==false)
            $tableName=str_replace('.','"."',$tableName);
        $db->createCommand("ALTER TABLE $tableName $enable TRIGGER ALL")->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/pgsql/CPgsqlSchema.php#211 (show)
protected function createColumn($column)
{
    $c=new CPgsqlColumnSchema;
    $c->name=$column['attname'];
    $c->rawName=$this->quoteColumnName($c->name);
    $c->allowNull=!$column['attnotnull'];
    $c->isPrimaryKey=false;
    $c->isForeignKey=false;
    $c->comment=$column['comment']===null ? '' : $column['comment'];

    $c->init($column['type'],$column['atthasdef'] ? $column['adsrc'] : null);

    return $c;
}

Creates a table column.

createCommandBuilder() method
protected CPgsqlCommandBuilder createCommandBuilder()
{return} CPgsqlCommandBuilder command builder instance.
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#441 (show)
protected function createCommandBuilder()
{
    return new CPgsqlCommandBuilder($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/pgsql/CPgsqlSchema.php#431 (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(CPgsqlTableSchema $table)
$table CPgsqlTableSchema the table metadata
{return} boolean whether the table exists in the database
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#166 (show)
protected function findColumns($table)
{
    $sql=<<<EOD
SELECT
a.attname,
LOWER(format_type(a.atttypid, a.atttypmod)) AS type,
pg_get_expr(adbin, adrelid) AS adsrc,
a.attnotnull,
a.atthasdef,
pg_catalog.col_description(a.attrelid, a.attnum) AS comment
FROM pg_attribute a LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
WHERE a.attnum > 0 AND NOT a.attisdropped
AND a.attrelid = (SELECT oid FROM pg_catalog.pg_class WHERE relname=:table
    AND relnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname = :schema))
ORDER BY a.attnum
EOD;
    $command=$this->getDbConnection()->createCommand($sql);
    $command->bindValue(':table',$table->name);
    $command->bindValue(':schema',$table->schemaName);

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

    foreach($columns as $column)
    {
        $c=$this->createColumn($column);
        $table->columns[$c->name]=$c;

        if(stripos($column['adsrc'],'nextval')===0 && preg_match('/nextval\([^\']*\'([^\']+)\'[^\)]*\)/i',$column['adsrc'],$matches))
        {
            if(strpos($matches[1],'.')!==false || $table->schemaName===self::DEFAULT_SCHEMA)
                $this->_sequences[$table->rawName.'.'.$c->name]=$matches[1];
            else
                $this->_sequences[$table->rawName.'.'.$c->name]=$table->schemaName.'.'.$matches[1];
            $c->autoIncrement=true;
        }
    }
    return true;
}

Collects the table column metadata.

findConstraints() method
protected void findConstraints(CPgsqlTableSchema $table)
$table CPgsqlTableSchema the table metadata
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#230 (show)
protected function findConstraints($table)
{
    $sql=<<<EOD
SELECT
conname,
consrc,
contype,
indkey
FROM (
SELECT
    conname,
    pg_catalog.pg_get_constraintdef(oid) AS consrc,
    contype,
    conrelid AS relid,
    NULL AS indkey
FROM
    pg_catalog.pg_constraint
WHERE
    contype IN ('f', 'c')
UNION ALL
SELECT
    pc.relname,
    NULL,
    CASE WHEN indisprimary THEN
            'p'
    ELSE
            'u'
    END,
    pi.indrelid,
    indkey
FROM
    pg_catalog.pg_class pc,
    pg_catalog.pg_index pi
WHERE
    pc.oid=pi.indexrelid
    AND EXISTS (
        SELECT 1 FROM pg_catalog.pg_depend d JOIN pg_catalog.pg_constraint c
        ON (d.refclassid = c.tableoid AND d.refobjid = c.oid)
        WHERE d.classid = pc.tableoid AND d.objid = pc.oid AND d.deptype = 'i' AND c.contype IN ('u', 'p')
)
) AS sub
WHERE relid = (SELECT oid FROM pg_catalog.pg_class WHERE relname=:table
AND relnamespace = (SELECT oid FROM pg_catalog.pg_namespace
WHERE nspname=:schema))
EOD;
    $command=$this->getDbConnection()->createCommand($sql);
    $command->bindValue(':table',$table->name);
    $command->bindValue(':schema',$table->schemaName);
    foreach($command->queryAll() as $row)
    {
        if($row['contype']==='p') // primary key
            $this->findPrimaryKey($table,$row['indkey']);
        elseif($row['contype']==='f') // foreign key
            $this->findForeignKey($table,$row['consrc']);
    }
}

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

findForeignKey() method
protected void findForeignKey(CPgsqlTableSchema $table, string $src)
$table CPgsqlTableSchema the table metadata
$src string pgsql foreign key definition
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#328 (show)
protected function findForeignKey($table,$src)
{
    $matches=array();
    $brackets='\(([^\)]+)\)';
    $pattern="/FOREIGN\s+KEY\s+{$brackets}\s+REFERENCES\s+([^\(]+){$brackets}/i";
    if(preg_match($pattern,str_replace('"','',$src),$matches))
    {
        $keys=preg_split('/,\s+/', $matches[1]);
        $tableName=$matches[2];
        $fkeys=preg_split('/,\s+/', $matches[3]);
        foreach($keys as $i=>$key)
        {
            $table->foreignKeys[$key]=array($tableName,$fkeys[$i]);
            if(isset($table->columns[$key]))
                $table->columns[$key]->isForeignKey=true;
        }
    }
}

Collects foreign key information.

findPrimaryKey() method
protected void findPrimaryKey(CPgsqlTableSchema $table, string $indices)
$table CPgsqlTableSchema the table metadata
$indices string pgsql primary key index list
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#292 (show)
protected function findPrimaryKey($table,$indices)
{
    $indices=implode(', ',preg_split('/\s+/',$indices));
    $sql=<<<EOD
SELECT attnum, attname FROM pg_catalog.pg_attribute WHERE
attrelid=(
    SELECT oid FROM pg_catalog.pg_class WHERE relname=:table AND relnamespace=(
        SELECT oid FROM pg_catalog.pg_namespace WHERE nspname=:schema
    )
)
AND attnum IN ({$indices})
EOD;
    $command=$this->getDbConnection()->createCommand($sql);
    $command->bindValue(':table',$table->name);
    $command->bindValue(':schema',$table->schemaName);
    foreach($command->queryAll() as $row)
    {
        $name=$row['attname'];
        if(isset($table->columns[$name]))
        {
            $table->columns[$name]->isPrimaryKey=true;
            if($table->primaryKey===null)
                $table->primaryKey=$name;
            elseif(is_string($table->primaryKey))
                $table->primaryKey=array($table->primaryKey,$name);
            else
                $table->primaryKey[]=$name;
        }
    }
}

Collects primary key information.

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/pgsql/CPgsqlSchema.php#353 (show)
protected function findTableNames($schema='')
{
    if($schema==='')
        $schema=self::DEFAULT_SCHEMA;
    $sql=<<<EOD
SELECT table_name, table_schema FROM information_schema.tables
WHERE table_schema=:schema AND table_type='BASE TABLE'
EOD;
    $command=$this->getDbConnection()->createCommand($sql);
    $command->bindParam(':schema',$schema);
    $rows=$command->queryAll();
    $names=array();
    foreach($rows as $row)
    {
        if($schema===self::DEFAULT_SCHEMA)
            $names[]=$row['table_name'];
        else
            $names[]=$row['table_schema'].'.'.$row['table_name'];
    }
    return $names;
}

Returns all table names in the database.

loadTable() method
protected CDbTableSchema loadTable(string $name)
$name string table name
{return} CDbTableSchema driver dependent table metadata.
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#109 (show)
protected function loadTable($name)
{
    $table=new CPgsqlTableSchema;
    $this->resolveTableNames($table,$name);
    if(!$this->findColumns($table))
        return null;
    $this->findConstraints($table);

    if(is_string($table->primaryKey) && isset($this->_sequences[$table->rawName.'.'.$table->primaryKey]))
        $table->sequenceName=$this->_sequences[$table->rawName.'.'.$table->primaryKey];
    elseif(is_array($table->primaryKey))
    {
        foreach($table->primaryKey as $pk)
        {
            if(isset($this->_sequences[$table->rawName.'.'.$pk]))
            {
                $table->sequenceName=$this->_sequences[$table->rawName.'.'.$pk];
                break;
            }
        }
    }

    return $table;
}

Loads the metadata for the specified table.

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/pgsql/CPgsqlSchema.php#53 (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/pgsql/CPgsqlSchema.php#382 (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)
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/pgsql/CPgsqlSchema.php#68 (show)
public function resetSequence($table,$value=null)
{
    if($table->sequenceName===null)
        return;
    $sequence='"'.$table->sequenceName.'"';
    if(strpos($sequence,'.')!==false)
        $sequence=str_replace('.','"."',$sequence);
    if($value!==null)
        $value=(int)$value;
    else
        $value="(SELECT COALESCE(MAX(\"{$table->primaryKey}\"),0) FROM {$table->rawName})+1";
    $this->getDbConnection()
        ->createCommand("SELECT SETVAL('$sequence',$value,false)")
        ->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).

resolveTableNames() method
protected void resolveTableNames(CPgsqlTableSchema $table, string $name)
$table CPgsqlTableSchema the table instance
$name string the unquoted table name
Source Code: framework/db/schema/pgsql/CPgsqlSchema.php#139 (show)
protected function resolveTableNames($table,$name)
{
    $parts=explode('.',str_replace('"','',$name));
    if(isset($parts[1]))
    {
        $schemaName=$parts[0];
        $tableName=$parts[1];
    }
    else
    {
        $schemaName=self::DEFAULT_SCHEMA;
        $tableName=$parts[0];
    }

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

Generates various kinds of table names.