Db/Adapter/Db2.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Adapter  
Version
$Id$  

\Zend_Db_Adapter_Db2

Package: Zend_Db\Adapter
Class for connecting to SQL databases and performing common operations.
Parent(s)
\Zend_Db_Adapter_Abstract
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Methods

methodpublic_getExecuteMode() : int

Gets the execution mode

Returns
TypeDescription
intthe execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)
methodpublic_setExecuteMode(integer $mode) : void

Parameters
NameTypeDescription
$modeinteger
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
NameTypeDescription
$tableNamestring
$schemaNamestring

OPTIONAL

Returns
TypeDescription
array
methodpublicgetQuoteIdentifierSymbol() : string

Returns
TypeDescription
string
methodpublicgetServerVersion() : string

Retrieve server version in PHP style

Returns
TypeDescription
string
methodpublicisConnected() : boolean

Test if a connection is active

Returns
TypeDescription
boolean
methodpublicisI5() : bool

Return whether or not this is running on i5

Returns
TypeDescription
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
NameTypeDescription
$tableNamestring

OPTIONAL

$primaryKeystring

OPTIONAL

$idTypestring

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

Returns
TypeDescription
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
NameTypeDescription
$sequenceNamestring
Returns
TypeDescription
string
methodpubliclimit(string $sql, integer $count, integer $offset = 0) : string

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

Parameters
NameTypeDescription
$sqlstring
$countinteger
$offsetinteger

OPTIONAL

Returns
TypeDescription
string
methodpubliclistTables(string $schema = null) : array

Returns a list of the tables in the database.

Parameters
NameTypeDescription
$schemastring

OPTIONAL

Returns
TypeDescription
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
NameTypeDescription
$sequenceNamestring
Returns
TypeDescription
string
methodpublicprepare(string $sql) : \Zend_Db_Statement_Db2

Returns an SQL statement for preparation.

Parameters
NameTypeDescription
$sqlstring

The SQL statement with placeholders.

Returns
TypeDescription
\Zend_Db_Statement_Db2
methodpublicsetFetchMode(integer $mode) : void

Set the fetch mode.

Parameters
NameTypeDescription
$modeinteger
Throws
ExceptionDescription
\Zend_Db_Adapter_Db2_Exception
methodpublicsupportsParameters(string $type) : bool

Check if the adapter supports real SQL parameters.

Parameters
NameTypeDescription
$typestring

'positional' or 'named'

Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.2.0 .