Db/Adapter/Oracle.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Adapter
version: $Id: Oracle.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Db_Adapter_Oracle

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Db_Adapter_Oracle
jump to top

Extends from: Zend_Db_Adapter_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Adapter
Properties: $_config; $_numericDataTypes; $_execute_mode; $_defaultStmtClass; $_lobAsString
Methods: _connect; isConnected; closeConnection; setLobAsString; getLobAsString; prepare; _quote; quoteTableAs; lastSequenceId; nextSequenceId; lastInsertId; listTables; describeTable; _beginTransaction; _commit; _rollBack; setFetchMode; limit; _setExecuteMode; _getExecuteMode; insert; supportsParameters; getServerVersion

Description

Properties

$_config
jump to class

array $_config = 'array'

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. persistent => (boolean) Set TRUE to use a persistent connection

Details

$_config: array
visibility: protected
default: array
final: false
static: false

$_defaultStmtClass
jump to class

string $_defaultStmtClass = 'Zend_Db_Statement_Oracle'

Default class name for a DB statement.

Details

$_defaultStmtClass: string
visibility: protected
default: Zend_Db_Statement_Oracle
final: false
static: false

$_execute_mode
jump to class

integer $_execute_mode = 'null'

Details

$_execute_mode: integer
visibility: protected
default: null
final: false
static: false

$_lobAsString
jump to class

boolean $_lobAsString = 'null'

Check if LOB field are returned as string instead of OCI-Lob object

Details

$_lobAsString: boolean
visibility: protected
default: null
final: false
static: false

$_numericDataTypes
jump to class

array $_numericDataTypes = 'array'

Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

Values are: 0 = 32-bit integer 1 = 64-bit integer 2 = float or decimal

Details

$_numericDataTypes: array
Associative array of datatypes to values 0, 1, or 2.
visibility: protected
default: array
final: false
static: false

Methods

_beginTransaction
jump to class

_beginTransaction(
          
          )
        
        :
        void

Leave autocommit mode and begin a transaction.

Details

visibility: protected
final: false
static: false

_commit
jump to class

_commit(
          
          )
        
        :
        void

Commit a transaction and return to autocommit mode.

Details

visibility: protected
final: false
static: false
throws

_connect
jump to class

_connect(
          
          )
        
        :
        void

Creates a connection resource.

Details

visibility: protected
final: false
static: false
throws

_getExecuteMode
jump to class

_getExecuteMode(
          
          )
        
        :
        int

Output

int

Details

visibility: public
final: false
static: false

_quote
jump to class

_quote(
          string $value
          )
        
        :
        string

Quote a raw string.

Arguments

$value: string
Raw string

Output

string: Quoted string

Details

visibility: protected
final: false
static: false

_rollBack
jump to class

_rollBack(
          
          )
        
        :
        void

Roll back a transaction and return to autocommit mode.

Details

visibility: protected
final: false
static: false
throws

_setExecuteMode
jump to class

_setExecuteMode(
          integer $mode
          )
        
        :

Arguments

$mode: integer

Details

visibility: private
final: false
static: false
throws

closeConnection
jump to class

closeConnection(
          
          )
        
        :
        void

Force the connection to close.

Details

visibility: public
final: false
static: false

describeTable
jump to class

describeTable(
          string $tableName, string $schemaName
              =
              null
          )
        
        :
        array

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

Arguments

$tableName: string
$schemaName: string
OPTIONAL

Output

array

Details

visibility: public
final: false
static: false
todo: Discover integer unsigned property.

getLobAsString
jump to class

getLobAsString(
          
          )
        
        :
        boolean

Return whether or not LOB are returned as string

Output

boolean

Details

visibility: public
final: false
static: false

getServerVersion
jump to class

getServerVersion(
          
          )
        
        :
        string

Retrieve server version in PHP style

Output

string

Details

visibility: public
final: false
static: false

insert
jump to class

insert(
          mixed $table, array $bind
          )
        
        :
        int

Inserts a table row with specified data.

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

Arguments

$table: mixed
The table to insert data into.
$bind: array
Column-value pairs.

Output

int: The number of affected rows.

Details

visibility: public
final: false
static: false

isConnected
jump to class

isConnected(
          
          )
        
        :
        boolean

Test if a connection is active

Output

boolean

Details

visibility: public
final: false
static: false

lastInsertId
jump to class

lastInsertId(
          string $tableName
              =
              null, string $primaryKey
              =
              null
          )
        
        :
        string

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.

Arguments

$tableName: string
OPTIONAL Name of table.
$primaryKey: string
OPTIONAL Name of primary key column.

Output

string

Details

visibility: public
final: false
static: false

lastSequenceId
jump to class

lastSequenceId(
          string $sequenceName
          )
        
        :
        string

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.

Arguments

$sequenceName: string

Output

string

Details

visibility: public
final: false
static: false

limit
jump to class

limit(
          string $sql, integer $count, integer $offset
              =
              0
          )
        
        :
        string

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

Arguments

$sql: string
$count: integer
$offset: integer
OPTIONAL

Output

string

Details

visibility: public
final: false
static: false
throws

listTables
jump to class

listTables(
          
          )
        
        :
        array

Returns a list of the tables in the database.

Output

array

Details

visibility: public
final: false
static: false

nextSequenceId
jump to class

nextSequenceId(
          string $sequenceName
          )
        
        :
        string

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.

Arguments

$sequenceName: string

Output

string

Details

visibility: public
final: false
static: false

prepare
jump to class

prepare(
          string $sql
          )
        
        :
        Zend_Db_Statement_Oracle

Returns an SQL statement for preparation.

Arguments

$sql: string
The SQL statement with placeholders.

Output

Zend_Db_Statement_Oracle

Details

visibility: public
final: false
static: false

quoteTableAs
jump to class

quoteTableAs(
          string|array|Zend_Db_Expr $ident, string $alias
              =
              null, boolean $auto
              =
              false
          )
        
        :
        string

Quote a table identifier and alias.

Arguments

$ident: stringarrayZend_Db_Expr
The identifier or expression.
$alias: string
An alias for the table.
$auto: boolean
If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Output

string: The quoted identifier and alias.

Details

visibility: public
final: false
static: false

setFetchMode
jump to class

setFetchMode(
          integer $mode
          )
        
        :
        void

Set the fetch mode.

Arguments

$mode: integer
A fetch mode.

Details

visibility: public
final: false
static: false
throws
todo: Support FETCH_CLASS and FETCH_INTO.

setLobAsString
jump to class

setLobAsString(
           $lobAsString
          )
        
        :
        Zend_Db_Adapter_Oracle

Activate/deactivate return of LOB as string

Arguments

$lobAsString

Output

Zend_Db_Adapter_Oracle

Details

visibility: public
final: false
static: false

supportsParameters
jump to class

supportsParameters(
          string $type
          )
        
        :
        bool

Check if the adapter supports real SQL parameters.

Arguments

$type: string
'positional' or 'named'

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Db/Adapter/Oracle.php

Description

Zend_Db_Adapter_Oraclejump to top

Description

Properties

$_configjump to class

Details

$_defaultStmtClassjump to class

Details

$_execute_modejump to class

Details

$_lobAsStringjump to class

Details

$_numericDataTypesjump to class

Details

Methods

_beginTransactionjump to class

Details

_commitjump to class

Details

_connectjump to class

Details

_getExecuteModejump to class

Output

Details

_quotejump to class

Arguments

Output

Details

_rollBackjump to class

Details

_setExecuteModejump to class

Arguments

Details

closeConnectionjump to class

Details

describeTablejump to class

Arguments

Output

Details

getLobAsStringjump to class

Output

Details

getServerVersionjump to class

Output

Details

insertjump to class

Arguments

Output

Details

isConnectedjump to class

Output

Details

lastInsertIdjump to class

Arguments

Output

Details

lastSequenceIdjump to class

Arguments

Output

Details

limitjump to class

Arguments

Output

Details

listTablesjump to class

Output

Details

nextSequenceIdjump to class

Arguments

Output

Details

preparejump to class

Arguments

Output

Details

quoteTableAsjump to class

Arguments

Output

Zend_Db_Adapter_Oracle
jump to top

$_config
jump to class

$_defaultStmtClass
jump to class

$_execute_mode
jump to class

$_lobAsString
jump to class

$_numericDataTypes
jump to class

_beginTransaction
jump to class

_commit
jump to class

_connect
jump to class

_getExecuteMode
jump to class

_quote
jump to class

_rollBack
jump to class

_setExecuteMode
jump to class

closeConnection
jump to class

describeTable
jump to class

getLobAsString
jump to class

getServerVersion
jump to class

insert
jump to class

isConnected
jump to class

lastInsertId
jump to class

lastSequenceId
jump to class

limit
jump to class

listTables
jump to class

nextSequenceId
jump to class

prepare
jump to class

quoteTableAs
jump to class

setFetchMode
jump to class

setLobAsString
jump to class

supportsParameters
jump to class