PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TPgsqlMetaData

TPgsqlMetaData loads PostgreSQL database table and column information.

TComponent
Extended by TDbMetaData
Extended by TPgsqlMetaData
Package: System\Data\Common\Pgsql
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizho[at]gmail[dot]com>
Since: 3.1
Located at Data/Common/Pgsql/TPgsqlMetaData.php
Methods summary
protected string
# getTableInfoClass( )

Returns

string
TDbTableInfo class name.

Overrides

TDbMetaData::getTableInfoClass()
public string
# quoteTableName( string $name )

Quotes a table name for use in a query.

Quotes a table name for use in a query.

Parameters

$name
string
$name table name

Returns

string
the properly quoted table name

Overrides

TDbMetaData::quoteTableName()
public string
# quoteColumnName( string $name )

Quotes a column name for use in a query.

Quotes a column name for use in a query.

Parameters

$name
string
$name column name

Returns

string
the properly quoted column name

Overrides

TDbMetaData::quoteColumnName()
public string
# quoteColumnAlias( string $name )

Quotes a column alias for use in a query.

Quotes a column alias for use in a query.

Parameters

$name
string
$name column alias

Returns

string
the properly quoted column alias

Overrides

TDbMetaData::quoteColumnAlias()
public
# setDefaultSchema( string $schema )

Parameters

$schema
string
default schema.
public string
# getDefaultSchema( )

Returns

string
default schema.
protected array
# getSchemaTableName( string $table )

Parameters

$table
string
table name with optional schema name prefix, uses default schema name prefix is not provided.

Returns

array
tuple as ($schemaName,$tableName)
protected TPgsqlTableInfo
# createTableInfo( string $table )

Get the column definitions for given table.

Get the column definitions for given table.

Parameters

$table
string
table name.

Returns

TPgsqlTableInfo
table information.
protected TPgsqlTableInfo
# createNewTableInfo( string $schemaName, string $tableName )

Parameters

$schemaName
string
table schema name
$tableName
string
table name.

Returns

TPgsqlTableInfo
protected string
# assertIdentifier( string $name )

Parameters

$name
string
table name, schema name or column name.

Returns

string
a valid identifier.

Throws

TDbException
when table name contains a double quote (").
protected boolean
# getIsView( string $schemaName, string $tableName )

Parameters

$schemaName
string
table schema name
$tableName
string
table name.

Returns

boolean
true if the table is a view.
protected
# processColumn( TPgsqlTableInfo $tableInfo, array $col )

Parameters

$tableInfo
TPgsqlTableInfo
table information.
$col
array
column information.
protected string
# getSequenceName( mixed $tableInfo, mixed $src )

Returns

string
serial name if found, null otherwise.
protected boolean
# isPrecisionType( mixed $type )

Returns

boolean
true if column type if "numeric", "interval" or begins with "time".
protected array
# getConstraintKeys( string $schemaName, string $tableName )

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

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

Parameters

$schemaName
string
schema name
$tableName
string
table name.

Returns

array
tuple ($primary, $foreign)
protected array
# getPrimaryKeys( string $tableName, mixed $schemaName, mixed $columnIndex )

Gets the primary key field names

Gets the primary key field names

Parameters

$tableName
string
pgsql primary key definition
$schemaName
$columnIndex

Returns

array
primary key field names.
protected array
# getForeignKeys( string $src )

Gets foreign relationship constraint keys and table name

Gets foreign relationship constraint keys and table name

Parameters

$src
string
pgsql foreign key definition

Returns

array
foreign relationship table name and keys, null otherwise
protected boolean
# isForeignKeyColumn( string $columnId, TPgsqlTableInfo $tableInfo )

Parameters

$columnId
string
column name.
$tableInfo
TPgsqlTableInfo
table information.

Returns

boolean
true if column is a foreign key.
public array
# findTableNames( string $schema = 'public' )

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.
Methods inherited from TDbMetaData
__construct(), createCommandBuilder(), getDbConnection(), getInstance(), getTableInfo()
Methods inherited from TComponent
__call(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TDbMetaData
$delimiterIdentifier
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO