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

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

Extends from: Zend_Db_Adapter_Pdo_Abstract
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
Properties: $_pdoType; $_numericDataTypes
Methods: _dsn; _connect; _beginTransaction; _commit; _rollBack; listTables; describeTable; limit; lastInsertId; getServerVersion

Description

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

Properties

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

$_pdoType
jump to class

string $_pdoType = 'mssql'

PDO type.

Details

$_pdoType: string
visibility: protected
default: mssql
final: false
static: false

Methods

_beginTransaction
jump to class

_beginTransaction(
          
          )
        
        :

Begin a transaction.

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

Details

visibility: protected
final: false
static: false

_commit
jump to class

Commit a transaction.

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

Details

visibility: protected
final: false
static: false

_connect
jump to class

_connect(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: false

_dsn
jump to class

_dsn(
          
          )
        
        :
        string

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

Output

string

Details

visibility: protected
final: false
static: false

_rollBack
jump to class

_rollBack(
          
          )
        
        :

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.

Details

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

Arguments

$tableName: string
$schemaName: string
OPTIONAL

Output

array

Details

visibility: public
final: false
static: false
todo: Discover column primary key position.
todo: Discover integer unsigned property.

getServerVersion
jump to class

getServerVersion(
          
          )
        
        :
        string

Retrieve server version in PHP style Pdo_Mssql doesn't support getAttribute(PDO::ATTR_SERVER_VERSION)

Output

string

Details

visibility: public
final: false
static: false

lastInsertId
jump to class

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

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

Arguments

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

Output

string

Details

visibility: public
final: false
static: false
throws

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

listTables
jump to class

listTables(
          
          )
        
        :
        array

Returns a list of the tables in the database.

Output

array

Details

visibility: public
final: false
static: false

API Documentation

Db/Adapter/Pdo/Mssql.php

Description

Zend_Db_Adapter_Pdo_Mssqljump to top

Description

Properties

$_numericDataTypesjump to class

Details

$_pdoTypejump to class

Details

Methods

_beginTransactionjump to class

Details

_commitjump to class

Details

_connectjump to class

Details

_dsnjump to class

Output

Details

_rollBackjump to class

Details

describeTablejump to class

Arguments

Output

Details

getServerVersionjump to class

Output

Details

lastInsertIdjump to class

Arguments

Output

Details

limitjump to class

Arguments

Output

Details

listTablesjump to class

Output

Details

Zend_Db_Adapter_Pdo_Mssql
jump to top

$_numericDataTypes
jump to class

$_pdoType
jump to class

_beginTransaction
jump to class

_commit
jump to class

_connect
jump to class

_dsn
jump to class

_rollBack
jump to class

describeTable
jump to class

getServerVersion
jump to class

lastInsertId
jump to class

limit
jump to class

listTables
jump to class