Source for file mssql.php
Documentation is available at mssql.php
// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Author: Frank M. Kromann <frank@kromann.info |
// +----------------------------------------------------------------------+
// $Id: mssql.php,v 1.4.4.8 2004/04/10 08:02:31 lsmith Exp $
if(!defined('MDB_MANAGER_MSSQL_INCLUDED'))
define('MDB_MANAGER_MSSQL_INCLUDED',1 );
require_once('MDB/Modules/Manager/Common.php');
* MDB MSSQL driver for the management modules
* @author Frank M. Kromann <frank@kromann.info
* @param object $dbs database object that is extended by this class
* @param string $name name of the database that should be created
* @return mixed MDB_OK on success, a MDB error on failure
$DatabaseDevice = isset ($db->options ["DatabaseDevice"]) ? $db->options ["DatabaseDevice"] : "DEFAULT";
$DatabaseSize = isset ($db->options ["DatabaseSize"]) ? ", SIZE=". $db->options ["DatabaseSize"] : "";
return($db->standaloneQuery (" CREATE DATABASE $name ON ". $DatabaseDevice. $DatabaseSize));
* drop an existing database
* @param object $dbs database object that is extended by this class
* @param string $name name of the database that should be dropped
* @return mixed MDB_OK on success, a MDB error on failure
return($db->standaloneQuery (" DROP DATABASE $name" ));
* alter an existing table
* @param object $dbs database object that is extended by this class
* @param string $name name of the table that is intended to be changed.
* @param array $changes associative array that contains the details of each type
* of change that is intended to be performed. The types of
* changes that are currently supported are defined as follows:
* New name for the table.
* Associative array with the names of fields to be added as
* indexes of the array. The value of each entry of the array
* should be set to another associative array with the properties
* of the fields to be added. The properties of the fields should
* be the same as defined by the Metabase parser.
* Additionally, there should be an entry named Declaration that
* is expected to contain the portion of the field declaration already
* in DBMS specific SQL code as it is used in the CREATE TABLE statement.
* Associative array with the names of fields to be removed as indexes
* of the array. Currently the values assigned to each entry are ignored.
* An empty array should be used for future compatibility.
* Associative array with the names of fields to be renamed as indexes
* of the array. The value of each entry of the array should be set to
* another associative array with the entry named name with the new
* field name and the entry named Declaration that is expected to contain
* the portion of the field declaration already in DBMS specific SQL code
* as it is used in the CREATE TABLE statement.
* Associative array with the names of the fields to be changed as indexes
* of the array. Keep in mind that if it is intended to change either the
* name of a field and any other properties, the ChangedFields array entries
* should have the new names of the fields as array indexes.
* The value of each entry of the array should be set to another associative
* array with the properties of the fields to that are meant to be changed as
* array entries. These entries should be assigned to the new values of the
* respective properties. The properties of the fields should be the same
* as defined by the Metabase parser.
* If the default property is meant to be added, removed or changed, there
* should also be an entry with index ChangedDefault assigned to 1. Similarly,
* if the notnull constraint is to be added or removed, there should also be
* an entry with index ChangedNotNull assigned to 1.
* Additionally, there should be an entry named Declaration that is expected
* to contain the portion of the field changed declaration already in DBMS
* specific SQL code as it is used in the CREATE TABLE statement.
* 'AddedFields' => array(
* 'Declaration' => 'quota INT'
* 'RemovedFields' => array(
* 'file_limit' => array(),
* 'time_limit' => array()
* 'ChangedFields' => array(
* 'Declaration' => "gender CHAR(1) DEFAULT 'M'"
* 'RenamedFields' => array(
* 'Declaration' => "gender CHAR(1) DEFAULT 'M'"
* @param boolean $check indicates whether the function should just check if the DBMS driver
* can perform the requested table alterations if the value is true or
* actually perform them otherwise.
* @return mixed MDB_OK on success, a MDB error on failure
function alterTable(&$db, $name, $changes, $check)
for ($change = 0 , reset($changes);
$change < count($changes);
next($changes), $change++
'Alter table: change type "'. key($changes). '" not yet supported'));
if (isset ($changes[$change = 'RemovedFields'])
|| isset ($changes[$change = 'name'])
|| isset ($changes[$change = 'RenamedFields'])
|| isset ($changes[$change = 'ChangedFields'])
'Alter table: change type "'. $change. '" is not supported by the server"'));
if (isset ($changes['AddedFields'])) {
$fields = $changes['AddedFields'];
for ($field = 0 , reset($fields);
$query.= $fields[key($fields)]['Declaration'];
return(strcmp($query, '') ? $db->query (" ALTER TABLE $name $query" ) : MDB_OK);
* list all tables in the current database
* @param object $db database object that is extended by this class
* @return mixed data array on success, a MDB error on failure
$query = 'EXECUTE sp_tables @table_type = "\'TABLE\'"';
$table_names = $db->queryCol ($query, null , 2 );
for ($i = 0 , $j = count($table_names); $i < $j; ++ $i) {
if (!$this->_isSequenceName ($db, $table_names[$i])) {
$tables[] = $table_names[$i];
* list all fields in a tables in the current database
* @param object $db database object that is extended by this class
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB error on failure
$result = $db->query (" SELECT * FROM $table" );
$columns = $db->getColumnNames ($result);
$db->freeResult ($columns);
// {{{ getTableFieldDefinition()
* get the stucture of a field into an array; this method is still alpha quality!
* @param object $db database object that is extended by this class
* @param string $table name of table that should be used in method
* @param string $field_name name of field that should be used in method
* @return mixed data array on success, a MDB error on failure
$columns = $db->queryRow (" EXEC sp_columns @table_name='$table',
if ($db->options ['optimize'] != 'portability') {
if (!isset ($columns[$column = 'column_name'])
|| !isset ($columns[$column = 'type_name'])
'Get table field definition: no result, please check table '.
$table. ' and field '. $field_name. ' are correct'));
$field_column = $columns['column_name'];
$type_column = $columns['type_name'];
if (strpos($type_column, ' ') !== FALSE ) {
$db_type = strtok($db_type, ' ');
$length = $columns['precision'];
$decimal = $columns['scale'];
'List table fields: unknown database attribute type'));
if ($columns['nullable'] == 0 ) {
if (isset ($columns['column_def']) && ($columns['column_def'] != NULL )) {
if (($type[0 ] = 'integer') OR ($type[0 ] = 'boolean')) {
$columns['column_def'] = str_replace( '(', '', $columns['column_def'] );
$columns['column_def'] = str_replace( ')', '', $columns['column_def'] );
$default = $columns['column_def'];
for ($field_choices = array (), $datatype = 0; $datatype < count($type); $datatype++ ) {
$field_choices[$datatype] = array ('type' => $type[$datatype]);
$field_choices[$datatype]['notnull'] = 1;
$field_choices[$datatype]['default'] = $default;
if ($type[$datatype] != 'boolean'
&& $type[$datatype] != 'time'
&& $type[$datatype] != 'date'
&& $type[$datatype] != 'timestamp'
$field_choices[$datatype]['length'] = $length;
$definition[0 ] = $field_choices;
if (strpos($type_column, 'identity') !== FALSE ) {
$implicit_sequence = array ();
$implicit_sequence['on'] = array ();
$implicit_sequence['on']['table'] = $table;
$implicit_sequence['on']['field'] = $field_name;
$definition[1 ]['name'] = $table. '_'. $field_name;
$definition[1 ]['definition'] = $implicit_sequence;
if (MDB::isError($indexes = $db->queryAll (" EXEC sp_pkeys @table_name='$table'"
foreach ($indexes as $index) {
if ($index['column_name'] == $field_name) {
$implicit_index = array ();
$implicit_index['unique'] = 1;
$implicit_index['FIELDS'][$field_name] = '';
$definition[2 ]['name'] = $field_name;
$definition[2 ]['definition'] = $implicit_index;
* @param object $dbs database object that is extended by this class
* @param string $seq_name name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @return mixed MDB_OK on success, a MDB error on failure
$sequence_name = $db->getSequenceName ($seq_name);
$query = " CREATE TABLE $sequence_name (". $db->options ['sequence_col_name']." INT NOT NULL IDENTITY($start,1) PRIMARY KEY CLUSTERED)";
return($db->query ($query));
* @param object $dbs database object that is extended by this class
* @param string $seq_name name of the sequence to be dropped
* @return mixed MDB_OK on success, a MDB error on failure
$sequence_name = $db->getSequenceName ($seq_name);
return($db->Query (" DROP TABLE $sequence_name" ));
Documentation generated on Mon, 11 Mar 2019 10:15:26 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|