Class Zend_Db_Adapter_Pdo_Oci

Description

Class for connecting to Oracle databases and performing common operations.

  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Db/Adapter/Pdo/Oci.php (line 41)

Zend_Db_Adapter_Abstract
   |
   --Zend_Db_Adapter_Pdo_Abstract
      |
      --Zend_Db_Adapter_Pdo_Oci
Variable Summary
 string $_pdoType
Method Summary
 array describeTable (string $tableName, [string $schemaName = null])
 integer lastInsertId ([string $tableName = null], [string $primaryKey = 'id'])
 integer lastSequenceId (string $sequenceName)
 string limit (string $sql, integer $count, [integer $offset = 0])
 array listTables ()
 integer nextSequenceId (string $sequenceName)
 string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
 string _dsn ()
 string _quote (string $value)
Variables
Methods
describeTable (line 137)

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 database or 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

  • access: public
  • todo: Discover integer unsigned property.
array describeTable (string $tableName, [string $schemaName = null])
  • string $tableName
  • string $schemaName: OPTIONAL

Redefinition of:
Zend_Db_Adapter_Abstract::describeTable()
Returns the column descriptions for a table.
lastInsertId (line 224)

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.

  • access: public
  • throws: Zend_Db_Adapter_Oracle_Exception
integer lastInsertId ([string $tableName = null], [string $primaryKey = 'id'])
  • string $tableName: OPTIONAL Name of table.
  • string $primaryKey: OPTIONAL Name of primary key column.

Redefinition of:
Zend_Db_Adapter_Pdo_Abstract::lastInsertId()
Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
lastSequenceId (line 184)

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.

  • access: public
integer lastSequenceId (string $sequenceName)
  • string $sequenceName

Redefinition of:
Zend_Db_Adapter_Abstract::lastSequenceId()
Return the most recent value from the specified sequence in the database.
limit (line 245)

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

  • access: public
string limit (string $sql, integer $count, integer $offset)
  • string $sql
  • integer $count
  • integer $offset

Redefinition of:
Zend_Db_Adapter_Abstract::limit()
Adds an adapter-specific LIMIT clause to the SELECT statement.
listTables (line 102)

Returns a list of the tables in the database.

  • access: public
array listTables ()

Redefinition of:
Zend_Db_Adapter_Abstract::listTables()
Returns a list of the tables in the database.
nextSequenceId (line 199)

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.

  • access: public
integer nextSequenceId (string $sequenceName)
  • string $sequenceName

Redefinition of:
Zend_Db_Adapter_Abstract::nextSequenceId()
Generate a new value from the specified sequence in the database, and return it.
quoteTableAs (line 91)

Quote a table identifier and alias.

  • return: The quoted identifier and alias.
  • access: public
string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
  • string|array|Zend_Db_Expr $ident: The identifier or expression.
  • string $alias: An alias for the table.

Redefinition of:
Zend_Db_Adapter_Abstract::quoteTableAs()
Quote a table identifier and alias.
_dsn (line 56)

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

  • access: protected
string _dsn ()

Redefinition of:
Zend_Db_Adapter_Pdo_Abstract::_dsn()
Creates a PDO DSN for the adapter from $this->_config settings.
_quote (line 79)

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.

  • return: Quoted string
  • access: protected
string _quote (string $value)
  • string $value: Raw string

Redefinition of:
Zend_Db_Adapter_Pdo_Abstract::_quote()
Quote a raw string.

Inherited Methods

Inherited From Zend_Db_Adapter_Pdo_Abstract

 Zend_Db_Adapter_Pdo_Abstract::closeConnection()
 Zend_Db_Adapter_Pdo_Abstract::lastInsertId()
 Zend_Db_Adapter_Pdo_Abstract::prepare()
 Zend_Db_Adapter_Pdo_Abstract::query()
 Zend_Db_Adapter_Pdo_Abstract::setFetchMode()
 Zend_Db_Adapter_Pdo_Abstract::_beginTransaction()
 Zend_Db_Adapter_Pdo_Abstract::_commit()
 Zend_Db_Adapter_Pdo_Abstract::_connect()
 Zend_Db_Adapter_Pdo_Abstract::_dsn()
 Zend_Db_Adapter_Pdo_Abstract::_quote()
 Zend_Db_Adapter_Pdo_Abstract::_rollBack()

Inherited From Zend_Db_Adapter_Abstract

 Zend_Db_Adapter_Abstract::__construct()
 Zend_Db_Adapter_Abstract::beginTransaction()
 Zend_Db_Adapter_Abstract::closeConnection()
 Zend_Db_Adapter_Abstract::commit()
 Zend_Db_Adapter_Abstract::delete()
 Zend_Db_Adapter_Abstract::describeTable()
 Zend_Db_Adapter_Abstract::fetchAll()
 Zend_Db_Adapter_Abstract::fetchAssoc()
 Zend_Db_Adapter_Abstract::fetchCol()
 Zend_Db_Adapter_Abstract::fetchOne()
 Zend_Db_Adapter_Abstract::fetchPairs()
 Zend_Db_Adapter_Abstract::fetchRow()
 Zend_Db_Adapter_Abstract::getConnection()
 Zend_Db_Adapter_Abstract::getFetchMode()
 Zend_Db_Adapter_Abstract::getProfiler()
 Zend_Db_Adapter_Abstract::getQuoteIdentifierSymbol()
 Zend_Db_Adapter_Abstract::insert()
 Zend_Db_Adapter_Abstract::lastInsertId()
 Zend_Db_Adapter_Abstract::lastSequenceId()
 Zend_Db_Adapter_Abstract::limit()
 Zend_Db_Adapter_Abstract::listTables()
 Zend_Db_Adapter_Abstract::nextSequenceId()
 Zend_Db_Adapter_Abstract::prepare()
 Zend_Db_Adapter_Abstract::query()
 Zend_Db_Adapter_Abstract::quote()
 Zend_Db_Adapter_Abstract::quoteColumnAs()
 Zend_Db_Adapter_Abstract::quoteIdentifier()
 Zend_Db_Adapter_Abstract::quoteInto()
 Zend_Db_Adapter_Abstract::quoteTableAs()
 Zend_Db_Adapter_Abstract::rollBack()
 Zend_Db_Adapter_Abstract::select()
 Zend_Db_Adapter_Abstract::setFetchMode()
 Zend_Db_Adapter_Abstract::update()
 Zend_Db_Adapter_Abstract::_beginTransaction()
 Zend_Db_Adapter_Abstract::_commit()
 Zend_Db_Adapter_Abstract::_connect()
 Zend_Db_Adapter_Abstract::_quote()
 Zend_Db_Adapter_Abstract::_quoteIdentifier()
 Zend_Db_Adapter_Abstract::_quoteIdentifierAs()
 Zend_Db_Adapter_Abstract::_rollBack()

Documentation generated on Fri, 06 Apr 2007 18:28:33 -0700 by phpDocumentor 1.3.1