Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Db_Adapter_Oracle Class Reference

Inheritance diagram for Zend_Db_Adapter_Oracle:
Zend_Db_Adapter_Abstract

Public Member Functions

 isConnected ()
 closeConnection ()
 setLobAsString ($lobAsString)
 getLobAsString ()
 prepare ($sql)
 quoteTableAs ($ident, $alias=null, $auto=false)
 lastSequenceId ($sequenceName)
 nextSequenceId ($sequenceName)
 lastInsertId ($tableName=null, $primaryKey=null)
 listTables ()
 describeTable ($tableName, $schemaName=null)
 setFetchMode ($mode)
 limit ($sql, $count, $offset=0)
 _getExecuteMode ()
 insert ($table, array $bind)
 supportsParameters ($type)
 getServerVersion ()

Protected Member Functions

 _connect ()
 _quote ($value)
 _beginTransaction ()
 _commit ()
 _rollBack ()

Protected Attributes

 $_config
 $_numericDataTypes
 $_execute_mode = null
 $_defaultStmtClass = 'Zend_Db_Statement_Oracle'
 $_lobAsString = null

Detailed Description

Definition at line 40 of file Oracle.php.


Member Function Documentation

_beginTransaction (  ) [protected]

Leave autocommit mode and begin a transaction.

Returns:
void

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 453 of file Oracle.php.

_commit (  ) [protected]

Commit a transaction and return to autocommit mode.

Returns:
void
Exceptions:
Zend_Db_Adapter_Oracle_Exception

See also:
Zend_Db_Adapter_Oracle_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 464 of file Oracle.php.

_connect (  ) [protected]

Creates a connection resource.

Returns:
void
Exceptions:
Zend_Db_Adapter_Oracle_Exception

See also:
Zend_Db_Adapter_Oracle_Exception
Zend_Db_Adapter_Oracle_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 107 of file Oracle.php.

_getExecuteMode (  )
Returns:
int

Definition at line 600 of file Oracle.php.

_quote ( value ) [protected]

Quote a raw string.

Parameters:
string$valueRaw string
Returns:
string Quoted string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 225 of file Oracle.php.

_rollBack (  ) [protected]

Roll back a transaction and return to autocommit mode.

Returns:
void
Exceptions:
Zend_Db_Adapter_Oracle_Exception

See also:
Zend_Db_Adapter_Oracle_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 482 of file Oracle.php.

closeConnection (  )

Force the connection to close.

Returns:
void

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 158 of file Oracle.php.

describeTable ( tableName,
schemaName = null 
)

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 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 IDENTITY => integer; true if column is auto-generated with unique values

Todo:
Discover integer unsigned property.
Parameters:
string$tableName
string$schemaNameOPTIONAL
Returns:
array

Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection

Oracle does not support auto-increment keys.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 354 of file Oracle.php.

getLobAsString (  )

Return whether or not LOB are returned as string

Returns:
boolean

Definition at line 183 of file Oracle.php.

getServerVersion (  )

Retrieve server version in PHP style

Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 667 of file Oracle.php.

insert ( table,
array $  bind 
)

Inserts a table row with specified data.

Oracle does not support anonymous ('?') binds.

Parameters:
mixed$tableThe table to insert data into.
array$bindColumn-value pairs.
Returns:
int The number of affected rows.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 614 of file Oracle.php.

isConnected (  )

Test if a connection is active

Returns:
boolean

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 147 of file Oracle.php.

lastInsertId ( tableName = null,
primaryKey = null 
)

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.

Parameters:
string$tableNameOPTIONAL Name of table.
string$primaryKeyOPTIONAL Name of primary key column.
Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 297 of file Oracle.php.

lastSequenceId ( sequenceName )

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.

Parameters:
string$sequenceName
Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 256 of file Oracle.php.

limit ( sql,
count,
offset = 0 
)

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

Parameters:
string$sql
integer$count
integer$offsetOPTIONAL
Returns:
string
Exceptions:
Zend_Db_Adapter_Oracle_Exception

See also:
Zend_Db_Adapter_Oracle_Exception
Zend_Db_Adapter_Oracle_Exception

Oracle does not implement the LIMIT clause as some RDBMS do. We have to simulate it with subqueries and ROWNUM. Unfortunately because we use the column wildcard "*", this puts an extra column into the query result set.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 538 of file Oracle.php.

listTables (  )

Returns a list of the tables in the database.

Returns:
array

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 317 of file Oracle.php.

nextSequenceId ( sequenceName )

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.

Parameters:
string$sequenceName
Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 272 of file Oracle.php.

prepare ( sql )

Returns an SQL statement for preparation.

Parameters:
string$sqlThe SQL statement with placeholders.
Returns:
Zend_Db_Statement_Oracle

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 203 of file Oracle.php.

quoteTableAs ( ident,
alias = null,
auto = false 
)

Quote a table identifier and alias.

Parameters:
string | array | Zend_Db_Expr$identThe identifier or expression.
string$aliasAn alias for the table.
boolean$autoIf true, heed the AUTO_QUOTE_IDENTIFIERS config option.
Returns:
string The quoted identifier and alias.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 242 of file Oracle.php.

setFetchMode ( mode )

Set the fetch mode.

Todo:
Support FETCH_CLASS and FETCH_INTO.
Parameters:
integer$modeA fetch mode.
Returns:
void
Exceptions:
Zend_Db_Adapter_Oracle_Exception

See also:
Zend_Db_Adapter_Oracle_Exception
Zend_Db_Adapter_Oracle_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 503 of file Oracle.php.

setLobAsString ( lobAsString )

Activate/deactivate return of LOB as string

Parameters:
string$lob_as_string
Returns:
Zend_Db_Adapter_Oracle

Definition at line 172 of file Oracle.php.

supportsParameters ( type )

Check if the adapter supports real SQL parameters.

Parameters:
string$type'positional' or 'named'
Returns:
bool

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 651 of file Oracle.php.


Field Documentation

$_config [protected]
Initial value:
 array(
        'dbname'       => null,
        'username'     => null,
        'password'     => null,
        'persistent'   => false
    )

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 54 of file Oracle.php.

$_numericDataTypes [protected]
Initial value:
 array(
        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,
        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,
        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE,
        'BINARY_DOUBLE'      => Zend_Db::FLOAT_TYPE,
        'BINARY_FLOAT'       => Zend_Db::FLOAT_TYPE,
        'NUMBER'             => Zend_Db::FLOAT_TYPE,
    )

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 72 of file Oracle.php.


The documentation for this class was generated from the following file: