Source for file mssql.php
Documentation is available at mssql.php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
* The PEAR DB driver for PHP's mssql extension
* for interacting with Microsoft SQL Server databases
* LICENSE: This source file is subject to version 3.0 of the PHP license
* that is available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
* the PHP License and are unable to obtain it through the web, please
* send a note to license@php.net so we can mail you a copy immediately.
* @author Sterling Hughes <sterling@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version CVS: $Id: mssql.php,v 1.92 2007/09/21 13:40:41 aharvey Exp $
* @link http://pear.php.net/package/DB
* Obtain the DB_common class so it can be extended from
require_once 'DB/common.php';
* The methods PEAR DB uses to interact with PHP's mssql extension
* for interacting with Microsoft SQL Server databases
* These methods overload the ones declared in DB_common.
* DB's mssql driver is only for Microsfoft SQL Server databases.
* If you're connecting to a Sybase database, you MUST specify "sybase"
* as the "phptype" in the DSN.
* This class only works correctly if you have compiled PHP using
* --with-mssql=[dir_to_FreeTDS].
* @author Sterling Hughes <sterling@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version Release: 1.7.14RC1
* @link http://pear.php.net/package/DB
* The DB driver type (mysql, oci8, odbc, etc.)
* The database syntax variant to be used (db2, access, etc.), if any
* The capabilities of this DB implementation
* The 'new_link' element contains the PHP version that first provided
* new_link support for this DBMS. Contains false if it's unsupported.
* Meaning of the 'limit' element:
* + 'emulate' = emulate with fetch row by number
* + 'alter' = alter the query
* A mapping of native error codes to DB error codes
// XXX Add here error codes ie: 'S100E' => DB_ERROR_SYNTAX
110 => DB_ERROR_VALUE_COUNT_ON_ROW ,
155 => DB_ERROR_NOSUCHFIELD ,
207 => DB_ERROR_NOSUCHFIELD ,
208 => DB_ERROR_NOSUCHTABLE ,
245 => DB_ERROR_INVALID_NUMBER ,
321 => DB_ERROR_NOSUCHFIELD ,
515 => DB_ERROR_CONSTRAINT_NOT_NULL ,
547 => DB_ERROR_CONSTRAINT ,
1913 => DB_ERROR_ALREADY_EXISTS ,
2627 => DB_ERROR_CONSTRAINT ,
2714 => DB_ERROR_ALREADY_EXISTS ,
3607 => DB_ERROR_DIVZERO ,
3701 => DB_ERROR_NOSUCHTABLE ,
8134 => DB_ERROR_DIVZERO ,
15253 => DB_ERROR_SYNTAX ,
* The raw database connection created by PHP
* The DSN information for connecting to a database
* Should data manipulation queries be committed automatically?
* The quantity of transactions begun
* {@internal While this is private, it can't actually be designated
* private in PHP 5 because it is directly accessed in the test suite.}}}
var $transaction_opcount = 0;
* The database specified in the DSN
* It's a fix to allow calls to different databases in the same script.
* This constructor calls <kbd>$this->DB_common()</kbd>
* Connect to the database server, log in and open the database
* Don't call this method directly. Use DB::connect() instead.
* @param array $dsn the data source name
* @param bool $persistent should the connection be persistent?
* @return int DB_OK on success. A DB_Error object on failure.
function connect($dsn, $persistent = false )
if (!PEAR ::loadExtension ('mssql') && !PEAR ::loadExtension ('sybase')
&& !PEAR ::loadExtension ('sybase_ct'))
$dsn['hostspec'] ? $dsn['hostspec'] : 'localhost',
$dsn['username'] ? $dsn['username'] : null ,
$dsn['password'] ? $dsn['password'] : null ,
$params[0 ] .= ((substr(PHP_OS , 0 , 3 ) == 'WIN') ? ',' : ':')
$connect_function = $persistent ? 'mssql_pconnect' : 'mssql_connect';
@mssql_get_last_message ());
if (!@mssql_select_db ($dsn['database'], $this->connection)) {
@mssql_get_last_message ());
$this->_db = $dsn['database'];
* Disconnects from the database server
* @return bool TRUE on success, FALSE on failure
* Sends a query to the database server
* @param string the SQL query string
* @return mixed + a PHP result resrouce for successful SELECT queries
* + the DB_OK constant for other successful queries
* + a DB_Error object on failure
if (!@mssql_select_db ($this->_db, $this->connection)) {
if (!$this->autocommit && $ismanip) {
if ($this->transaction_opcount == 0 ) {
$result = @mssql_query ('BEGIN TRAN', $this->connection);
$this->transaction_opcount++;
$result = @mssql_query ($query, $this->connection);
// Determine which queries that should return data, and which
// should return an error code only.
return $ismanip ? DB_OK : $result;
* Move the internal mssql result pointer to the next available result
* @param a valid fbsql result resource
* @return true if a result is available otherwise return false
return @mssql_next_result ($result);
* Places a row from the result set into the given array
* Formating of the array and the data therein are configurable.
* See DB_result::fetchInto() for more information.
* This method is not meant to be called directly. Use
* DB_result::fetchInto() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result the query result resource
* @param array $arr the referenced array to put the data in
* @param int $fetchmode how the resulting array should be indexed
* @param int $rownum the row number to fetch (0 = first row)
* @return mixed DB_OK on success, NULL when the end of a result set is
* @see DB_result::fetchInto()
function fetchInto($result, &$arr, $fetchmode, $rownum = null )
if (!@mssql_data_seek ($result, $rownum)) {
$arr = @mssql_fetch_assoc ($result);
$arr = @mssql_fetch_row ($result);
* Deletes the result set and frees the memory occupied by the result set
* This method is not meant to be called directly. Use
* DB_result::free() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return bool TRUE on success, FALSE if $result is invalid
return is_resource($result) ? mssql_free_result ($result) : false;
* Gets the number of columns in a result set
* This method is not meant to be called directly. Use
* DB_result::numCols() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of columns. A DB_Error object on failure.
* @see DB_result::numCols()
$cols = @mssql_num_fields ($result);
* Gets the number of rows in a result set
* This method is not meant to be called directly. Use
* DB_result::numRows() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of rows. A DB_Error object on failure.
* @see DB_result::numRows()
$rows = @mssql_num_rows ($result);
* Enables or disables automatic commits
* @param bool $onoff true turns it on, false turns it off
* @return int DB_OK on success. A DB_Error object if the driver
* doesn't support auto-committing transactions.
// XXX if $this->transaction_opcount > 0, we should probably
$this->autocommit = $onoff ? true : false;
* Commits the current transaction
* @return int DB_OK on success. A DB_Error object on failure.
if ($this->transaction_opcount > 0 ) {
if (!@mssql_select_db ($this->_db, $this->connection)) {
$result = @mssql_query ('COMMIT TRAN', $this->connection);
$this->transaction_opcount = 0;
* Reverts the current transaction
* @return int DB_OK on success. A DB_Error object on failure.
if ($this->transaction_opcount > 0 ) {
if (!@mssql_select_db ($this->_db, $this->connection)) {
$result = @mssql_query ('ROLLBACK TRAN', $this->connection);
$this->transaction_opcount = 0;
* Determines the number of rows affected by a data maniuplation query
* 0 is returned for queries that don't manipulate data.
* @return int the number of rows. A DB_Error object on failure.
$res = @mssql_query ('select @@rowcount', $this->connection);
$ar = @mssql_fetch_row ($res);
@mssql_free_result ($res);
* Returns the next free id in a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true, the seqence is automatically
* created if it does not exist
* @return int the next id number in the sequence.
* A DB_Error object on failure.
* @see DB_common::nextID(), DB_common::getSequenceName(),
* DB_mssql::createSequence(), DB_mssql::dropSequence()
function nextId($seq_name, $ondemand = true )
if (!@mssql_select_db ($this->_db, $this->connection)) {
$this->pushErrorHandling (PEAR_ERROR_RETURN );
$result = $this->query(" INSERT INTO $seqname (vapor) VALUES (0)" );
$this->popErrorHandling ();
$result = $this->query(" SELECT IDENT_CURRENT('$seqname')" );
/* Fallback code for MS SQL Server 7.0, which doesn't have
* IDENT_CURRENT. This is *not* safe for concurrent
* requests, and really, if you're using it, you're in a
* world of hurt. Nevertheless, it's here to ensure BC. See
* bug #181 for the gory details.*/
$result = $this->query(" SELECT @@IDENTITY FROM $seqname" );
* @param string $seq_name name of the new sequence
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::createSequence(), DB_common::getSequenceName(),
* DB_mssql::nextID(), DB_mssql::dropSequence()
return $this->query('CREATE TABLE '
. ' ([id] [int] IDENTITY (1, 1) NOT NULL,'
. ' [vapor] [int] NULL)');
* @param string $seq_name name of the sequence to be deleted
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::dropSequence(), DB_common::getSequenceName(),
* DB_mssql::nextID(), DB_mssql::createSequence()
* Quotes a string so it can be safely used as a table or column name
* @param string $str identifier name to be quoted
* @return string quoted identifier string
* @see DB_common::quoteIdentifier()
* @since Method available since Release 1.6.0
* Produces a DB_Error object regarding the current problem
* @param int $errno if the error is being manually raised pass a
* DB_ERROR* constant here. If this isn't passed
* the error information gathered from the DBMS.
* @return object the DB_Error object
* @see DB_common::raiseError(),
* DB_mssql::errorNative(), DB_mssql::errorCode()
$message = @mssql_get_last_message ();
|