Db/Adapter/Oracle.php

Show:

inherited

Classes
- \Zend_Db_Adapter_Oracle

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Db
Subpackage: Adapter
Version: $Id$

\Zend_Db_Adapter_Oracle
jump to top

Package: Zend_Db\Adapter

Class for connecting to SQL databases and performing common operations.

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

Properties

array $_config = array('dbname' => null, 'username' => null, 'password' => null, 'persistent' => false)

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' => null, 'username' => null, 'password' => null, 'persistent' => false)Details

Type: array

string $_defaultStmtClass = 'Zend_Db_Statement_Oracle'

Default class name for a DB statement.

Default value'Zend_Db_Statement_Oracle'Details

Type: string

integer $_execute_mode = null

Default valuenullDetails

Type: integer

boolean $_lobAsString = null

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

Default valuenullDetails

Type: boolean

array $_numericDataTypes = 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)

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

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

Details

Type: array

Methods

_beginTransaction() : void

Leave autocommit mode and begin a transaction.

_commit() : void

Commit a transaction and return to autocommit mode.

Throws

Exception	Description
\Zend_Db_Adapter_Oracle_Exception

_connect() : void

Creates a connection resource.

Throws

Exception	Description
\Zend_Db_Adapter_Oracle_Exception

_getExecuteMode() : int

Returns

Type	Description
int

_quote(string $value) : string

Quote a raw string.

Parameters

Name	Type	Description
$value	string	Raw string

Returns

Type	Description
string	Quoted string

_rollBack() : void

Roll back a transaction and return to autocommit mode.

Throws

Exception	Description
\Zend_Db_Adapter_Oracle_Exception

_setExecuteMode(integer $mode) : void

Parameters

Name	Type	Description
$mode	integer

Throws

Exception	Description
\Zend_Db_Adapter_Oracle_Exception

closeConnection() : void

Force the connection to close.

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

Parameters

Name	Type	Description
$tableName	string
$schemaName	string	OPTIONAL

Returns

Type	Description
array

Details

Todo: Discover integer unsigned property.

getLobAsString() : boolean

Return whether or not LOB are returned as string

Returns

Type	Description
boolean

getServerVersion() : string

Retrieve server version in PHP style

Returns

Type	Description
string

isConnected() : boolean

Test if a connection is active

Returns

Type	Description
boolean

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.

Parameters

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

Returns

Type	Description
string

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.

Parameters

Name	Type	Description
$sequenceName	string

Returns

Type	Description
string

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

listTables() : array

Returns a list of the tables in the database.

Returns

Type	Description
array

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.

Parameters

Name	Type	Description
$sequenceName	string

Returns

Type	Description
string

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

quoteTableAs(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.

setFetchMode(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.

setLobAsString( $lobAsString) : \Zend_Db_Adapter_Oracle

Activate/deactivate return of LOB as string

Parameters

Name	Type	Description
$lobAsString

Returns

Type	Description
\Zend_Db_Adapter_Oracle

supportsParameters(string $type) : bool

Check if the adapter supports real SQL parameters.

Parameters

Name	Type	Description
$type	string	'positional' or 'named'

Returns

Type	Description
bool

Db/Adapter/Oracle.php

\Zend_Db_Adapter_Oraclejump to top

Properties

Methods

\Zend_Db_Adapter_Oracle
jump to top