Db/Adapter/Db2.php
Show:
inherited
inherited
Classes
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
Returns
Returns
Returns
Returns
Returns
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
array $_config = array('dbname' => null, 'username' => null, 'password' => null, 'host' => 'localhost', 'port' => '50000', 'protocol' => 'TCPIP', 'persistent' => false, 'os' => null, 'schema' => 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' => null, 'username' => null, 'password' => null, 'host' => 'localhost', 'port' => '50000', 'protocol' => 'TCPIP', 'persistent' => false, 'os' => null, 'schema' => null)Details- Type
- array
string $_defaultStmtClass = 'Zend_Db_Statement_Db2'Default class name for a DB statement.
Default value
'Zend_Db_Statement_Db2'Details- Type
- string
int $_execute_mode = DB2_AUTOCOMMIT_ONExecution mode
Default value
DB2_AUTOCOMMIT_ONDetails- Type
- int
$_isI5 = falseDefault value
falseDetails- Type
- n/a
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)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
Default valuearray(\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)Details- Type
- array
Methods
_beginTransaction() : voidBegin a transaction.
_commit() : voidCommit a transaction.
_connect() : voidCreates a connection resource.
_determineI5() : voidCheck the connection parameters according to verify type of used OS
@return void
_getExecuteMode() : intGets the execution mode
Returns
| Type | Description |
|---|---|
| int | the execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF) |
_i5LastInsertId( $objectName = null, $idType = null) : voidParameters
| Name | Type | Description |
|---|---|---|
| $objectName | ||
| $idType |
_i5listTables( $schema = null) : arrayDb2 On I5 specific method
Returns a list of the tables in the database .
Used only for DB2/400.
Parameters| Name | Type | Description |
|---|---|---|
| $schema |
| Type | Description |
|---|---|
| array |
_quote(string $value) : stringQuote a raw string.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string | Raw string |
| Type | Description |
|---|---|
| string | Quoted string |
_rollBack() : voidRollback a transaction.
_setExecuteMode(integer $mode) : voidParameters
| Name | Type | Description |
|---|---|---|
| $mode | integer |
closeConnection() : voidForce the connection to close.
describeTable(string $tableName, string $schemaName = null) : arrayReturns 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 |
| Type | Description |
|---|---|
| array |
getQuoteIdentifierSymbol() : stringReturns
| Type | Description |
|---|---|
| string |
getServerVersion() : stringRetrieve server version in PHP style
Returns
| Type | Description |
|---|---|
| string |
isConnected() : booleanTest if a connection is active
Returns
| Type | Description |
|---|---|
| boolean |
isI5() : boolReturn whether or not this is running on i5
Returns
| Type | Description |
|---|---|
| bool |
lastInsertId(string $tableName = null, string $primaryKey = null, string $idType = null) : stringGets 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 |
| Type | Description |
|---|---|
| string |
lastSequenceId(string $sequenceName) : stringReturn 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 |
| Type | Description |
|---|---|
| string |
limit(string $sql, integer $count, integer $offset = 0) : stringAdds an adapter-specific LIMIT clause to the SELECT statement.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $sql | string | |
| $count | integer | |
| $offset | integer | OPTIONAL |
| Type | Description |
|---|---|
| string |
listTables(string $schema = null) : arrayReturns a list of the tables in the database.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $schema | string | OPTIONAL |
| Type | Description |
|---|---|
| array |
nextSequenceId(string $sequenceName) : stringGenerate 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 |
| Type | Description |
|---|---|
| string |
prepare(string $sql) : \Zend_Db_Statement_Db2Returns an SQL statement for preparation.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $sql | string | The SQL statement with placeholders. |
| Type | Description |
|---|---|
| \Zend_Db_Statement_Db2 |
setFetchMode(integer $mode) : voidSet the fetch mode.
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $mode | integer |
| Exception | Description |
|---|---|
| \Zend_Db_Adapter_Db2_Exception |
supportsParameters(string $type) : boolCheck if the adapter supports real SQL parameters.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $type | string | 'positional' or 'named' |
| Type | Description |
|---|---|
| bool |