## 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 (array $config)
array describeTable (string $tableName, [string $schemaName = null])
integer lastInsertId ([ $tableName = null], [ $primaryKey = null], string $sequenceName)
string limit (string $sql, integer $count, [integer $offset = 0])
array listTables ()
Zend_Db_Statement_Oracle prepare (string $sql)
void setFetchMode (integer $mode)
void _beginTransaction ()
void _commit ()
void _connect ()
void _getExecuteMode ()
string _quote (string $value)
void _rollBack ()
Variables
array $_config = array(
'dbname' => null,
'username' => null,
'password' => null,
) (line 53)

User-provided configuration.

Basic keys are:

username => (string) Connect to the database as this username. password => (string) Password associated with the username. database => 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
- todo: fix inconsistency between "database" used here and "dbname" use elsewhere

Redefinition of:

Zend_Db_Adapter_Abstract::$_config
  User-provided configuration

integer $_execute_mode = OCI_COMMIT_ON_SUCCESS (line 62)

- 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 78)

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. database => 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 (array $config)

- array $config: An array of configuration keys.

Redefinition of:

Zend_Db_Adapter_Abstract::__construct()
  Constructor.

describeTable (line 219)

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

- access: public
- todo: Discover column position.
- todo: Discover integer unsigned property.
- todo: Improve discovery of primary key columns.

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 167)

Gets the last inserted ID.

- access: public
- throws: Zend_Db_Adapter_Oracle_Exception

integer lastInsertId ([ $tableName = null], [ $primaryKey = null], string $sequenceName)

- string $sequenceName: Name of sequence to query.
- $tableName
- $primaryKey

Redefinition of:

Zend_Db_Adapter_Abstract::lastInsertId()
  Gets the last inserted ID.

limit (line 330)

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 182)

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.

prepare (line 152)

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.

setFetchMode (line 294)

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 252)

Leave autocommit mode and begin a transaction.

- access: protected

void _beginTransaction ()

Redefinition of:

Zend_Db_Adapter_Abstract::_beginTransaction()
  Begin a transaction.

_commit (line 263)

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 116)

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 380)

- access: public

void _getExecuteMode ()
_quote (line 315)

Quote a raw string.

- return: Quoted string
- access: public

string _quote (string $value)

- string $value: Raw string

Redefinition of:

Zend_Db_Adapter_Abstract::_quote()
  Quote a raw string.

_rollBack (line 277)

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::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::limit()
> Zend_Db_Adapter_Abstract::listTables()
> Zend_Db_Adapter_Abstract::prepare()
> Zend_Db_Adapter_Abstract::query()
> Zend_Db_Adapter_Abstract::quote()
> Zend_Db_Adapter_Abstract::quoteIdentifier()
> Zend_Db_Adapter_Abstract::quoteInto()
> 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::_rollBack()

Documentation generated on Wed, 21 Feb 2007 11:56:04 -0800 by phpDocumentor 1.3.1