Docs For Class Zend_Db_Adapter_Pdo

Description

Class for connecting to Microsoft SQL Server databases and performing common operations.

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

Located in /Db/Adapter/Pdo/Mssql.php (line 39)

Zend_Db_Adapter_Abstract
   |
   --Zend_Db_Adapter_Pdo_Abstract
      |
      --Zend_Db_Adapter_Pdo_Mssql

Variable Summary

array $_numericDataTypes

string $_pdoType

Method Summary

array describeTable (string $tableName, [string $schemaName = null])

string getServerVersion ()

string lastInsertId ([string $tableName = null], [string $primaryKey = null])

string limit (string $sql, integer $count, [integer $offset = 0])

array listTables ()

void _beginTransaction ()

void _commit ()

void _connect ()

string _dsn ()

void _rollBack ()

Variables

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,
'INT' => Zend_Db::INT_TYPE,
'SMALLINT' => Zend_Db::INT_TYPE,
'TINYINT' => Zend_Db::INT_TYPE,
'BIGINT' => Zend_Db::BIGINT_TYPE,
'DECIMAL' => Zend_Db::FLOAT_TYPE,
'FLOAT' => Zend_Db::FLOAT_TYPE,
'MONEY' => Zend_Db::FLOAT_TYPE,
'NUMERIC' => Zend_Db::FLOAT_TYPE,
'REAL' => Zend_Db::FLOAT_TYPE,
'SMALLMONEY' => Zend_Db::FLOAT_TYPE
) (line 59)

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

Values are:

= 32-bit integer
= 64-bit integer
= 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.

string $_pdoType = 'mssql' (line 46)

PDO type.

access: protected

Inherited Variables

Inherited from Zend_Db_Adapter_Pdo_Abstract

Zend_Db_Adapter_Pdo_Abstract::$_defaultStmtClass

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::$_config
Zend_Db_Adapter_Abstract::$_connection
Zend_Db_Adapter_Abstract::$_defaultProfilerClass
Zend_Db_Adapter_Abstract::$_fetchMode
Zend_Db_Adapter_Abstract::$_profiler

Methods

describeTable (line 221)

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 PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key PRIMARY_AUTO => integer; position of auto-generated column in primary key

todo: Discover integer unsigned property.
todo: Discover column primary key position.
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.

getServerVersion (line 410)

Retrieve server version in PHP style

Pdo_Mssql doesn't support getAttribute(PDO::ATTR_SERVER_VERSION)

access: public

string getServerVersion ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::getServerVersion(): Retrieve server version in PHP style

lastInsertId (line 399)

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.

Microsoft SQL Server does not support sequences, so the arguments to this method are ignored.

throws: Zend_Db_Adapter_Exception
access: public

string lastInsertId ([string $tableName = null], [string $primaryKey = null])

string $tableName: OPTIONAL Name of table.
string $primaryKey: OPTIONAL Name of primary key column.

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::lastInsertId(): Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

limit (line 317)

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

link: http://lists.bestpractical.com/pipermail/rt-devel/2005-June/007339.html
throws: Zend_Db_Adapter_Exception
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 184)

Returns a list of the tables in the database.

access: public

array listTables ()

Redefinition of:

Zend_Db_Adapter_Abstract::listTables(): Returns a list of the tables in the database.

_beginTransaction (line 147)

Begin a transaction.

It is necessary to override the abstract PDO transaction functions here, as the PDO driver for MSSQL does not support transactions.

access: protected

void _beginTransaction ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::_beginTransaction(): Begin a transaction.

_commit (line 160)

Commit a transaction.

It is necessary to override the abstract PDO transaction functions here, as the PDO driver for MSSQL does not support transactions.

access: protected

void _commit ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::_commit(): Commit a transaction.

_connect (line 132)

access: protected

void _connect ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::_connect(): Creates a PDO object and connects to the database.

_dsn (line 80)

Creates a PDO DSN for the adapter from $this->_config settings.

access: protected

string _dsn ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::_dsn(): Creates a PDO DSN for the adapter from $this->_config settings.

_rollBack (line 173)

Roll-back a transaction.

It is necessary to override the abstract PDO transaction functions here, as the PDO driver for MSSQL does not support transactions.

access: protected

void _rollBack ()

Redefinition of:

Zend_Db_Adapter_Pdo_Abstract::_rollBack(): Roll-back a transaction.

Inherited Methods

Inherited From Zend_Db_Adapter_Pdo_Abstract

Zend_Db_Adapter_Pdo_Abstract::closeConnection()
Zend_Db_Adapter_Pdo_Abstract::exec()
Zend_Db_Adapter_Pdo_Abstract::getServerVersion()
Zend_Db_Adapter_Pdo_Abstract::isConnected()
Zend_Db_Adapter_Pdo_Abstract::lastInsertId()
Zend_Db_Adapter_Pdo_Abstract::prepare()
Zend_Db_Adapter_Pdo_Abstract::query()
Zend_Db_Adapter_Pdo_Abstract::setFetchMode()
Zend_Db_Adapter_Pdo_Abstract::supportsParameters()
Zend_Db_Adapter_Pdo_Abstract::_beginTransaction()
Zend_Db_Adapter_Pdo_Abstract::_commit()
Zend_Db_Adapter_Pdo_Abstract::_connect()
Zend_Db_Adapter_Pdo_Abstract::_dsn()
Zend_Db_Adapter_Pdo_Abstract::_quote()
Zend_Db_Adapter_Pdo_Abstract::_rollBack()

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