API Documentation

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

\Zend_Db_Adapter_Db2

Package: Zend\Db

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

Properties

Propertyprotectedarray  $_config= 'array( 'dbname' => null'

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

Default valuearray( 'dbname' => nullDetails
Type
array
Propertyprotectedstring  $_defaultStmtClass= ''Zend_Db_Statement_Db2''

Default class name for a DB statement.

Default value'Zend_Db_Statement_Db2'Details
Type
string
Propertyprotectedint  $_execute_mode= 'DB2_AUTOCOMMIT_ON'

Execution mode

execution flag (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
Default valueDB2_AUTOCOMMIT_ONDetails
Type
int
Propertyprotected  $_isI5= 'false'
Default valuefalseDetails
Type
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

Methods

methodprotected_beginTransaction( ) : void

Begin a transaction.

methodprotected_commit( ) : void

Commit a transaction.

methodprotected_connect( ) : void

Creates a connection resource.

methodprotected_determineI5( ) : void

Check the connection parameters according to verify type of used OS

@return void

methodpublic_getExecuteMode( ) : int

Gets the execution mode

Returns
Type Description
int the execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
methodprotected_i5LastInsertId(  $objectName = null,  $idType = null ) : void

Parameters
Name Type Description
$objectName
$idType
methodprotected_i5listTables(  $schema = null ) : array

Db2 On I5 specific method

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

Parameters
Name Type Description
$schema
Returns
Type Description
array
methodprotected_quote( string $value ) : string

Quote a raw string.

Parameters
Name Type Description
$value string

Raw string

Returns
Type Description
string Quoted string
methodprotected_rollBack( ) : void

Rollback a transaction.

methodpublic_setExecuteMode( integer $mode ) : void

Parameters
Name Type Description
$mode integer
methodpubliccloseConnection( ) : void

Force the connection to close.

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

Parameters
Name Type Description
$tableName string
$schemaName string

OPTIONAL

Returns
Type Description
array
methodpublicgetQuoteIdentifierSymbol( ) : string

Returns
Type Description
string
methodpublicgetServerVersion( ) : string

Retrieve server version in PHP style

Returns
Type Description
string
methodpublicisConnected( ) : boolean

Test if a connection is active

Returns
Type Description
boolean
methodpublicisI5( ) : bool

Return whether or not this is running on i5

Returns
Type Description
bool
methodpubliclastInsertId( 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.

Parameters
Name Type Description
$tableName string

OPTIONAL

$primaryKey string

OPTIONAL

$idType string

OPTIONAL used for i5 platform to define sequence/idenity unique value

Returns
Type Description
string
methodpubliclastSequenceId( 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.

Parameters
Name Type Description
$sequenceName string
Returns
Type Description
string
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

OPTIONAL

Returns
Type Description
string
methodpubliclistTables( string $schema = null ) : array

Returns a list of the tables in the database.

Parameters
Name Type Description
$schema string

OPTIONAL

Returns
Type Description
array
methodpublicnextSequenceId( 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.

Parameters
Name Type Description
$sequenceName string
Returns
Type Description
string
methodpublicprepare( string $sql ) : \Zend_Db_Statement_Db2

Returns an SQL statement for preparation.

Parameters
Name Type Description
$sql string

The SQL statement with placeholders.

Returns
Type Description
\Zend_Db_Statement_Db2
methodpublicsetFetchMode( integer $mode ) : void

Set the fetch mode.

Parameters
Name Type Description
$mode integer
Throws
Exception Description
\Zend_Db_Adapter_Db2_Exception
methodpublicsupportsParameters( string $type ) : bool

Check if the adapter supports real SQL parameters.

Parameters
Name Type Description
$type string

'positional' or 'named'

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.