Class Zend_Db_Adapter_Db2

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

Located in /Db/Adapter/Db2.php (line 46)

Zend_Db_Adapter_Abstract
   |
   --Zend_Db_Adapter_Db2
Variable Summary
Method Summary
 void closeConnection ()
 array describeTable (string $tableName, [string $schemaName = null])
 string getServerVersion ()
 boolean isConnected ()
 bool isI5 ()
 string lastInsertId ([string $tableName = null], [string $primaryKey = null], [string $idType = null])
 string lastSequenceId (string $sequenceName)
 string limit (string $sql, integer $count, [integer $offset = 0])
 array listTables ([string $schema = null])
 string nextSequenceId (string $sequenceName)
 void setFetchMode (integer $mode)
 bool supportsParameters (string $type)
 void _commit ()
 void _connect ()
 void _determineI5 ()
 void _i5LastInsertId ([ $objectName = null], [ $idType = null])
 array _i5listTables ([ $schema = null])
 string _quote (string $value)
 void _rollBack ()
 void _setExecuteMode (integer $mode)
Variables
array $_config = array(
'dbname' => null,
'username' => null,
'password' => null,
'host' => 'localhost',
'port' => '50000',
'protocol' => 'TCPIP',
'persistent' => false,
'os' => null,
'schema' => null
)
(line 65)

User-provided configuration.

Basic keys are:

username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to (default 127.0.0.1) dbname => (string) The name of the database to user protocol => (string) Protocol to use, defaults to "TCPIP" port => (integer) Port number to use for TCP/IP if protocol is "TCPIP" persistent => (boolean) Set TRUE to use a persistent connection (db2_pconnect) os => (string) This should be set to 'i5' if the db is on an os400/i5 schema => (string) The default schema the connection should use

  • access: protected

Redefinition of:
Zend_Db_Adapter_Abstract::$_config
User-provided configuration
string $_defaultStmtClass = 'Zend_Db_Statement_Db2' (line 89)

Default class name for a DB statement.

  • access: protected

Redefinition of:
Zend_Db_Adapter_Abstract::$_defaultStmtClass
Default class name for a DB statement.
int $_execute_mode = DB2_AUTOCOMMIT_ON (line 82)

Execution mode

  • var: execution flag (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
  • access: protected
mixed $_isI5 = false (line 90)
  • access: protected
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,
'INTEGER' => Zend_Db::INT_TYPE,
'SMALLINT' => Zend_Db::INT_TYPE,
'BIGINT' => Zend_Db::BIGINT_TYPE,
'DECIMAL' => Zend_Db::FLOAT_TYPE,
'NUMERIC' => Zend_Db::FLOAT_TYPE
)
(line 103)

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

Values are:

  1. = 32-bit integer
  2. = 64-bit integer
  3. = float or decimal

  • var: Associative array of datatypes to values 0, 1, or 2.
  • access: protected

Redefinition of:
Zend_Db_Adapter_Abstract::$_numericDataTypes
Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

Inherited Variables

Inherited from Zend_Db_Adapter_Abstract

Zend_Db_Adapter_Abstract::$_allowSerialization
Zend_Db_Adapter_Abstract::$_autoQuoteIdentifiers
Zend_Db_Adapter_Abstract::$_autoReconnectOnUnserialize
Zend_Db_Adapter_Abstract::$_caseFolding
Zend_Db_Adapter_Abstract::$_connection
Zend_Db_Adapter_Abstract::$_defaultProfilerClass
Zend_Db_Adapter_Abstract::$_fetchMode
Zend_Db_Adapter_Abstract::$_profiler
Methods
closeConnection (line 208)

Force the connection to close.

  • access: public
void closeConnection ()

Redefinition of:
Zend_Db_Adapter_Abstract::closeConnection()
Force the connection to close.
describeTable (line 368)

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 DB2 not supports UNSIGNED integer. 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

  • access: public
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.
getQuoteIdentifierSymbol (line 292)
  • access: public
string getQuoteIdentifierSymbol ()

Redefinition of:
Zend_Db_Adapter_Abstract::getQuoteIdentifierSymbol()
Returns the symbol the adapter uses for delimited identifiers.
getServerVersion (line 718)

Retrieve server version in PHP style

  • access: public
string getServerVersion ()

Redefinition of:
Zend_Db_Adapter_Abstract::getServerVersion()
Retrieve server version in PHP style
isConnected (line 197)

Test if a connection is active

  • access: public
boolean isConnected ()

Redefinition of:
Zend_Db_Adapter_Abstract::isConnected()
Test if a connection is active
isI5 (line 738)

Return whether or not this is running on i5

  • access: public
bool isI5 ()
lastInsertId (line 543)

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.

The IDENTITY_VAL_LOCAL() function gives the last generated identity value in the current process, even if it was for a GENERATED column.

  • access: public
string lastInsertId ([string $tableName = null], [string $primaryKey = null], [string $idType = null])
  • string $tableName: OPTIONAL
  • string $primaryKey: OPTIONAL
  • string $idType: OPTIONAL used for i5 platform to define sequence/idenity unique value

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

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
string 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 655)

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

  • access: public
string limit (string $sql, integer $count, [integer $offset = 0])
  • string $sql
  • integer $count
  • integer $offset: OPTIONAL

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

Returns a list of the tables in the database.

  • access: public
array listTables ([string $schema = null])
  • string $schema: OPTIONAL

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

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
string 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.
prepare (line 222)

Returns an SQL statement for preparation.

  • access: public
Zend_Db_Statement_Db2 prepare (string $sql)
  • string $sql: The SQL statement with placeholders.

Redefinition of:
Zend_Db_Adapter_Abstract::prepare()
Prepare a statement and return a PDOStatement-like object.
setFetchMode (line 621)

Set the fetch mode.

  • throws: Zend_Db_Adapter_Db2_Exception
  • access: public
void setFetchMode (integer $mode)
  • integer $mode

Redefinition of:
Zend_Db_Adapter_Abstract::setFetchMode()
Set the fetch mode.
supportsParameters (line 703)

Check if the adapter supports real SQL parameters.

  • access: public
bool supportsParameters (string $type)
  • string $type: 'positional' or 'named'

Redefinition of:
Zend_Db_Adapter_Abstract::supportsParameters()
Check if the adapter supports real SQL parameters.
_beginTransaction (line 570)

Begin a transaction.

  • access: protected
void _beginTransaction ()

Redefinition of:
Zend_Db_Adapter_Abstract::_beginTransaction()
Begin a transaction.
_commit (line 580)

Commit a transaction.

  • access: protected
void _commit ()

Redefinition of:
Zend_Db_Adapter_Abstract::_commit()
Commit a transaction.
_connect (line 119)

Creates a connection resource.

  • access: protected
void _connect ()

Redefinition of:
Zend_Db_Adapter_Abstract::_connect()
Creates a connection to the database.
_determineI5 (line 753)

Check the connection parameters according to verify type of used OS

  • access: protected
void _determineI5 ()
_getExecuteMode (line 240)

Gets the execution mode

  • return: the execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
  • access: public
int _getExecuteMode ()
_i5LastInsertId (line 809)
  • access: protected
void _i5LastInsertId ([ $objectName = null], [ $idType = null])
  • $objectName
  • $idType
_i5listTables (line 778)

Db2 On I5 specific method

Returns a list of the tables in the database . Used only for DB2/400.

  • access: protected
array _i5listTables ([ $schema = null])
  • $schema
_quote (line 273)

Quote a raw string.

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

Redefinition of:
Zend_Db_Adapter_Abstract::_quote()
Quote a raw string.
_rollBack (line 600)

Rollback a transaction.

  • access: protected
void _rollBack ()

Redefinition of:
Zend_Db_Adapter_Abstract::_rollBack()
Roll-back a transaction.
_setExecuteMode (line 249)
  • access: public
void _setExecuteMode (integer $mode)
  • integer $mode

Inherited Methods

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::foldCase()
 Zend_Db_Adapter_Abstract::getConfig()
 Zend_Db_Adapter_Abstract::getConnection()
 Zend_Db_Adapter_Abstract::getFetchMode()
 Zend_Db_Adapter_Abstract::getProfiler()
 Zend_Db_Adapter_Abstract::getQuoteIdentifierSymbol()
 Zend_Db_Adapter_Abstract::getServerVersion()
 Zend_Db_Adapter_Abstract::getStatementClass()
 Zend_Db_Adapter_Abstract::insert()
 Zend_Db_Adapter_Abstract::isConnected()
 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::setProfiler()
 Zend_Db_Adapter_Abstract::setStatementClass()
 Zend_Db_Adapter_Abstract::supportsParameters()
 Zend_Db_Adapter_Abstract::update()
 Zend_Db_Adapter_Abstract::_beginTransaction()
 Zend_Db_Adapter_Abstract::_checkRequiredOptions()
 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()
 Zend_Db_Adapter_Abstract::_whereExpr()
 Zend_Db_Adapter_Abstract::__sleep()
 Zend_Db_Adapter_Abstract::__wakeup()

Documentation generated on Mon, 21 Jun 2010 15:16:00 -0400 by phpDocumentor 1.4.3