Class TDbMetaData

TComponent
   |
   --TDbMetaData

Direct Known Sub-classes:

TMssqlMetaData , TMysqlMetaData , TPgsqlMetaData , TOracleMetaData , TSqliteMetaData

TDbMetaData is the base class for retrieving metadata information, such as table and columns information, from a database connection.

Use the getTableInfo method to retrieve a table information.

Constructor Summary
public	__construct Array

Method Summary
TDbCommandBuilder	createCommandBuilder ( string $tableName) Creates a command builder for a given table name.
protected abstract TDbTableInfo	createTableInfo ( mixed $tableName) This method should be implemented by decendent classes.
TDbConnection	getDbConnection ()
TDbMetaData	getInstance ( TDbConnection $conn) Obtain database specific TDbMetaData class using the driver name of the database connection.
TDbTableInfo	getTableInfo ( string $tableName) Obtains table meta data information for the current connection and given table name.
protected string	getTableInfoClass ()

Methods 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()

Constructor Details

__construct

public __construct

Array

Method Details

createCommandBuilder

public TDbCommandBuilder createCommandBuilder

(string $tableName )

Creates a command builder for a given table name.

Input
string	$tableName	table name.
Output
TDbCommandBuilder	command builder instance for the given table.
Exception

createTableInfo

protected abstract TDbTableInfo createTableInfo

(mixed $tableName )

This method should be implemented by decendent classes.

Input
mixed	$tableName
Output
TDbTableInfo	driver dependent create builder.
Exception

getDbConnection

public TDbConnection getDbConnection

()

Output
TDbConnection	database connection.
Exception

getInstance

public TDbMetaData getInstance

(TDbConnection $conn )

Obtain database specific TDbMetaData class using the driver name of the database connection.

Input
TDbConnection	$conn	database connection.
Output
TDbMetaData	database specific TDbMetaData.
Exception

getTableInfo

public TDbTableInfo getTableInfo

(string $tableName )

Obtains table meta data information for the current connection and given table name.

Input
string	$tableName	table or view name
Output
TDbTableInfo	table information.
Exception

getTableInfoClass

protected string getTableInfoClass

()

Output
string	TDbTableInfo class name.
Exception