Path

ez components / documentation / api reference / 1.1 / databaseschema


eZ Components 1.1

DatabaseSchema: ezcDbSchemaHandlerOracle

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcDbSchemaHandlerOracle

Handler for Oracle databases and SQL files. [source]

Implemented Interfaces

Parents

ezcDbSchemaHandlerSql
   |
   --ezcDbSchemaHandlerOracle

Method Summary

public void closeTransferDestination( )
Tell destination handler that there is no more data to transfer. [destination]
protected array fetchSchema( $db, $what )
Fetch schema from given database.
protected array(string) fetchSequencesList( $db )
Fetch list of sequences from the given database.
public array fetchTableFields( $db, $table )
Fetch schema of all the table's fields.
protected array fetchTableIndexes( $db, $table )
Fetch schema of all the table's indexes.
protected array(string) fetchTablesList( $db )
Fetch list of tables from the given database.
protected string generateAddFieldSql( $tableName, $fieldName, $fieldSchema, [$params = array()] )
Generate SQL query for adding a table field.
protected string generateAddIndexSql( $tableName, $indexName, $indexSchema, [$params = array()], [$isEmbedded = false] )
Generate index creation SQL query.
protected string generateAlterFieldSql( $tableName, $fieldName, $fieldSchema, [$diffParams = array()] )
Generate SQL query for altering table field schema.
protected void generateCreateSequenceSql( $seqName, $seqSchema )
protected array(string) generateCreateTableSql( $tableName, $tableSchema, [$params = array()] )
Generate SQL queries for table creation.
protected void generateDataAsSQL( $schema )
protected void generateDataValueTextSQL( $fieldDef, $value )
protected string generateDropFieldSql( $tableName, $fieldName, [$params = array()] )
Generate SQL query for dropping a table field.
protected string generateDropIndexSql( $tableName, $indexName, $indexSchema, [$params = array()] )
Generate drop index SQL query.
protected string generateDropTableSql( $tableName, [$params = array()] )
Generate table dropping SQL query.
protected void generateFieldSql( $tableName, $fieldName, $fieldSchema, [$optionsToDump = array( 'default', 'not_null' )] )
protected array generateSchemaAsSQL( $schema )
Dump specified schema as an array of SQL queries.
public void getDbmsName( )
protected Oracle getOracleType( $mysqlType )
public void getSchema( $schema, $internalFormat, $what )
Return schema in one of internal formats without saving it to a file or database.
public static array getSupportedFeatures( )
public static void getSupportedInternalFormats( )
Returns the list of internal formats supported by the handler.
public static void getSupportedStorageTypes( )
This handler supports saving/loading schema to/from DB and saving to SQL files.
public void loadSchema( $src, $storageType, $what )
Loads schema from a database.
public void openTransferDestination( $storage, $storageType )
Prepare destination handler for transfer [destination].
protected void parseLength( $oraType, $oraLength )
protected void parseType( $type )
public void saveDelta( $delta, $dst, $storageType )
Saves difference between schemas to an SQL file.
public void saveRow( $row )
Save given row. [destination]
public void saveSchema( $schema, $dst, $storageType, $what )
Saves schema to an SQL file or database.
public void setTableBeingTransferred( $tableName, [$tableFields = null] )
Start to transfer data of the next table. [destination]
public void transfer( $storage, $storageType, $dstHandler )
Actually transfer data [source].

Methods

closeTransferDestination

void closeTransferDestination( )
Tell destination handler that there is no more data to transfer. [destination]

See also:

ezcDbSchemaHandlerDataTransfer.


fetchSchema

array fetchSchema( $db, $what )
Fetch schema from given database.

Parameters

Name Type Description
$db  
$what  

fetchSequencesList

array(string) fetchSequencesList( $db )
Fetch list of sequences from the given database.

Parameters

Name Type Description
$db ezcDbHandler Database to fetch from.

fetchTableFields

array fetchTableFields( ezcDbHandler $db, string $table )
Fetch schema of all the table's fields.

Parameters

Name Type Description
$db ezcDbHandler Database to fetch from.
$table string Name of the table to fetch from.

fetchTableIndexes

array fetchTableIndexes( ezcDbHandler $db, string $table )
Fetch schema of all the table's indexes.

Parameters

Name Type Description
$db ezcDbHandler Database to fetch from.
$table string Name of the table to fetch from.

fetchTablesList

array(string) fetchTablesList( $db )
Fetch list of tables from the given database.

generateAddFieldSql

string generateAddFieldSql( $tableName, $fieldName, $fieldSchema, [ $params = array()] )
Generate SQL query for adding a table field.

Parameters

Name Type Description
$tableName  
$fieldName  
$fieldSchema  
$params  

See also:

ezcDbSchemaHandlerSql::generateAddFieldSql().


generateAddIndexSql

string generateAddIndexSql( $tableName, $indexName, $indexSchema, [ $params = array()], [ $isEmbedded = false] )
Generate index creation SQL query.

Parameters

Name Type Description
$tableName  
$indexName  
$indexSchema  
$params  
$isEmbedded  

See also:

ezcDbSchemaHandlerSql::generateAddIndexSql().


generateAlterFieldSql

string generateAlterFieldSql( $tableName, $fieldName, $fieldSchema, [ $diffParams = array()] )
Generate SQL query for altering table field schema.

Parameters

Name Type Description
$tableName  
$fieldName  
$fieldSchema  
$diffParams  

See also:

ezcDbSchemaHandlerSql::generateAlterFieldSql().


generateCreateSequenceSql

void generateCreateSequenceSql( $seqName, $seqSchema )

Parameters

Name Type Description
$seqName  
$seqSchema  

generateCreateTableSql

array(string) generateCreateTableSql( $tableName, $tableSchema, [ $params = array()] )
Generate SQL queries for table creation.

Parameters

Name Type Description
$tableName  
$tableSchema  
$params  

See also:

ezcDbSchemaHandlerSql::generateCreateTableSql().


generateDataAsSQL

void generateDataAsSQL( $schema )

Parameters

Name Type Description
$schema  

generateDataValueTextSQL

void generateDataValueTextSQL( $fieldDef, $value )

Parameters

Name Type Description
$fieldDef  
$value  

generateDropFieldSql

string generateDropFieldSql( $tableName, $fieldName, [ $params = array()] )
Generate SQL query for dropping a table field.

Parameters

Name Type Description
$tableName  
$fieldName  
$params  

See also:

ezcDbSchemaHandlerSql::generateDropFieldSql().


generateDropIndexSql

string generateDropIndexSql( $tableName, $indexName, $indexSchema, [ $params = array()] )
Generate drop index SQL query.

Parameters

Name Type Description
$tableName  
$indexName  
$indexSchema  
$params  

See also:

ezcDbSchemaHandlerSql::generateDropIndexSql().


generateDropTableSql

string generateDropTableSql( $tableName, [ $params = array()] )
Generate table dropping SQL query.

Parameters

Name Type Description
$tableName  
$params  

See also:

ezcDbSchemaHandlerSql::generateDropTableSql().


generateFieldSql

void generateFieldSql( $tableName, $fieldName, $fieldSchema, [ $optionsToDump = array( 'default', 'not_null' )] )

Parameters

Name Type Description
$tableName  
$fieldName  
$fieldSchema  
$optionsToDump  

generateSchemaAsSQL

array generateSchemaAsSQL( $schema )
Dump specified schema as an array of SQL queries.

Parameters

Name Type Description
$schema  

Throws

ClassDescription
ezcDbSchemaException::GENERIC_ERROR if there's no schema to generate SQL queries for.

getDbmsName

void getDbmsName( )

getOracleType

Oracle getOracleType( $mysqlType )

Parameters

Name Type Description
$mysqlType  

getSchema

void getSchema( $schema, $internalFormat, $what )
Return schema in one of internal formats without saving it to a file or database.

Parameters

Name Type Description
$schema  
$internalFormat  
$what  

Throws

ClassDescription
ezcDbSchemaException::UNKNOWN_INTERNAL_FORMAT if an unknown internal format specified
ezcDbSchemaException::INVALID_ARGUMMENT if $what is specified incorrectly.

See also:

ezcDbSchemaHandler::getSchema().


getSupportedFeatures

array getSupportedFeatures( )

getSupportedInternalFormats

void getSupportedInternalFormats( )
Returns the list of internal formats supported by the handler.

See also:

ezcDbSchemaHandler::getSupportedInternalFormats().


getSupportedStorageTypes

void getSupportedStorageTypes( )
This handler supports saving/loading schema to/from DB and saving to SQL files.

loadSchema

void loadSchema( $src, $storageType, $what )
Loads schema from a database.

Parameters

Name Type Description
$src  
$storageType  
$what  

openTransferDestination

void openTransferDestination( $storage, $storageType )
Prepare destination handler for transfer [destination].

Parameters

Name Type Description
$storage  
$storageType  

See also:

ezcDbSchemaHandlerDataTransfer.


parseLength

void parseLength( $oraType, $oraLength )

Parameters

Name Type Description
$oraType  
$oraLength  

parseType

void parseType( $type )

Parameters

Name Type Description
$type  

saveDelta

void saveDelta( $delta, $dst, $storageType )
Saves difference between schemas to an SQL file.

Parameters

Name Type Description
$delta  
$dst  
$storageType  

saveRow

void saveRow( $row )
Save given row. [destination]

Parameters

Name Type Description
$row  

See also:

ezcDbSchemaHandlerDataTransfer.


saveSchema

void saveSchema( $schema, $dst, $storageType, $what )
Saves schema to an SQL file or database.

Parameters

Name Type Description
$schema  
$dst  
$storageType  
$what  

setTableBeingTransferred

void setTableBeingTransferred( $tableName, [ $tableFields = null] )
Start to transfer data of the next table. [destination]

Parameters

Name Type Description
$tableName  
$tableFields  

See also:

ezcDbSchemaHandlerDataTransfer.


transfer

void transfer( $storage, $storageType, $dstHandler )
Actually transfer data [source].

Parameters

Name Type Description
$storage  
$storageType  
$dstHandler  

See also:

ezcDbSchemaHandlerDataTransfer.


Last updated: Wed, 28 Nov 2007