API Documentation

Zend/Db/Adapter/Oracle.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Adapter  
Version
$Id: Oracle.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Db_Adapter_Oracle

Package: Zend\Db\Adapter

Parent(s)
\Zend_Db_Adapter_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_config= 'array( 'dbname' => null'

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

Default valuearray( 'dbname' => nullDetails
Type
array
Propertyprotectedstring  $_defaultStmtClass= ''Zend_Db_Statement_Oracle''

Default class name for a DB statement.

Default value'Zend_Db_Statement_Oracle'Details
Type
string
Propertyprotectedinteger  $_execute_mode= 'null'

Default valuenullDetails
Type
integer
Propertyprotectedboolean  $_lobAsString= 'null'

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

Default valuenullDetails
Type
boolean
Propertyprotectedarray  $_numericDataTypes= 'array( Zend_Db::INT_TYPE => Zend_Db::INT_TYPE'

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

Associative array of datatypes to values 0, 1, or 2.

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

Default valuearray( Zend_Db::INT_TYPE => Zend_Db::INT_TYPEDetails
Type
array

Methods

methodprotected_beginTransaction( ) : void

Leave autocommit mode and begin a transaction.

methodprotected_commit( ) : void

Commit a transaction and return to autocommit mode.

Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodprotected_connect( ) : void

Creates a connection resource.

Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodpublic_getExecuteMode( ) : int

Returns
Type Description
int
methodprotected_quote( string $value ) : string

Quote a raw string.

Parameters
Name Type Description
$value string

Raw string

Returns
Type Description
string Quoted string
methodprotected_rollBack( ) : void

Roll back a transaction and return to autocommit mode.

Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodprivate_setExecuteMode( integer $mode ) : void

Parameters
Name Type Description
$mode integer
Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodpubliccloseConnection( ) : void

Force the connection to close.

methodpublicdescribeTable( 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

Parameters
Name Type Description
$tableName string
$schemaName string

OPTIONAL

Returns
Type Description
array
Details
Todo
Discover integer unsigned property.  
methodpublicgetLobAsString( ) : boolean

Return whether or not LOB are returned as string

Returns
Type Description
boolean
methodpublicgetServerVersion( ) : string

Retrieve server version in PHP style

Returns
Type Description
string
methodpublicisConnected( ) : boolean

Test if a connection is active

Returns
Type Description
boolean
methodpubliclastInsertId( 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.

Parameters
Name Type Description
$tableName string

OPTIONAL Name of table.

$primaryKey string

OPTIONAL Name of primary key column.

Returns
Type Description
string
methodpubliclastSequenceId( 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.

Parameters
Name Type Description
$sequenceName string
Returns
Type Description
string
methodpubliclimit( string $sql, integer $count, integer $offset = 0 ) : string

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

Parameters
Name Type Description
$sql string
$count integer
$offset integer

OPTIONAL

Returns
Type Description
string
Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodpubliclistTables( ) : array

Returns a list of the tables in the database.

Returns
Type Description
array
methodpublicnextSequenceId( 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.

Parameters
Name Type Description
$sequenceName string
Returns
Type Description
string
methodpublicprepare( string $sql ) : \Zend_Db_Statement_Oracle

Returns an SQL statement for preparation.

Parameters
Name Type Description
$sql string

The SQL statement with placeholders.

Returns
Type Description
\Zend_Db_Statement_Oracle
methodpublicquoteTableAs( string|array|\Zend_Db_Expr $ident, string $alias = null, boolean $auto = false ) : string

Quote a table identifier and alias.

Parameters
Name Type Description
$ident string|array|\Zend_Db_Expr

The identifier or expression.

$alias string

An alias for the table.

$auto boolean

If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns
Type Description
string The quoted identifier and alias.
methodpublicsetFetchMode( integer $mode ) : void

Set the fetch mode.

Parameters
Name Type Description
$mode integer

A fetch mode.

Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
Details
Todo
Support FETCH_CLASS and FETCH_INTO.  
methodpublicsetLobAsString(  $lobAsString ) : \Zend_Db_Adapter_Oracle

Activate/deactivate return of LOB as string

Parameters
Name Type Description
$lobAsString
Returns
Type Description
\Zend_Db_Adapter_Oracle
methodpublicsupportsParameters( string $type ) : bool

Check if the adapter supports real SQL parameters.

Parameters
Name Type Description
$type string

'positional' or 'named'

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.