## Class TOracleMetaData

Description

TOracleMetaData loads Oracle database table and column information.

- since: 3.1
- version: $Id: TOracleMetaData.php 2653 2009-05-13 06:59:31Z Christophe.Boulain $
- author: Marcos Nobre <marconobre[at]gmail[dot]com>

Located in /Data/Common/Oracle/TOracleMetaData.php (line 28)

    TComponent
       |
       --TDbMetaData
          |
          --TOracleMetaData

Method Summary
string assertIdentifier (string $name)
TOracleTableInfo createNewTableInfo (string $schemaName, string $tableName)
TOracleTableInfo createTableInfo (string $table)
array getConstraintKeys (string $schemaName, string $tableName)
string getDefaultSchema ()
array getForeignKeys (string $src)
boolean getIsView (string $schemaName, string $tableName)
array getPrimaryKeys (string $src)
array getSchemaTableName (string $table)
string getSequenceName (mixed $tableInfo, mixed $src)
string getTableInfoClass ()
boolean isForeignKeyColumn (string $columnId, TOracleTableInfo $tableInfo)
boolean isPrecisionType (mixed $type)
void processColumn (TOracleTableInfo $tableInfo, array $col)
void setDefaultSchema (string $schema)
Methods
assertIdentifier (line 136)

- return: a valid identifier.
- access: protected
- throws: TDbException when table name contains a double quote (").

string assertIdentifier (string $name)

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

createNewTableInfo (line 120)

- access: protected

TOracleTableInfo createNewTableInfo (string $schemaName, string $tableName)

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

createTableInfo (line 74)

Get the column definitions for given table.

- return: table information.
- access: protected

TOracleTableInfo createTableInfo (string $table)

- string $table: table name.

Redefinition of:

TDbMetaData::createTableInfo()
  This method should be implemented by decendent classes.

getConstraintKeys (line 245)

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

- return: tuple ($primary, $foreign)
- access: protected

array getConstraintKeys (string $schemaName, string $tableName)

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

getDefaultSchema (line 52)

- return: default schema.
- access: public

string getDefaultSchema ()
getForeignKeys (line 306)

Gets foreign relationship constraint keys and table name

- return: foreign relationship table name and keys, null otherwise
- access: protected

array getForeignKeys (string $src)

- string $src: Oracle foreign key definition

getIsView (line 151)

- return: true if the table is a view.
- access: protected

boolean getIsView (string $schemaName, string $tableName)

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

getPrimaryKeys (line 293)

Gets the primary key field names

- return: primary key field names.
- access: protected

array getPrimaryKeys (string $src)

- string $src: Oracle primary key definition

getSchemaTableName (line 61)

- return: tuple as ($schemaName,$tableName)
- access: protected

array getSchemaTableName (string $table)

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

getSequenceName (line 218)

- return: serial name if found, null otherwise.
- access: protected

string getSequenceName (mixed $tableInfo, mixed $src)
getTableInfoClass (line 36)

- return: TDbTableInfo class name.
- access: protected

string getTableInfoClass ()

Redefinition of:

TDbMetaData::getTableInfoClass()

isForeignKeyColumn (line 326)

- return: true if column is a foreign key.
- access: protected

boolean isForeignKeyColumn (string $columnId, TOracleTableInfo $tableInfo)

- string $columnId: column name.
- TOracleTableInfo $tableInfo: table information.

isPrecisionType (line 233)

- return: true if column type if "numeric", "interval" or begins with "time".
- access: protected

boolean isPrecisionType (mixed $type)
processColumn (line 171)

- access: protected

void processColumn (TOracleTableInfo $tableInfo, array $col)

- TOracleTableInfo $tableInfo: table information.
- array $col: column information.

setDefaultSchema (line 44)

- access: public

void setDefaultSchema (string $schema)

- string $schema: default schema.

#### Inherited Methods

Inherited From TDbMetaData

> TDbMetaData::__construct()
> TDbMetaData::createCommandBuilder()
> TDbMetaData::createTableInfo()
> TDbMetaData::getDbConnection()
> TDbMetaData::getInstance()
> TDbMetaData::getTableInfo()
> TDbMetaData::getTableInfoClass()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Documentation generated on Mon, 22 Feb 2010 12:18:16 +0000 by phpDocumentor 1.3.0RC4