Class Zend_Db_Adapter_Oracle

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Db/Adapter/Oracle.php (line 38)

Zend_Db_Adapter_Abstract
   |
   --Zend_Db_Adapter_Oracle
Variable Summary
 array $_config
 integer $_execute_mode
Method Summary
 Zend_Db_Adapter_Oracle __construct ( $config)
 void closeConnection ()
 array describeTable (string $tableName, [string $schemaName = null])
 integer lastInsertId ([string $tableName = null], [string $primaryKey = 'id'])
 integer lastSequenceId (string $sequenceName)
 string limit (string $sql, integer $count, [integer $offset = 0])
 array listTables ()
 integer nextSequenceId (string $sequenceName)
 string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
 void setFetchMode (integer $mode)
 void _commit ()
 void _connect ()
 void _getExecuteMode ()
 void _rollBack ()
Variables
array $_config = array(
'dbname' => null,
'username' => null,
'password' => null,
)
(line 52)

User-provided configuration.

Basic keys are:

username => (string) Connect to the database as this username. password => (string) Password associated with the username. dbname => Either the name of the local Oracle instance, or the name of the entry in tnsnames.ora to which you want to connect.

  • access: protected

Redefinition of:
Zend_Db_Adapter_Abstract::$_config
User-provided configuration
integer $_execute_mode = OCI_COMMIT_ON_SUCCESS (line 61)
  • access: protected

Inherited Variables

Inherited from Zend_Db_Adapter_Abstract

Zend_Db_Adapter_Abstract::$_connection
Zend_Db_Adapter_Abstract::$_fetchMode
Zend_Db_Adapter_Abstract::$_profiler
Methods
Constructor __construct (line 77)

Constructor.

$config is an array of key/value pairs containing configuration options. These options are common to most adapters:

username => (string) Connect to the database as this username. password => (string) Password associated with the username. dbname => Either the name of the local Oracle instance, or the name of the entry in tnsnames.ora to which you want to connect.

  • access: public
  • throws: Zend_Db_Adapter_Exception
Zend_Db_Adapter_Oracle __construct ( $config)
  • array $config: An array of configuration keys.

Redefinition of:
Zend_Db_Adapter_Abstract::__construct()
Constructor.
closeConnection (line 142)

Force the connection to close.

  • access: public
void closeConnection ()

Redefinition of:
Zend_Db_Adapter_Abstract::closeConnection()
Force the connection to close.
describeTable (line 281)

Returns the column descriptions for a table.

The return value is an associative array keyed by the column name, as returned by the RDBMS.

The value of each array element is an associative array with the following keys:

SCHEMA_NAME => string; name of database or schema TABLE_NAME => string; COLUMN_NAME => string; column name COLUMN_POSITION => number; ordinal position of column in table DATA_TYPE => string; SQL datatype name of column DEFAULT => string; default expression of column, null if none NULLABLE => boolean; true if column can have nulls LENGTH => number; length of CHAR/VARCHAR SCALE => number; scale of NUMERIC/DECIMAL PRECISION => number; precision of NUMERIC/DECIMAL UNSIGNED => boolean; unsigned property of an integer type PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key

  • access: public
  • todo: Discover integer unsigned property.
array describeTable (string $tableName, [string $schemaName = null])
  • string $tableName
  • string $schemaName: OPTIONAL

Redefinition of:
Zend_Db_Adapter_Abstract::describeTable()
Returns the column descriptions for a table.
lastInsertId (line 225)

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

As a convention, on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence from the arguments and returns the last id generated by that sequence. On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method returns the last value generated for such a column, and the table name argument is disregarded.

Oracle does not support IDENTITY columns, so if the sequence is not specified, this method returns null.

  • access: public
  • throws: Zend_Db_Adapter_Oracle_Exception
integer lastInsertId ([string $tableName = null], [string $primaryKey = 'id'])
  • string $tableName: OPTIONAL Name of table.
  • string $primaryKey: OPTIONAL Name of primary key column.

Redefinition of:
Zend_Db_Adapter_Abstract::lastInsertId()
Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
lastSequenceId (line 185)

Return the most recent value from the specified sequence in the database.

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

  • access: public
integer lastSequenceId (string $sequenceName)
  • string $sequenceName

Redefinition of:
Zend_Db_Adapter_Abstract::lastSequenceId()
Return the most recent value from the specified sequence in the database.
limit (line 391)

Adds an adapter-specific LIMIT clause to the SELECT statement.

  • access: public
  • throws: Zend_Db_Adapter_Oracle_Exception
string limit (string $sql, integer $count, integer $offset)
  • string $sql
  • integer $count
  • integer $offset: OPTIONAL

Redefinition of:
Zend_Db_Adapter_Abstract::limit()
Adds an adapter-specific LIMIT clause to the SELECT statement.
listTables (line 245)

Returns a list of the tables in the database.

  • access: public
array listTables ()

Redefinition of:
Zend_Db_Adapter_Abstract::listTables()
Returns a list of the tables in the database.
nextSequenceId (line 200)

Generate a new value from the specified sequence in the database, and return it.

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

  • access: public
integer nextSequenceId (string $sequenceName)
  • string $sequenceName

Redefinition of:
Zend_Db_Adapter_Abstract::nextSequenceId()
Generate a new value from the specified sequence in the database, and return it.
prepare (line 156)

Returns an SQL statement for preparation.

  • access: public
Zend_Db_Statement_Oracle prepare (string $sql)
  • string $sql: The SQL statement with placeholders.

Redefinition of:
Zend_Db_Adapter_Abstract::prepare()
Prepare a statement and return a PDOStatement-like object.
quoteTableAs (line 171)

Quote a table identifier and alias.

  • return: The quoted identifier and alias.
  • access: public
string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
  • string|array|Zend_Db_Expr $ident: The identifier or expression.
  • string $alias: An alias for the table.

Redefinition of:
Zend_Db_Adapter_Abstract::quoteTableAs()
Quote a table identifier and alias.
setFetchMode (line 367)

Set the fetch mode.

  • access: public
  • throws: Zend_Db_Adapter_Exception
  • todo: Support FETCH_CLASS and FETCH_INTO.
void setFetchMode (integer $mode)
  • integer $mode: A fetch mode.

Redefinition of:
Zend_Db_Adapter_Abstract::setFetchMode()
Set the fetch mode.
_beginTransaction (line 325)

Leave autocommit mode and begin a transaction.

  • access: protected
void _beginTransaction ()

Redefinition of:
Zend_Db_Adapter_Abstract::_beginTransaction()
Begin a transaction.
_commit (line 336)

Commit a transaction and return to autocommit mode.

  • access: protected
  • throws: Zend_Db_Adapter_Oracle_Exception
void _commit ()

Redefinition of:
Zend_Db_Adapter_Abstract::_commit()
Commit a transaction.
_connect (line 109)

Creates a connection resource.

  • access: protected
  • throws: Zend_Db_Adapter_Oracle_Exception
void _connect ()

Redefinition of:
Zend_Db_Adapter_Abstract::_connect()
Creates a connection to the database.
_getExecuteMode (line 441)
  • access: public
void _getExecuteMode ()
_rollBack (line 350)

Roll back a transaction and return to autocommit mode.

  • access: protected
  • throws: Zend_Db_Adapter_Oracle_Exception
void _rollBack ()

Redefinition of:
Zend_Db_Adapter_Abstract::_rollBack()
Roll-back a transaction.

Inherited Methods

Inherited From Zend_Db_Adapter_Abstract

 Zend_Db_Adapter_Abstract::__construct()
 Zend_Db_Adapter_Abstract::beginTransaction()
 Zend_Db_Adapter_Abstract::closeConnection()
 Zend_Db_Adapter_Abstract::commit()
 Zend_Db_Adapter_Abstract::delete()
 Zend_Db_Adapter_Abstract::describeTable()
 Zend_Db_Adapter_Abstract::fetchAll()
 Zend_Db_Adapter_Abstract::fetchAssoc()
 Zend_Db_Adapter_Abstract::fetchCol()
 Zend_Db_Adapter_Abstract::fetchOne()
 Zend_Db_Adapter_Abstract::fetchPairs()
 Zend_Db_Adapter_Abstract::fetchRow()
 Zend_Db_Adapter_Abstract::getConnection()
 Zend_Db_Adapter_Abstract::getFetchMode()
 Zend_Db_Adapter_Abstract::getProfiler()
 Zend_Db_Adapter_Abstract::getQuoteIdentifierSymbol()
 Zend_Db_Adapter_Abstract::insert()
 Zend_Db_Adapter_Abstract::lastInsertId()
 Zend_Db_Adapter_Abstract::lastSequenceId()
 Zend_Db_Adapter_Abstract::limit()
 Zend_Db_Adapter_Abstract::listTables()
 Zend_Db_Adapter_Abstract::nextSequenceId()
 Zend_Db_Adapter_Abstract::prepare()
 Zend_Db_Adapter_Abstract::query()
 Zend_Db_Adapter_Abstract::quote()
 Zend_Db_Adapter_Abstract::quoteColumnAs()
 Zend_Db_Adapter_Abstract::quoteIdentifier()
 Zend_Db_Adapter_Abstract::quoteInto()
 Zend_Db_Adapter_Abstract::quoteTableAs()
 Zend_Db_Adapter_Abstract::rollBack()
 Zend_Db_Adapter_Abstract::select()
 Zend_Db_Adapter_Abstract::setFetchMode()
 Zend_Db_Adapter_Abstract::update()
 Zend_Db_Adapter_Abstract::_beginTransaction()
 Zend_Db_Adapter_Abstract::_commit()
 Zend_Db_Adapter_Abstract::_connect()
 Zend_Db_Adapter_Abstract::_quote()
 Zend_Db_Adapter_Abstract::_quoteIdentifier()
 Zend_Db_Adapter_Abstract::_quoteIdentifierAs()
 Zend_Db_Adapter_Abstract::_rollBack()

Documentation generated on Fri, 06 Apr 2007 18:29:01 -0700 by phpDocumentor 1.3.1