Classes:
Doctrine
Doctrine_Access
Doctrine_Adapter
Doctrine_Adapter_Db2_Exception
Doctrine_Adapter_Exception
Doctrine_Adapter_Statement
Doctrine_AuditLog
Doctrine_AuditLog_Listener
Doctrine_Collection
Doctrine_Collection_Exception
Doctrine_Collection_Iterator
Doctrine_Collection_Iterator_Expandable
Doctrine_Collection_Iterator_Normal
Doctrine_Collection_Iterator_Offset
Doctrine_Collection_Offset
Doctrine_Column
Doctrine_Compiler
Doctrine_Compiler_Exception
Doctrine_Configurable
Doctrine_Connection
Doctrine_Connection_Common
Doctrine_Connection_Db2
Doctrine_Connection_Exception
Doctrine_Connection_Firebird
Doctrine_Connection_Firebird_Exception
Doctrine_Connection_Informix
Doctrine_Connection_Informix_Exception
Doctrine_Connection_Mock
Doctrine_Connection_Module
Doctrine_Connection_Mssql
Doctrine_Connection_Mssql_Exception
Doctrine_Connection_Mysql
Doctrine_Connection_Mysql_Exception
Doctrine_Connection_Oracle
Doctrine_Connection_Oracle_Exception
Doctrine_Connection_Pgsql
Doctrine_Connection_Pgsql_Exception
Doctrine_Connection_Profiler
Doctrine_Connection_Profiler_Exception
Doctrine_Connection_Sqlite
Doctrine_Connection_Sqlite_Exception
Doctrine_Connection_Statement
Doctrine_Connection_UnitOfWork
Doctrine_DataDict
Doctrine_DataDict_Exception
Doctrine_DataDict_Informix
Doctrine_DataType
Doctrine_Db
Doctrine_Event
Doctrine_EventListener
Doctrine_EventListener_Chain
Doctrine_EventListener_Exception
Doctrine_Exception
Doctrine_Export
Doctrine_Export_Exception
Doctrine_Export_Firebird
Doctrine_Export_Frontbase
Doctrine_Export_Mssql
Doctrine_Export_Mysql
Doctrine_Export_Oracle
Doctrine_Export_Pgsql
Doctrine_Export_Reporter
Doctrine_Export_Schema
Doctrine_Export_Schema_Xml
Doctrine_Export_Schema_Yml
Doctrine_Export_Sqlite
Doctrine_Expression
Doctrine_Expression_Driver
Doctrine_Expression_Exception
Doctrine_Expression_Firebird
Doctrine_Expression_Informix
Doctrine_Expression_Mock
Doctrine_Expression_Mssql
Doctrine_Expression_Mysql
Doctrine_Expression_Oracle
Doctrine_Expression_Pgsql
Doctrine_Expression_Sqlite
Doctrine_File
Doctrine_File_Index
Doctrine_Formatter
Doctrine_Hook
Doctrine_Hook_Equal
Doctrine_Hook_Integer
Doctrine_Hook_Parser
Doctrine_Hook_Parser_Complex
Doctrine_Hook_WordLike
Doctrine_Hydrate
Doctrine_Hydrate_Array
Doctrine_Hydrate_Exception
Doctrine_Hydrate_Record
Doctrine_Import
Doctrine_Import_Builder
Doctrine_Import_Builder_BaseClass
Doctrine_Import_Builder_Exception
Doctrine_Import_Exception
Doctrine_Import_Firebird
Doctrine_Import_Informix
Doctrine_Import_Mssql
Doctrine_Import_Mysql
Doctrine_Import_Oracle
Doctrine_Import_Pgsql
Doctrine_Import_Reader
Doctrine_Import_Reader_Db
Doctrine_Import_Reader_Exception
Doctrine_Import_Reader_Xml_Propel
Doctrine_Import_Schema
Doctrine_Import_Schema_Xml
Doctrine_Import_Schema_Yml
Doctrine_Import_Sqlite
Doctrine_IntegrityMapper
Doctrine_Lib
Doctrine_Locking_Exception
Doctrine_Locking_Manager_Pessimistic
Doctrine_Manager
Doctrine_Manager_Exception
Doctrine_Node
Doctrine_Node_AdjacencyList
Doctrine_Node_AdjacencyList_LevelOrderIterator
Doctrine_Node_AdjacencyList_PostOrderIterator
Doctrine_Node_AdjacencyList_PreOrderIterator
Doctrine_Node_Exception
Doctrine_Node_MaterializedPath
Doctrine_Node_MaterializedPath_LevelOrderIterator
Doctrine_Node_MaterializedPath_PostOrderIterator
Doctrine_Node_MaterializedPath_PreOrderIterator
Doctrine_Node_NestedSet
Doctrine_Node_NestedSet_LevelOrderIterator
Doctrine_Node_NestedSet_PostOrderIterator
Doctrine_Node_NestedSet_PreOrderIterator
Doctrine_Null
Doctrine_Object
Doctrine_Plugin
Doctrine_Query
Doctrine_Query_Abstract
Doctrine_Query_Check
Doctrine_Query_Condition
Doctrine_Query_Exception
Doctrine_Query_Filter
Doctrine_Query_Filter_Chain
Doctrine_Query_From
Doctrine_Query_Groupby
Doctrine_Query_Having
Doctrine_Query_JoinCondition
Doctrine_Query_Limit
Doctrine_Query_Offset
Doctrine_Query_Orderby
Doctrine_Query_Parser
Doctrine_Query_Part
Doctrine_Query_Select
Doctrine_Query_Set
Doctrine_Query_Where
Doctrine_RawSql
Doctrine_RawSql_Exception
Doctrine_Record
Doctrine_Record_Abstract
Doctrine_Record_Exception
Doctrine_Record_Filter
Doctrine_Record_Iterator
Doctrine_Record_Listener
Doctrine_Record_Listener_Chain
Doctrine_Record_State_Exception
Doctrine_Relation
Doctrine_Relation_Association
Doctrine_Relation_Association_Self
Doctrine_Relation_Exception
Doctrine_Relation_ForeignKey
Doctrine_Relation_LocalKey
Doctrine_Relation_Nest
Doctrine_Relation_Parser
Doctrine_Relation_Parser_Exception
Doctrine_Schema
Doctrine_Schema_Column
Doctrine_Schema_Database
Doctrine_Schema_Exception
Doctrine_Schema_Object
Doctrine_Schema_Relation
Doctrine_Schema_Table
Doctrine_Search
Doctrine_Search_Analyzer
Doctrine_Search_Analyzer_Exception
Doctrine_Search_Analyzer_Standard
Doctrine_Search_Exception
Doctrine_Search_Indexer
Doctrine_Search_Indexer_Dir
Doctrine_Search_Indexer_Exception
Doctrine_Search_Listener
Doctrine_Search_Parser
Doctrine_Search_Query
Doctrine_Search_Record
Doctrine_Search_Scorer
Doctrine_Search_Template
Doctrine_Sequence
Doctrine_Sequence_Db2
Doctrine_Sequence_Exception
Doctrine_Sequence_Firebird
Doctrine_Sequence_Informix
Doctrine_Sequence_Mssql
Doctrine_Sequence_Mysql
Doctrine_Sequence_Oracle
Doctrine_Sequence_Pgsql
Doctrine_Sequence_Sqlite
Doctrine_Table
Doctrine_Table_Exception
Doctrine_Table_Repository
Doctrine_Table_Repository_Exception
Doctrine_Template
Doctrine_Template_NestedSet
Doctrine_Template_Searchable
Doctrine_Template_Taggable
Doctrine_Template_Versionable
Doctrine_Tokenizer
Doctrine_Transaction
Doctrine_Transaction_Exception
Doctrine_Transaction_Firebird
Doctrine_Transaction_Informix
Doctrine_Transaction_Mock
Doctrine_Transaction_Mssql
Doctrine_Transaction_Mysql
Doctrine_Transaction_Oracle
Doctrine_Transaction_Pgsql
Doctrine_Transaction_Sqlite
Doctrine_Tree
Doctrine_Tree_AdjacencyList
Doctrine_Tree_Exception
Doctrine_Tree_MaterializedPath
Doctrine_Tree_NestedSet
Doctrine_Util
Doctrine_Validator
Doctrine_Validator_Country
Doctrine_Validator_Creditcard
Doctrine_Validator_Date
Doctrine_Validator_Email
Doctrine_Validator_Enum
Doctrine_Validator_ErrorStack
Doctrine_Validator_Exception
Doctrine_Validator_HtmlColor
Doctrine_Validator_Ip
Doctrine_Validator_Minlength
Doctrine_Validator_Nospace
Doctrine_Validator_Notblank
Doctrine_Validator_Notnull
Doctrine_Validator_Range
Doctrine_Validator_Regexp
Doctrine_Validator_Unique
Doctrine_Validator_Unsigned
Doctrine_Validator_Usstate
Doctrine_View
Doctrine_View_Exception
Doctrine_Cache
Doctrine_Cache
Doctrine_Cache_Apc
Doctrine_Cache_Array
Doctrine_Cache_Db
Doctrine_Cache_Driver
Doctrine_Cache_Exception
Doctrine_Cache_Memcache
Doctrine_Adapter
Doctrine_Adapter_Db2
Doctrine_Adapter_Mock
Doctrine_Adapter_Mysqli
Doctrine_Adapter_Oracle
Doctrine_Adapter_Statement_Mock
Doctrine_DataDict
Doctrine_DataDict_Firebird
Doctrine_DataDict_Mssql
Doctrine_DataDict_Mysql
Doctrine_DataDict_Oracle
Doctrine_DataDict_Pgsql
Doctrine_DataDict_Sqlite

# Class: Doctrine_Export_Oracle

Source Location: /Doctrine/Export/Oracle.php

## Class Doctrine_Export_Oracle

Class Overview

Doctrine_Export_Oracle Located in /Doctrine/Export/Oracle.php [line 34]
    Doctrine_Connection_Module
       |
       --Doctrine_Export
          |
          --Doctrine_Export_Oracle
Author(s): Konsta Vesterinen <kvesteri@cc.hut.fi> Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library) Information Tags:
Version: | $Revision: 2288 $
Link: | www.phpdoctrine.com
Since: | 1.0
License: | LGPL
| Methods alterTable createDatabase createSequenceSql createTable createTableSql dropAutoincrement dropDatabase dropSequenceSql dropTable getAdvancedForeignKeyOptions getTemporaryTableQuery _makeAutoincrement

[ Top ]
Inherited Properties, Constants, and Methods

Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
Inherited From Doctrine_Export Doctrine_Export::$valid_default_values Inherited From Doctrine_Connection_Module Doctrine_Connection_Module::$conn Doctrine_Connection_Module::$moduleName | Inherited From Doctrine_Export Doctrine_Export::alterTable() alter an existing table (this method is implemented by the drivers) Doctrine_Export::alterTableSql() generates the sql for altering an existing table (this method is implemented by the drivers) Doctrine_Export::createConstraint() create a constraint on a table Doctrine_Export::createConstraintSql() create a constraint on a table Doctrine_Export::createDatabase() create a new database (this method is implemented by the drivers) Doctrine_Export::createDatabaseSql() create a new database (this method is implemented by the drivers) Doctrine_Export::createForeignKeySql() createForeignKeySql Doctrine_Export::createIndex() Get the stucture of a field into an array Doctrine_Export::createIndexSql() Get the stucture of a field into an array Doctrine_Export::createSequence() create sequence Doctrine_Export::createSequenceSql() return RDBMS specific create sequence statement (this method is implemented by the drivers) Doctrine_Export::createTable() create a new table Doctrine_Export::createTableSql() create a new table Doctrine_Export::dropConstraint() drop existing constraint Doctrine_Export::dropDatabase() drop an existing database (this method is implemented by the drivers) Doctrine_Export::dropDatabaseSql() drop an existing database (this method is implemented by the drivers) Doctrine_Export::dropIndex() drop existing index Doctrine_Export::dropIndexSql() dropIndexSql Doctrine_Export::dropSequence() dropSequenceSql drop existing sequence (this method is implemented by the drivers) Doctrine_Export::dropSequenceSql() dropSequenceSql drop existing sequence Doctrine_Export::dropTable() dropTable drop an existing table Doctrine_Export::dropTableSql() dropTableSql drop an existing table Doctrine_Export::exportClasses() exportClasses method for exporting Doctrine_Record classes to a schema Doctrine_Export::exportClassesSql() exportClassesSql method for exporting Doctrine_Record classes to a schema Doctrine_Export::exportSchema() exportSchema method for exporting Doctrine_Record classes to a schema Doctrine_Export::exportSql() exportSql returns the sql for exporting Doctrine_Record classes to a schema Doctrine_Export::exportTable() exportTable exports given table into database based on column and option definitions Doctrine_Export::getAdvancedForeignKeyOptions() getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ... Doctrine_Export::getCharsetFieldDeclaration() Obtain DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration to be used in statements like CREATE TABLE. Doctrine_Export::getCheckDeclaration() Obtain DBMS specific SQL code portion needed to set a CHECK constraint declaration to be used in statements like CREATE TABLE. Doctrine_Export::getCollationFieldDeclaration() Obtain DBMS specific SQL code portion needed to set the COLLATION of a field declaration to be used in statements like CREATE TABLE. Doctrine_Export::getDeclaration() Obtain DBMS specific SQL code portion needed to declare a generic type field to be used in statements like CREATE TABLE. Doctrine_Export::getDefaultFieldDeclaration() getDefaultDeclaration Obtain DBMS specific SQL code portion needed to set a default value declaration to be used in statements like CREATE TABLE. Doctrine_Export::getFieldDeclarationList() Get declaration of a number of field in bulk Doctrine_Export::getForeignKeyBaseDeclaration() getForeignKeyBaseDeclaration Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration to be used in statements like CREATE TABLE. Doctrine_Export::getForeignKeyDeclaration() getForeignKeyDeclaration Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration to be used in statements like CREATE TABLE. Doctrine_Export::getForeignKeyReferentialAction() getForeignKeyReferentialAction Doctrine_Export::getIndexDeclaration() Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE. Doctrine_Export::getIndexFieldDeclarationList() getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE. Doctrine_Export::getTemporaryTableQuery() A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table. Doctrine_Export::getUniqueFieldDeclaration() Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint of a field declaration to be used in statements like CREATE TABLE. Inherited From Doctrine_Connection_Module Doctrine_Connection_Module::__construct() Doctrine_Connection_Module::getConnection() getConnection returns the connection object this module uses Doctrine_Connection_Module::getModuleName() getModuleName returns the name of this module |

[ Top ]
Method Summary

void | alterTable() | alter an existing table
mixed | createDatabase() | create a new database
string | createSequenceSql() | create sequence
void | createTable() | create a new table
void | createTableSql() | create a new table
void | dropAutoincrement() | drop an existing autoincrement sequence + trigger
mixed | dropDatabase() | drop an existing database
string | dropSequenceSql() | drop existing sequence
void | dropTable() | drop an existing table
string | getAdvancedForeignKeyOptions() | getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
string | getTemporaryTableQuery() | A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table.
mixed | _makeAutoincrement() | add an autoincrement sequence + trigger

[ Top ]
Properties
Methods
alterTable [line 401]

`void alterTable( string $name, $changes, boolean $check )`

alter an existing table

Parameters:

string | $name: | name of the table that is intended to be changed.
array | $changes: | associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows: name New name for the table. add Associative array with the names of fields to be added as indexes of the array. The value of each entry of the array should be set to another associative array with the properties of the fields to be added. The properties of the fields should be the same as defined by the MDB2 parser. remove Associative array with the names of fields to be removed as indexes of the array. Currently the values assigned to each entry are ignored. An empty array should be used for future compatibility. rename Associative array with the names of fields to be renamed as indexes of the array. The value of each entry of the array should be set to another associative array with the entry named name with the new field name and the entry named Declaration that is expected to contain the portion of the field declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement. change Associative array with the names of the fields to be changed as indexes of the array. Keep in mind that if it is intended to change either the name of a field and any other properties, the change array entries should have the new names of the fields as array indexes. The value of each entry of the array should be set to another associative array with the properties of the fields to that are meant to be changed as array entries. These entries should be assigned to the new values of the respective properties. The properties of the fields should be the same as defined by the MDB2 parser. Example array( 'name' => 'userlist', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'file_limit' => array(), 'time_limit' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'text', 'length' => 20, ), ) ), 'rename' => array( 'sex' => array( 'name' => 'gender', 'definition' => array( 'type' => 'text', 'length' => 1, 'default' => 'M', ), ) ) )
boolean | $check: | indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise.

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::alterTable()
  alter an existing table (this method is implemented by the drivers)

[ Top ]
createDatabase [line 44]

`mixed createDatabase( string $name, object $db )`

create a new database

Parameters:

object | $db: | database object that is extended by this class
string | $name: | name of the database that should be created

API Tags:

Return: | MDB2_OK on success, a MDB2 error on failure
Access: | public

Redefinition of:

Doctrine_Export::createDatabase()
  create a new database (this method is implemented by the drivers)

[ Top ]
createSequenceSql [line 474]

`string createSequenceSql( string $seqName, [string $start = 1], [ $options = array()] )`

create sequence

Parameters:

string | $seqName: | name of the sequence to be created
string | $start: | start value of the sequence; default is 1
array | $options: | An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', );

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::createSequenceSql()
  return RDBMS specific create sequence statement (this method is implemented by the drivers)

[ Top ]
createTable [line 244]

`void createTable( string $name, $fields, [ $options = array()] )`

create a new table

Parameters:

string | $name: | Name of the database that should be created
array | $fields: | Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions. Example array( 'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );
array | $options: | An associative array of table options:

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::createTable()
  create a new table

[ Top ]
createTableSql [line 286]

`void createTableSql( string $name, $fields, [ $options = array()] )`

create a new table

Parameters:

string | $name: | Name of the database that should be created
array | $fields: | Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions. Example array( 'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );
array | $options: | An associative array of table options:

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::createTableSql()
  create a new table

[ Top ]
dropAutoincrement [line 149]

`void dropAutoincrement( string $table )`

drop an existing autoincrement sequence + trigger

Parameters:

string | $table: | name of the table

API Tags:

Access: | public

[ Top ]
dropDatabase [line 75]

`mixed dropDatabase( string $name, object $this->conn )`

drop an existing database

Parameters:

object | $this->conn: | database object that is extended by this class
string | $name: | name of the database that should be dropped

API Tags:

Return: | MDB2_OK on success, a MDB2 error on failure
Access: | public

Redefinition of:

Doctrine_Export::dropDatabase()
  drop an existing database (this method is implemented by the drivers)

[ Top ]
dropSequenceSql [line 488]

`string dropSequenceSql( string $seqName, object $this->conn )`

drop existing sequence

Parameters:

object | $this->conn: | database object that is extended by this class
string | $seqName: | name of the sequence to be dropped

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::dropSequenceSql()
  dropSequenceSql drop existing sequence

[ Top ]
dropTable [line 305]

`void dropTable( string $name )`

drop an existing table

Parameters:

string | $name: | name of the table that should be dropped

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::dropTable()
  dropTable drop an existing table

[ Top ]
getAdvancedForeignKeyOptions [line 194]

`string getAdvancedForeignKeyOptions( $definition )`

getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

Parameters:

array | $definition: | foreign key definition

API Tags:

Access: | public

Redefinition of:

Doctrine_Export::getAdvancedForeignKeyOptions()
  getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

[ Top ]
getTemporaryTableQuery [line 181]

`string getTemporaryTableQuery( )`

A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table.

API Tags:

Return: | The string required to be placed between "CREATE" and "TABLE" to generate a temporary table, if possible.
Access: | public

Redefinition of:

Doctrine_Export::getTemporaryTableQuery()
  A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table.

[ Top ]
_makeAutoincrement [line 94]

`mixed _makeAutoincrement( string $name, string $table, [string $start = 1] )`

add an autoincrement sequence + trigger

Parameters:

string | $name: | name of the PK field
string | $table: | name of the table
string | $start: | start value for the sequence

API Tags:

Return: | MDB2_OK on success, a MDB2 error on failure
Access: | public

[ Top ]