Class DB_mssql

Description

Database independent query interface definition for PHP's Microsoft SQL Server extension.

  • author: Sterling Hughes <sterling@php.net>
  • version: $Id: mssql.php,v 1.55 2004/08/20 17:10:53 danielc Exp $

Located in /maintenance/libraries/pear/DB/mssql.php (line 33)

PEAR
   |
   --DB_common
      |
      --DB_mssql
Variable Summary
Method Summary
 DB_mssql DB_mssql ()
 number affectedRows ()
 void autoCommit ([mixed $onoff = false])
 void commit ()
 void connect (mixed $dsninfo, [mixed $persistent = false])
 int createSequence (string $seq_name)
 void disconnect ()
 int dropSequence (string $seq_name)
 integer errorCode ([mixed $nativecode = null])
 mixed errorNative ()
 mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
 void freeResult (mixed $result)
 string getSpecialQuery (string $type)
 object DB mssqlRaiseError ([integer $code = null])
 int nextId (string $seq_name, [boolean $ondemand = true])
 true nextResult (a $result)
 void numCols (mixed $result)
 void numRows (mixed $result)
 string quoteIdentifier (string $str)
 void rollback ()
 void simpleQuery (mixed $query)
 array tableInfo (object|string $result, [int $mode = null])
 void _add_flag (reference &$array, value $value)
 void _mssql_field_flags (string $table, string $column)
Variables
mixed $autocommit = true (line 42)
mixed $connection (line 37)
mixed $dbsyntax (line 38)
mixed $phptype (line 38)

Redefinition of:
DB_common::$phptype
DB type (mysql, oci8, odbc etc.)
mixed $prepare_tokens = array() (line 39)

Redefinition of:
DB_common::$prepare_tokens
mixed $prepare_types = array() (line 40)

Redefinition of:
DB_common::$prepare_types
mixed $transaction_opcount = 0 (line 41)
mixed $_db = null (line 43)

Inherited Variables

Inherited from DB_common

DB_common::$dbh
DB_common::$errorcode_map
DB_common::$features
DB_common::$fetchmode
DB_common::$fetchmode_object_class
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_maxstmt
Methods
Constructor DB_mssql (line 48)
DB_mssql DB_mssql ()
affectedRows (line 320)

Gets the number of rows affected by the last query.

if the last query was a select, returns 0.

  • return: of rows affected by the last query or DB_ERROR
number affectedRows ()

Redefinition of:
DB_common::affectedRows()
Returns the affected rows of a query
autoCommit (line 261)

Enable/disable automatic commits

void autoCommit ([mixed $onoff = false])

Redefinition of:
DB_common::autoCommit()
enable automatic Commit
commit (line 275)

Commit the current transaction.

void commit ()

Redefinition of:
DB_common::commit()
starts a Commit
connect (line 77)
void connect (mixed $dsninfo, [mixed $persistent = false])
createSequence (line 401)

Creates a new sequence

int createSequence (string $seq_name)
  • string $seq_name: name of the new sequence

Redefinition of:
DB_common::createSequence()
Creates a new sequence
disconnect (line 116)
void disconnect ()
dropSequence (line 423)

Deletes a sequence

int dropSequence (string $seq_name)
  • string $seq_name: name of the sequence to be deleted

Redefinition of:
DB_common::dropSequence()
Deletes a sequence
errorCode (line 459)

Determine PEAR::DB error code from mssql's native codes.

If $nativecode isn't known yet, it will be looked up.

integer errorCode ([mixed $nativecode = null])
  • mixed $nativecode: mssql error code, if known

Redefinition of:
DB_common::errorCode()
Map native error codes to DB's portable ones
errorNative (line 437)

Determine MS SQL Server error code by querying @@ERROR.

  • return: mssql's native error code or DB_ERROR if unknown.
mixed errorNative ()

Redefinition of:
DB_common::errorNative()
Returns an errormessage, provides by the database
fetchInto (line 190)

Fetch a row and insert the data into an existing array.

Formating of the array and the data therein are configurable. See DB_result::fetchInto() for more information.

  • return: DB_OK on success, null when end of result set is reached or on failure
  • access: private
  • see: DB_result::fetchInto()
mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
  • resource $result: query result identifier
  • array $arr: (reference) array where data from the row should be placed
  • int $fetchmode: how the resulting array should be indexed
  • int $rownum: the row number to fetch
freeResult (line 226)
void freeResult (mixed $result)
getSpecialQuery (line 601)

Returns the query needed to get some backend info

  • return: The SQL query string
string getSpecialQuery (string $type)
  • string $type: What kind of info you want to retrieve

Redefinition of:
DB_common::getSpecialQuery()
Returns the query needed to get some backend info
mssqlRaiseError (line 485)

Gather information about an error, then use that info to create a DB error object and finally return that object.

object DB mssqlRaiseError ([integer $code = null])
  • integer $code: PEAR error number (usually a DB constant) if manually raising an error
nextId (line 356)

Returns the next free id in a sequence

  • return: the next id number in the sequence. DB_Error if problem.
  • access: public
  • see: DB_common::nextID()
  • internal:
int nextId (string $seq_name, [boolean $ondemand = true])
  • string $seq_name: name of the sequence
  • boolean $ondemand: when true, the seqence is automatically created if it does not exist

Redefinition of:
DB_common::nextId()
Returns the next free id in a sequence
nextResult (line 164)

Move the internal mssql result pointer to the next available result

  • return: if a result is available otherwise return false
  • access: public
true nextResult (a $result)
  • a $result: valid fbsql result resource
numCols (line 234)
void numCols (mixed $result)
numRows (line 246)
void numRows (mixed $result)

Redefinition of:
DB_common::numRows()
Returns the number of rows in a result object
quoteIdentifier (line 723)

Quote a string so it can be safely used as a table / column name

Quoting style depends on which database driver is being used.

  • return: quoted identifier string
  • access: public
  • since: 1.6.0
string quoteIdentifier (string $str)
  • string $str: identifier name to be quoted

Redefinition of:
DB_common::quoteIdentifier()
Quote a string so it can be safely used as a table or column name
rollback (line 296)

Roll back (undo) the current transaction.

void rollback ()

Redefinition of:
DB_common::rollback()
starts a rollback
simpleQuery (line 126)
void simpleQuery (mixed $query)
tableInfo (line 513)

Returns information about a table or a result set.

NOTE: only supports 'table' and 'flags' if $result is a table name.

  • return: an associative array with the information requested or an error object if something is wrong
  • see: DB_common::tableInfo()
  • internal:
  • access: public
array tableInfo (object|string $result, [int $mode = null])
  • object|string $result: DB_result object from a query or a string containing the name of a table
  • int $mode: a valid tableInfo mode

Redefinition of:
DB_common::tableInfo()
Returns information about a table or a result set
_add_flag (line 699)

Adds a string to the flags array if the flag is not yet in there

  • if there is no flag present the array is created.

void _add_flag (reference &$array, value $value)
  • reference &$array: Reference to the flag-array
  • value $value: The flag value
_mssql_field_flags (line 631)

Get the flags for a field, currently supports "not_null", "primary_key",

"auto_increment" (mssql identity), "timestamp" (mssql timestamp), "unique_key" (mssql unique index, unique check or primary_key) and "multiple_key" (multikey index)

mssql timestamp is NOT similar to the mysql timestamp so this is maybe not useful at all - is the behaviour of mysql_field_flags that primary keys are alway unique? is the interpretation of multiple_key correct?

void _mssql_field_flags (string $table, string $column)
  • string $table: The table name
  • string $column: The field

Inherited Methods

Inherited From DB_common

 DB_common::DB_common()
 DB_common::affectedRows()
 DB_common::autoCommit()
 DB_common::autoExecute()
 DB_common::autoPrepare()
 DB_common::buildManipSQL()
 DB_common::commit()
 DB_common::createSequence()
 DB_common::dropSequence()
 DB_common::errorCode()
 DB_common::errorMessage()
 DB_common::errorNative()
 DB_common::escapeSimple()
 DB_common::execute()
 DB_common::executeEmulateQuery()
 DB_common::executeMultiple()
 DB_common::freePrepared()
 DB_common::getAll()
 DB_common::getAssoc()
 DB_common::getCol()
 DB_common::getListOf()
 DB_common::getOne()
 DB_common::getOption()
 DB_common::getRow()
 DB_common::getSequenceName()
 DB_common::getSpecialQuery()
 DB_common::getTables()
 DB_common::limitQuery()
 DB_common::modifyLimitQuery()
 DB_common::modifyQuery()
 DB_common::nextId()
 DB_common::numRows()
 DB_common::prepare()
 DB_common::provides()
 DB_common::query()
 DB_common::quote()
 DB_common::quoteIdentifier()
 DB_common::quoteSmart()
 DB_common::quoteString()
 DB_common::raiseError()
 DB_common::rollback()
 DB_common::setFetchMode()
 DB_common::setOption()
 DB_common::tableInfo()
 DB_common::toString()
 DB_common::_convertNullArrayValuesToEmpty()
 DB_common::_rtrimArrayValues()

Documentation generated on Fri, 11 Feb 2005 18:13:35 +0000 by phpDocumentor 1.3.0RC3