Db/Adapter/Pdo/Oci.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: Oci.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Db_Adapter_Pdo_Oci

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_Pdo_Oci
jump to top

Extends from: Zend_Db_Adapter_Pdo_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: $_pdoType; $_defaultStmtClass; $_numericDataTypes
Methods: _dsn; _quote; quoteTableAs; listTables; describeTable; lastSequenceId; nextSequenceId; lastInsertId; limit

Description

Class for connecting to Oracle databases and performing common operations.

Properties

$_defaultStmtClass
jump to class

string $_defaultStmtClass = 'Zend_Db_Statement_Pdo_Oci'

Default class name for a DB statement.

Details

$_defaultStmtClass: string
visibility: protected
default: Zend_Db_Statement_Pdo_Oci
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

$_pdoType
jump to class

string $_pdoType = 'oci'

PDO type.

Details

$_pdoType: string
visibility: protected
default: oci
final: false
static: false

Methods

_dsn
jump to class

_dsn(
          
          )
        
        :
        string

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

Output

string

Details

visibility: protected
final: false
static: false

_quote
jump to class

_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.

Arguments

$value: string
Raw string

Output

string: Quoted string

Details

visibility: protected
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.

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
throws

lastSequenceId
jump to class

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

Arguments

$sequenceName: string

Output

integer

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

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
          )
        
        :
        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.

Arguments

$sequenceName: string

Output

integer

Details

visibility: public
final: false
static: false

quoteTableAs
jump to class

quoteTableAs(
          string|array|Zend_Db_Expr $ident, string $alias
              =
              null,  $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

Output

string: The quoted identifier and alias.

Details

visibility: public
final: false
static: false

API Documentation

Db/Adapter/Pdo/Oci.php

Description

Zend_Db_Adapter_Pdo_Ocijump to top

Description

Properties

$_defaultStmtClassjump to class

Details

$_numericDataTypesjump to class

Details

$_pdoTypejump to class

Details

Methods

_dsnjump to class

Output

Details

_quotejump to class

Arguments

Output

Details

describeTablejump to class

Arguments

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

quoteTableAsjump to class

Arguments

Output

Details

Zend_Db_Adapter_Pdo_Oci
jump to top

$_defaultStmtClass
jump to class

$_numericDataTypes
jump to class

$_pdoType
jump to class

_dsn
jump to class

_quote
jump to class

describeTable
jump to class

lastInsertId
jump to class

lastSequenceId
jump to class

limit
jump to class

listTables
jump to class

nextSequenceId
jump to class

quoteTableAs
jump to class