W3cubDocs

/Yii 2.0

Class yii\db\pgsql\Schema

All Classes | Properties | Methods | Constants

Inheritance	yii\db\pgsql\Schema » yii\db\Schema » yii\base\Object
Implements	yii\base\Configurable
Uses Traits	yii\db\ViewFinderTrait
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/db/pgsql/Schema.php

Schema is the class for retrieving metadata from a PostgreSQL database (version 9.x and above).

Public Properties

Property	Type	Description	Defined By
$columnSchemaClass	string	Column schema class	yii\db\Schema
$db	yii\db\Connection	The database connection	yii\db\Schema
$defaultSchema	string	The default schema used for the current session.	yii\db\pgsql\Schema
$exceptionMap	array	Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used.	yii\db\Schema
$lastInsertID	string	The row ID of the last row inserted, or the last value retrieved from the sequence object	yii\db\Schema
$queryBuilder	yii\db\QueryBuilder	The query builder for this connection.	yii\db\Schema
$schemaNames	string[]	All schema names in the database, except system schemas.	yii\db\Schema
$tableNames	string[]	All table names in the database.	yii\db\Schema
$tableSchemas	yii\db\TableSchema[]	The metadata for all tables in the database.	yii\db\Schema
$transactionIsolationLevel	string	The transaction isolation level to use for this transaction.	yii\db\Schema
$typeMap	array	Mapping from physical column types (keys) to abstract column types (values)	yii\db\pgsql\Schema
$viewNames	string[]	All view names in the database.	yii\db\ViewFinderTrait

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
convertException()	Converts a DB exception to a more concrete one if possible.	yii\db\Schema
createColumnSchemaBuilder()	Create a column schema builder instance giving the type and value precision.	yii\db\Schema
createQueryBuilder()	Creates a query builder for the PostgreSQL database.	yii\db\pgsql\Schema
createSavepoint()	Creates a new savepoint.	yii\db\Schema
findUniqueIndexes()	Returns all unique indexes for the given table.	yii\db\pgsql\Schema
getLastInsertID()	Returns the ID of the last inserted row or sequence value.	yii\db\Schema
getPdoType()	Determines the PDO type for the given PHP data value.	yii\db\Schema
getQueryBuilder()		yii\db\Schema
getRawTableName()	Returns the actual name of a given table name.	yii\db\Schema
getSchemaNames()	Returns all schema names in the database, except system schemas.	yii\db\Schema
getTableNames()	Returns all table names in the database.	yii\db\Schema
getTableSchema()	Obtains the metadata for the named table.	yii\db\Schema
getTableSchemas()	Returns the metadata for all tables in the database.	yii\db\Schema
getViewNames()	Returns all view names in the database.	yii\db\ViewFinderTrait
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
insert()	Executes the INSERT command, returning primary key values.	yii\db\pgsql\Schema
isReadQuery()	Returns a value indicating whether a SQL statement is for read purpose.	yii\db\Schema
loadTableSchema()	Loads the metadata for the specified table.	yii\db\pgsql\Schema
quoteColumnName()	Quotes a column name for use in a query.	yii\db\Schema
quoteSimpleColumnName()	Quotes a simple column name for use in a query.	yii\db\Schema
quoteSimpleTableName()	Quotes a table name for use in a query.	yii\db\pgsql\Schema
quoteTableName()	Quotes a table name for use in a query.	yii\db\Schema
quoteValue()	Quotes a string value for use in a query.	yii\db\Schema
refresh()	Refreshes the schema.	yii\db\Schema
refreshTableSchema()	Refreshes the particular table schema.	yii\db\Schema
releaseSavepoint()	Releases an existing savepoint.	yii\db\Schema
rollBackSavepoint()	Rolls back to a previously created savepoint.	yii\db\Schema
setTransactionIsolationLevel()	Sets the isolation level of the current transaction.	yii\db\Schema
supportsSavepoint()		yii\db\Schema

Protected Methods

Method	Description	Defined By
createColumnSchema()		yii\db\Schema
findColumns()	Collects the metadata of table columns.	yii\db\pgsql\Schema
findConstraints()	Collects the foreign key column details for the given table.	yii\db\pgsql\Schema
findSchemaNames()	Returns all schema names in the database, including the default one but not system schemas.	yii\db\pgsql\Schema
findTableNames()	Returns all table names in the database.	yii\db\pgsql\Schema
findViewNames()		yii\db\pgsql\Schema
getCacheKey()	Returns the cache key for the specified table name.	yii\db\Schema
getCacheTag()	Returns the cache tag name.	yii\db\Schema
getColumnPhpType()	Extracts the PHP type from abstract DB type.	yii\db\Schema
getUniqueIndexInformation()	Gets information about given table unique indexes.	yii\db\pgsql\Schema
loadColumnSchema()	Loads the column information into a yii\db\ColumnSchema object.	yii\db\pgsql\Schema
resolveTableNames()	Resolves the table name and schema name (if any).	yii\db\pgsql\Schema

Constants

Constant	Value	Defined By
TYPE_BIGINT	'bigint'	yii\db\Schema
TYPE_BIGPK	'bigpk'	yii\db\Schema
TYPE_BINARY	'binary'	yii\db\Schema
TYPE_BOOLEAN	'boolean'	yii\db\Schema
TYPE_CHAR	'char'	yii\db\Schema
TYPE_DATE	'date'	yii\db\Schema
TYPE_DATETIME	'datetime'	yii\db\Schema
TYPE_DECIMAL	'decimal'	yii\db\Schema
TYPE_DOUBLE	'double'	yii\db\Schema
TYPE_FLOAT	'float'	yii\db\Schema
TYPE_INTEGER	'integer'	yii\db\Schema
TYPE_MONEY	'money'	yii\db\Schema
TYPE_PK	'pk'	yii\db\Schema
TYPE_SMALLINT	'smallint'	yii\db\Schema
TYPE_STRING	'string'	yii\db\Schema
TYPE_TEXT	'text'	yii\db\Schema
TYPE_TIME	'time'	yii\db\Schema
TYPE_TIMESTAMP	'timestamp'	yii\db\Schema
TYPE_UBIGPK	'ubigpk'	yii\db\Schema
TYPE_UPK	'upk'	yii\db\Schema

Property Details

$defaultSchema public property

The default schema used for the current session.

public string $defaultSchema = 'public'

$typeMap public property

Mapping from physical column types (keys) to abstract column types (values)

public array $typeMap = ['bit' => self::TYPE_INTEGER, 'bit varying' => self::TYPE_INTEGER, 'varbit' => self::TYPE_INTEGER, 'bool' => self::TYPE_BOOLEAN, 'boolean' => self::TYPE_BOOLEAN, 'box' => self::TYPE_STRING, 'circle' => self::TYPE_STRING, 'point' => self::TYPE_STRING, 'line' => self::TYPE_STRING, 'lseg' => self::TYPE_STRING, 'polygon' => self::TYPE_STRING, 'path' => self::TYPE_STRING, 'character' => self::TYPE_CHAR, 'char' => self::TYPE_CHAR, 'bpchar' => self::TYPE_CHAR, 'character varying' => self::TYPE_STRING, 'varchar' => self::TYPE_STRING, 'text' => self::TYPE_TEXT, 'bytea' => self::TYPE_BINARY, 'cidr' => self::TYPE_STRING, 'inet' => self::TYPE_STRING, 'macaddr' => self::TYPE_STRING, 'real' => self::TYPE_FLOAT, 'float4' => self::TYPE_FLOAT, 'double precision' => self::TYPE_DOUBLE, 'float8' => self::TYPE_DOUBLE, 'decimal' => self::TYPE_DECIMAL, 'numeric' => self::TYPE_DECIMAL, 'money' => self::TYPE_MONEY, 'smallint' => self::TYPE_SMALLINT, 'int2' => self::TYPE_SMALLINT, 'int4' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'integer' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'int8' => self::TYPE_BIGINT, 'oid' => self::TYPE_BIGINT, 'smallserial' => self::TYPE_SMALLINT, 'serial2' => self::TYPE_SMALLINT, 'serial4' => self::TYPE_INTEGER, 'serial' => self::TYPE_INTEGER, 'bigserial' => self::TYPE_BIGINT, 'serial8' => self::TYPE_BIGINT, 'pg_lsn' => self::TYPE_BIGINT, 'date' => self::TYPE_DATE, 'interval' => self::TYPE_STRING, 'time without time zone' => self::TYPE_TIME, 'time' => self::TYPE_TIME, 'time with time zone' => self::TYPE_TIME, 'timetz' => self::TYPE_TIME, 'timestamp without time zone' => self::TYPE_TIMESTAMP, 'timestamp' => self::TYPE_TIMESTAMP, 'timestamp with time zone' => self::TYPE_TIMESTAMP, 'timestamptz' => self::TYPE_TIMESTAMP, 'abstime' => self::TYPE_TIMESTAMP, 'tsquery' => self::TYPE_STRING, 'tsvector' => self::TYPE_STRING, 'txid_snapshot' => self::TYPE_STRING, 'unknown' => self::TYPE_STRING, 'uuid' => self::TYPE_STRING, 'json' => self::TYPE_STRING, 'jsonb' => self::TYPE_STRING, 'xml' => self::TYPE_STRING]

Method Details

createQueryBuilder() public method

Creates a query builder for the PostgreSQL database.

public yii\db\pgsql\QueryBuilder createQueryBuilder ( )
return	yii\db\pgsql\QueryBuilder	Query builder instance

findColumns() protected method

Collects the metadata of table columns.

protected boolean findColumns ( $table )
$table	yii\db\TableSchema	The table metadata
return	boolean	Whether the table exists in the database

findConstraints() protected method

Collects the foreign key column details for the given table.

protected void findConstraints ( $table )
$table	yii\db\TableSchema	The table metadata

findSchemaNames() protected method (available since version 2.0.4)

Returns all schema names in the database, including the default one but not system schemas.

This method should be overridden by child classes in order to support this feature because the default implementation simply throws an exception.

protected array findSchemaNames ( )
return	array	All schema names in the database, except system schemas

findTableNames() protected method

Returns all table names in the database.

protected array findTableNames ( $schema = '' )
$schema	string	The schema of the tables. Defaults to empty string, meaning the current or default schema.
return	array	All table names in the database. The names have NO schema name prefix.

findUniqueIndexes() public method

Returns all unique indexes for the given table.

Each array element is of the following structure:

[
    'IndexName1' => ['col1' [, ...]],
    'IndexName2' => ['col2' [, ...]],
]

public array findUniqueIndexes ( $table )
$table	yii\db\TableSchema	The table metadata
return	array	All unique indexes for the given table.

findViewNames() protected method

protected void findViewNames ( $schema = '' )
$schema

getUniqueIndexInformation() protected method

Gets information about given table unique indexes.

protected array getUniqueIndexInformation ( $table )
$table	yii\db\TableSchema	The table metadata
return	array	With index and column names

insert() public method

Executes the INSERT command, returning primary key values.

public array\|false insert ( $table, $columns )
$table	string	The table that new rows will be inserted into.
$columns	array	The column data (name => value) to be inserted into the table.
return	array\|false	Primary key values or false if the command fails

loadColumnSchema() protected method

Loads the column information into a yii\db\ColumnSchema object.

protected yii\db\ColumnSchema loadColumnSchema ( $info )
$info	array	Column information
return	yii\db\ColumnSchema	The column schema object

loadTableSchema() public method

Loads the metadata for the specified table.

public yii\db\TableSchema\|null loadTableSchema ( $name )
$name	string	Table name
return	yii\db\TableSchema\|null	Driver dependent table metadata. Null if the table does not exist.

quoteSimpleTableName() public method

Quotes a table name for use in a query.

A simple table name has no schema prefix.

public string quoteSimpleTableName ( $name )
$name	string	Table name
return	string	The properly quoted table name

resolveTableNames() protected method

Resolves the table name and schema name (if any).

protected void resolveTableNames ( $table, $name )
$table	yii\db\TableSchema	The table metadata object
$name	string	The table name

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-pgsql-schema.html