Class CPgsqlSchema

CPgsqlSchema is the class for retrieving metadata information from a PostgreSQL database.

CComponent

CDbSchema

CPgsqlSchema

Package: system\db\schema\pgsql
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/db/schema/pgsql/CPgsqlSchema.php

Methods summary
`public string`	# `quoteSimpleTableName( string $name )` Quotes a table name for use in a query. A simple table name does not schema prefix. Quotes a table name for use in a query. A simple table name does not schema prefix. Parameters `$name` `string` $name table name Returns `string` the properly quoted table name Since 1.1.6 Overrides `CDbSchema::quoteSimpleTableName()`
`public`	# `resetSequence( CDbTableSchema $table, integer\|null $value = null )` 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). 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). Parameters `$table` `CDbTableSchema` $table the table schema whose primary key sequence will be reset `$value` `integer\|null` $value 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). Since 1.1 Overrides `CDbSchema::resetSequence()`
`public`	# `checkIntegrity( boolean $check = true, string $schema = '' )` Enables or disables integrity check. Enables or disables integrity check. Parameters `$check` `boolean` $check whether to turn on or off the integrity check. `$schema` `string` $schema the schema of the tables. Defaults to empty string, meaning the current or default schema. Since 1.1 Overrides `CDbSchema::checkIntegrity()`
`protected CDbTableSchema`	# `loadTable( string $name )` Loads the metadata for the specified table. Loads the metadata for the specified table. Parameters `$name` `string` $name table name Returns `CDbTableSchema` driver dependent table metadata.
`protected`	# `resolveTableNames( CPgsqlTableSchema $table, string $name )` Generates various kinds of table names. Generates various kinds of table names. Parameters `$table` `CPgsqlTableSchema` $table the table instance `$name` `string` $name the unquoted table name
`protected boolean`	# `findColumns( CPgsqlTableSchema $table )` Collects the table column metadata. Collects the table column metadata. Parameters `$table` `CPgsqlTableSchema` $table the table metadata Returns `boolean` whether the table exists in the database
`protected CDbColumnSchema`	# `createColumn( array $column )` Creates a table column. Creates a table column. Parameters `$column` `array` $column column metadata Returns `CDbColumnSchema` normalized column metadata
`protected`	# `findConstraints( CPgsqlTableSchema $table )` Collects the primary and foreign key column details for the given table. Collects the primary and foreign key column details for the given table. Parameters `$table` `CPgsqlTableSchema` $table the table metadata
`protected`	# `findPrimaryKey( CPgsqlTableSchema $table, string $indices )` Collects primary key information. Collects primary key information. Parameters `$table` `CPgsqlTableSchema` $table the table metadata `$indices` `string` $indices pgsql primary key index list
`protected`	# `findForeignKey( CPgsqlTableSchema $table, string $src )` Collects foreign key information. Collects foreign key information. Parameters `$table` `CPgsqlTableSchema` $table the table metadata `$src` `string` $src pgsql foreign key definition
`protected array`	# `findTableNames( string $schema = '' )` Returns all table names in the database. Returns all table names in the database. Parameters `$schema` `string` $schema 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. Returns `array` all table names in the database. Throws `CDbException` if current schema does not support fetching all table names Overrides `CDbSchema::findTableNames()`
`public string`	# `renameTable( string $table, string $newName )` Builds a SQL statement for renaming a DB table. Builds a SQL statement for renaming a DB table. Parameters `$table` `string` $table the table to be renamed. The name will be properly quoted by the method. `$newName` `string` $newName the new table name. The name will be properly quoted by the method. Returns `string` the SQL statement for renaming a DB table. Since 1.1.6 Overrides `CDbSchema::renameTable()`
`public string`	# `addColumn( string $table, string $column, string $type )` Builds a SQL statement for adding a new DB column. Builds a SQL statement for adding a new DB column. Parameters `$table` `string` $table the table that the new column will be added to. The table name will be properly quoted by the method. `$column` `string` $column the name of the new column. The name will be properly quoted by the method. `$type` `string` $type the column type. The `CDbSchema::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'. Returns `string` the SQL statement for adding a new column. Since 1.1.6 Overrides `CDbSchema::addColumn()`
`public string`	# `alterColumn( string $table, string $column, string $type )` Builds a SQL statement for changing the definition of a column. Builds a SQL statement for changing the definition of a column. Parameters `$table` `string` $table the table whose column is to be changed. The table name will be properly quoted by the method. `$column` `string` $column the name of the column to be changed. The name will be properly quoted by the method. `$type` `string` $type the new column type. The `CDbSchema::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'. Returns `string` the SQL statement for changing the definition of a column. Since 1.1.6 Overrides `CDbSchema::alterColumn()`
`public string`	# `createIndex( string $name, string $table, string $columns, boolean $unique = false )` Builds a SQL statement for creating a new index. Builds a SQL statement for creating a new index. Parameters `$name` `string` $name the name of the index. The name will be properly quoted by the method. `$table` `string` $table the table that the new index will be created for. The table name will be properly quoted by the method. `$columns` `string` $columns the column(s) that should be included in the index. If there are multiple columns, please separate them by commas. Each column name will be properly quoted by the method, unless a parenthesis is found in the name. `$unique` `boolean` $unique whether to add UNIQUE constraint on the created index. Returns `string` the SQL statement for creating a new index. Since 1.1.6 Overrides `CDbSchema::createIndex()`
`public string`	# `dropIndex( string $name, string $table )` Builds a SQL statement for dropping an index. Builds a SQL statement for dropping an index. Parameters `$name` `string` $name the name of the index to be dropped. The name will be properly quoted by the method. `$table` `string` $table the table whose index is to be dropped. The name will be properly quoted by the method. Returns `string` the SQL statement for dropping an index. Since 1.1.6 Overrides `CDbSchema::dropIndex()`
`protected CPgsqlCommandBuilder`	# `createCommandBuilder( )` Creates a command builder for the database. This method may be overridden by child classes to create a DBMS-specific command builder. Creates a command builder for the database. This method may be overridden by child classes to create a DBMS-specific command builder. Returns `CPgsqlCommandBuilder` command builder instance. Overrides `CDbSchema::createCommandBuilder()`

Methods inherited from CDbSchema
`__construct(), addForeignKey(), addPrimaryKey(), compareTableNames(), createTable(), dropColumn(), dropForeignKey(), dropPrimaryKey(), dropTable(), getColumnType(), getCommandBuilder(), getDbConnection(), getTable(), getTableNames(), getTables(), quoteColumnName(), quoteSimpleColumnName(), quoteTableName(), refresh(), renameColumn(), truncateTable()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`string`	`DEFAULT_SCHEMA`	`'public'`	#

Properties summary
`public array`	`$columnTypes`	`array( 'pk' => 'serial NOT NULL PRIMARY KEY', 'bigpk' => 'bigserial NOT NULL PRIMARY KEY', 'string' => 'character varying (255)', 'text' => 'text', 'integer' => 'integer', 'bigint' => 'bigint', 'float' => 'double precision', 'decimal' => 'numeric', 'datetime' => 'timestamp', 'timestamp' => 'timestamp', 'time' => 'time', 'date' => 'date', 'binary' => 'bytea', 'boolean' => 'boolean', 'money' => 'decimal(19,4)', )`	# the abstract column types mapped to physical column types. the abstract column types mapped to physical column types. Since 1.1.6

Magic properties inherited from CDbSchema
`$commandBuilder, $dbConnection, $tableNames, $tables`

Packages

Classes

Class CPgsqlSchema

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Parameters

Since

Overrides

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Overrides

Since