API Documentation

Zend/Db/Adapter/Pdo/Oci.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: Oci.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Db_Adapter_Pdo_Oci

Package: Zend\Db\Adapter

Class for connecting to Oracle databases and performing common operations.

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

Properties

Propertyprotectedstring  $_defaultStmtClass= ''Zend_Db_Statement_Pdo_Oci''

Default class name for a DB statement.

Default value'Zend_Db_Statement_Pdo_Oci'Details
Type
string
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
Propertyprotectedstring  $_pdoType= ''oci''

PDO type.

Default value'oci'Details
Type
string

Methods

methodprotected_dsn( ) : string

Creates a PDO DSN for the adapter from $this->_config settings.

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

Quote a raw string.

Most PDO drivers have an implementation for the quote() method, but the Oracle OCI driver must use the same implementation as the Zend_Db_Adapter_Abstract class.

Parameters
Name Type Description
$value string

Raw string

Returns
Type Description
string Quoted string
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.  
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
Throws
Exception Description
\Zend_Db_Adapter_Oracle_Exception
methodpubliclastSequenceId( string $sequenceName ) : integer

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
integer
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
Returns
Type Description
string
Throws
Exception Description
\Zend_Db_Adapter_Exception
methodpubliclistTables( ) : array

Returns a list of the tables in the database.

Returns
Type Description
array
methodpublicnextSequenceId( string $sequenceName ) : integer

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
integer
methodpublicquoteTableAs( string|array|\Zend_Db_Expr $ident, string $alias = null,  $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
Returns
Type Description
string The quoted identifier and alias.
Documentation was generated by DocBlox 0.15.1.