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

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

Extends from: Zend_Db_Adapter_Abstract
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
Properties: $_config; $_execute_mode; $_defaultStmtClass; $_isI5; $_numericDataTypes
Methods: _connect; isConnected; closeConnection; prepare; _getExecuteMode; _setExecuteMode; _quote; getQuoteIdentifierSymbol; listTables; describeTable; lastSequenceId; nextSequenceId; lastInsertId; _beginTransaction; _commit; _rollBack; setFetchMode; limit; supportsParameters; getServerVersion; isI5; _determineI5; _i5listTables; _i5LastInsertId

Description

Properties

$_config
jump to class

array $_config = 'array'

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

Details

$_config: array
visibility: protected
default: array
final: false
static: false

$_defaultStmtClass
jump to class

string $_defaultStmtClass = 'Zend_Db_Statement_Db2'

Default class name for a DB statement.

Details

$_defaultStmtClass: string
visibility: protected
default: Zend_Db_Statement_Db2
final: false
static: false

$_execute_mode
jump to class

int $_execute_mode = 'DB2_AUTOCOMMIT_ON'

Execution mode

Details

$_execute_mode: int
execution flag (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
visibility: protected
default: DB2_AUTOCOMMIT_ON
final: false
static: false

$_isI5
jump to class

$_isI5 = 'false'

Details

visibility: protected
default: false
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

Methods

_beginTransaction
jump to class

_beginTransaction(
          
          )
        
        :
        void

Begin a transaction.

Details

visibility: protected
final: false
static: false

_commit
jump to class

_commit(
          
          )
        
        :
        void

Commit a transaction.

Details

visibility: protected
final: false
static: false

_connect
jump to class

_connect(
          
          )
        
        :
        void

Creates a connection resource.

Details

visibility: protected
final: false
static: false

_determineI5
jump to class

_determineI5(
          
          )
        
        :

Check the connection parameters according to verify type of used OS

@return void

Details

visibility: protected
final: false
static: false

_getExecuteMode
jump to class

_getExecuteMode(
          
          )
        
        :
        int

Gets the execution mode

Output

int: the execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)

Details

visibility: public
final: false
static: false

_i5LastInsertId
jump to class

_i5LastInsertId(
           $objectName
              =
              null,  $idType
              =
              null
          )
        
        :

Arguments

$objectName
$idType

Details

visibility: protected
final: false
static: false

_i5listTables
jump to class

_i5listTables(
           $schema
              =
              null
          )
        
        :
        array

Db2 On I5 specific method

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

Arguments

$schema

Output

array

Details

visibility: protected
final: false
static: false

_quote
jump to class

_quote(
          string $value
          )
        
        :
        string

Quote a raw string.

Arguments

$value: string
Raw string

Output

string: Quoted string

Details

visibility: protected
final: false
static: false

_rollBack
jump to class

_rollBack(
          
          )
        
        :
        void

Rollback a transaction.

Details

visibility: protected
final: false
static: false

_setExecuteMode
jump to class

_setExecuteMode(
          integer $mode
          )
        
        :
        void

Arguments

$mode: integer

Details

visibility: public
final: false
static: false

closeConnection
jump to class

closeConnection(
          
          )
        
        :
        void

Force the connection to close.

Details

visibility: public
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 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

Arguments

$tableName: string
$schemaName: string
OPTIONAL

Output

array

Details

visibility: public
final: false
static: false

getQuoteIdentifierSymbol
jump to class

getQuoteIdentifierSymbol(
          
          )
        
        :
        string

Output

string

Details

visibility: public
final: false
static: false

getServerVersion
jump to class

getServerVersion(
          
          )
        
        :
        string

Retrieve server version in PHP style

Output

string

Details

visibility: public
final: false
static: false

isConnected
jump to class

isConnected(
          
          )
        
        :
        boolean

Test if a connection is active

Output

boolean

Details

visibility: public
final: false
static: false

isI5
jump to class

Return whether or not this is running on i5

Output

bool

Details

visibility: public
final: false
static: false

lastInsertId
jump to class

lastInsertId(
          string $tableName
              =
              null, string $primaryKey
              =
              null, string $idType
              =
              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.

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

Arguments

$tableName: string
OPTIONAL
$primaryKey: string
OPTIONAL
$idType: string
OPTIONAL used for i5 platform to define sequence/idenity unique value

Output

string

Details

visibility: public
final: false
static: false

lastSequenceId
jump to class

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.

Arguments

$sequenceName: string

Output

string

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
OPTIONAL

Output

string

Details

visibility: public
final: false
static: false

listTables
jump to class

listTables(
          string $schema
              =
              null
          )
        
        :
        array

Returns a list of the tables in the database.

Arguments

$schema: string
OPTIONAL

Output

array

Details

visibility: public
final: false
static: false

nextSequenceId
jump to class

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.

Arguments

$sequenceName: string

Output

string

Details

visibility: public
final: false
static: false

prepare
jump to class

prepare(
          string $sql
          )
        
        :
        Zend_Db_Statement_Db2

Returns an SQL statement for preparation.

Arguments

$sql: string
The SQL statement with placeholders.

Output

Zend_Db_Statement_Db2

Details

visibility: public
final: false
static: false

setFetchMode
jump to class

setFetchMode(
          integer $mode
          )
        
        :
        void

Set the fetch mode.

Arguments

$mode: integer

Details

visibility: public
final: false
static: false
throws

supportsParameters
jump to class

supportsParameters(
          string $type
          )
        
        :
        bool

Check if the adapter supports real SQL parameters.

Arguments

$type: string
'positional' or 'named'

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Db/Adapter/Db2.php

Description

Zend_Db_Adapter_Db2jump to top

Description

Properties

$_configjump to class

Details

$_defaultStmtClassjump to class

Details

$_execute_modejump to class

Details

$_isI5jump to class

Details

$_numericDataTypesjump to class

Details

Methods

_beginTransactionjump to class

Details

_commitjump to class

Details

_connectjump to class

Details

_determineI5jump to class

Details

_getExecuteModejump to class

Output

Details

_i5LastInsertIdjump to class

Arguments

Details

_i5listTablesjump to class

Arguments

Output

Details

_quotejump to class

Arguments

Output

Details

_rollBackjump to class

Details

_setExecuteModejump to class

Arguments

Details

closeConnectionjump to class

Details

describeTablejump to class

Arguments

Output

Details

getQuoteIdentifierSymboljump to class

Output

Details

getServerVersionjump to class

Output

Details

isConnectedjump to class

Output

Details

isI5jump to class

Output

Details

lastInsertIdjump to class

Arguments

Output

Details

lastSequenceIdjump to class

Arguments

Output

Details

limitjump to class

Arguments

Output

Details

listTablesjump to class

Arguments

Output

Details

nextSequenceIdjump to class

Arguments

Zend_Db_Adapter_Db2
jump to top

$_config
jump to class

$_defaultStmtClass
jump to class

$_execute_mode
jump to class

$_isI5
jump to class

$_numericDataTypes
jump to class

_beginTransaction
jump to class

_commit
jump to class

_connect
jump to class

_determineI5
jump to class

_getExecuteMode
jump to class

_i5LastInsertId
jump to class

_i5listTables
jump to class

_quote
jump to class

_rollBack
jump to class

_setExecuteMode
jump to class

closeConnection
jump to class

describeTable
jump to class

getQuoteIdentifierSymbol
jump to class

getServerVersion
jump to class

isConnected
jump to class

isI5
jump to class

lastInsertId
jump to class

lastSequenceId
jump to class

limit
jump to class

listTables
jump to class

nextSequenceId
jump to class

prepare
jump to class

setFetchMode
jump to class

supportsParameters
jump to class