Source for file mssql.php
Documentation is available at mssql.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2007 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith, Frank M. Kromann, Lorenzo Alberton |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB2 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. |
// +----------------------------------------------------------------------+
// | Authors: Lukas Smith <smith@pooteeweet.org> |
// | Lorenzo Alberton <l.alberton@quipo.it> |
// +----------------------------------------------------------------------+
// $Id: mssql.php 327310 2012-08-27 15:16:18Z danielc $
require_once 'MDB2/Driver/Reverse/Common.php';
* MDB2 MSSQL driver for the schema reverse engineering module
* @author Lukas Smith <smith@dybnet.de>
* @author Lorenzo Alberton <l.alberton@quipo.it>
// {{{ getTableFieldDefinition()
* Get the structure of a field into an array
* @param string $table_name 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 MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$result = $db->loadModule ('Datatype', null , true );
if (MDB2 ::isError ($result)) {
list ($schema, $table) = $this->splitTableSchema ($table_name);
$table = $db->quoteIdentifier ($table, true );
$fldname = $db->quoteIdentifier ($field_name, true );
$query = " SELECT t.table_name,
CASE c.is_nullable WHEN 'YES' THEN 1 ELSE 0 END AS 'is_nullable',
c.character_maximum_length 'length',
FROM INFORMATION_SCHEMA.TABLES t,
INFORMATION_SCHEMA.COLUMNS c
WHERE t.table_name = c.table_name
AND t.table_name = '$table'
AND c.column_name = '$fldname'";
$query .= " AND t.table_schema = '" . $db->quoteIdentifier ($schema, true ) . "'";
$query .= ' ORDER BY t.table_name';
$column = $db->queryRow ($query, null , MDB2_FETCHMODE_ASSOC );
if (MDB2 ::isError ($column)) {
return $db->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'it was not specified an existing table column', __FUNCTION__ );
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$mapped_datatype = $db->datatype ->mapNativeDatatype ($column);
if (MDB2 ::isError ($mapped_datatype)) {
list ($types, $length, $unsigned, $fixed) = $mapped_datatype;
if ($column['is_nullable']) {
$default = $column['column_default'];
if ((null === $default) && $notnull) {
} elseif (strlen($default) > 4
&& substr($default, 0 , 1 ) == '('
&& substr($default, -1 , 1 ) == ')'
//mssql wraps the default value in parentheses: "((1234))", "(NULL)"
$default = trim($default, '()');
if ($default == 'NULL') {
'nativetype' => preg_replace('/^([a-z]+)[^a-z].*/i', '\\1', $column['type'])
$definition[0 ]['length'] = $length;
if (null !== $unsigned) {
$definition[0 ]['unsigned'] = $unsigned;
$definition[0 ]['fixed'] = $fixed;
if (false !== $default) {
$definition[0 ]['default'] = $default;
foreach ($types as $key => $type) {
$definition[$key] = $definition[0 ];
if ($type == 'clob' || $type == 'blob') {
unset ($definition[$key]['default']);
$definition[$key]['type'] = $type;
$definition[$key]['mdb2type'] = $type;
// {{{ getTableIndexDefinition()
* Get the structure of an index into an array
* @param string $table_name name of table that should be used in method
* @param string $index_name name of index that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
list ($schema, $table) = $this->splitTableSchema ($table_name);
$table = $db->quoteIdentifier ($table, true );
//$idxname = $db->quoteIdentifier($index_name, true);
$query = " SELECT OBJECT_NAME(i.id) tablename,
CASE INDEXKEY_PROPERTY(i.id, i.indid, ik.keyno, 'IsDescending')
WHEN 1 THEN 'DESC' ELSE 'ASC'
JOIN sysindexkeys ik ON ik.id = i.id AND ik.indid = i.indid
JOIN syscolumns c ON c.id = ik.id AND c.colid = ik.colid
WHERE OBJECT_NAME(i.id) = '$table'
FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE k
WHERE k.table_name = OBJECT_NAME(i.id)
AND k.constraint_name = i.name";
$query .= " AND k.table_schema = '" . $db->quoteIdentifier ($schema, true ) . "'";
ORDER BY tablename, indexname, ik.keyno';
$index_name_mdb2 = $db->getIndexName ($index_name);
$result = $db->queryRow (sprintf($query, $index_name_mdb2));
if (!MDB2 ::isError ($result) && (null !== $result)) {
// apply 'idxname_format' only if the query succeeded, otherwise
// fallback to the given $index_name, without transformation
$index_name = $index_name_mdb2;
$result = $db->query (sprintf($query, $index_name));
if (MDB2 ::isError ($result)) {
while (is_array($row = $result->fetchRow (MDB2_FETCHMODE_ASSOC ))) {
$column_name = $row['field_name'];
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$definition['fields'][$column_name] = array (
'position' => (int) $row['position'],
if (!empty ($row['collation'])) {
$definition['fields'][$column_name]['sorting'] = ($row['collation'] == 'ASC'
? 'ascending' : 'descending');
if (empty ($definition['fields'])) {
return $db->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'it was not specified an existing table index', __FUNCTION__ );
// {{{ getTableConstraintDefinition()
* Get the structure of a constraint into an array
* @param string $table_name name of table that should be used in method
* @param string $constraint_name name of constraint that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
list ($schema, $table) = $this->splitTableSchema ($table_name);
$table = $db->quoteIdentifier ($table, true );
$query = " SELECT k.table_name,
k.column_name field_name,
CASE c.constraint_type WHEN 'PRIMARY KEY' THEN 1 ELSE 0 END 'primary',
CASE c.constraint_type WHEN 'UNIQUE' THEN 1 ELSE 0 END 'unique',
CASE c.constraint_type WHEN 'FOREIGN KEY' THEN 1 ELSE 0 END 'foreign',
CASE c.constraint_type WHEN 'CHECK' THEN 1 ELSE 0 END 'check',
CASE c.is_deferrable WHEN 'NO' THEN 0 ELSE 1 END 'deferrable',
CASE c.initially_deferred WHEN 'NO' THEN 0 ELSE 1 END 'initiallydeferred',
rc.update_rule 'onupdate',
rc.delete_rule 'ondelete',
kcu.table_name 'references_table',
kcu.column_name 'references_field',
k.ordinal_position 'field_position'
FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE k
LEFT JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS c
ON k.table_name = c.table_name
AND k.table_schema = c.table_schema
AND k.table_catalog = c.table_catalog
AND k.constraint_catalog = c.constraint_catalog
AND k.constraint_name = c.constraint_name
LEFT JOIN INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS rc
ON rc.constraint_schema = c.constraint_schema
AND rc.constraint_catalog = c.constraint_catalog
AND rc.constraint_name = c.constraint_name
LEFT JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE kcu
ON rc.unique_constraint_schema = kcu.constraint_schema
AND rc.unique_constraint_catalog = kcu.constraint_catalog
AND rc.unique_constraint_name = kcu.constraint_name
AND k.ordinal_position = kcu.ordinal_position
WHERE k.constraint_catalog = DB_NAME()
AND k.table_name = '$table'
AND k.constraint_name = '%s'";
$query .= " AND k.table_schema = '" . $db->quoteIdentifier ($schema, true ) . "'";
$query .= ' ORDER BY k.constraint_name,
$constraint_name_mdb2 = $db->getIndexName ($constraint_name);
$result = $db->queryRow (sprintf($query, $constraint_name_mdb2));
if (!MDB2 ::isError ($result) && (null !== $result)) {
// apply 'idxname_format' only if the query succeeded, otherwise
// fallback to the given $index_name, without transformation
$constraint_name = $constraint_name_mdb2;
$result = $db->query (sprintf($query, $constraint_name));
if (MDB2 ::isError ($result)) {
while (is_array($row = $result->fetchRow (MDB2_FETCHMODE_ASSOC ))) {
$column_name = $row['field_name'];
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$definition['fields'][$column_name] = array (
'position' => (int) $row['field_position']
$ref_column_name = $row['references_field'];
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$definition['references']['table'] = $row['references_table'];
$definition['references']['fields'][$ref_column_name] = array (
'position' => (int) $row['field_position']
if (!empty($row['collation'])) {
$definition['fields'][$column_name]['sorting'] = ($row['collation'] == 'ASC'
? 'ascending' : 'descending');
// otherwise $row is no longer usable on exit from loop
if (empty ($definition['fields'])) {
return $db->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
$constraint_name . ' is not an existing table constraint', __FUNCTION__ );
$definition['primary'] = (boolean) $lastrow['primary'];
$definition['unique'] = (boolean) $lastrow['unique'];
$definition['foreign'] = (boolean) $lastrow['foreign'];
$definition['check'] = (boolean) $lastrow['check'];
$definition['deferrable'] = (boolean) $lastrow['deferrable'];
$definition['initiallydeferred'] = (boolean) $lastrow['initiallydeferred'];
$definition['onupdate'] = $lastrow['onupdate'];
$definition['ondelete'] = $lastrow['ondelete'];
$definition['match'] = $lastrow['match'];
// {{{ getTriggerDefinition()
* Get the structure of a trigger into an array
* WARNING: this function is experimental and may change the returned value
* at any time until labelled as non-experimental
* @param string $trigger name of trigger that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT sys1.name trigger_name,
c.encrypted is_encripted,
WHEN OBJECTPROPERTY(sys1.id, 'ExecIsTriggerDisabled') = 1
WHEN OBJECTPROPERTY(sys1.id, 'ExecIsInsertTrigger') = 1
WHEN OBJECTPROPERTY(sys1.id, 'ExecIsUpdateTrigger') = 1
WHEN OBJECTPROPERTY(sys1.id, 'ExecIsDeleteTrigger') = 1
CASE WHEN OBJECTPROPERTY(sys1.id, 'ExecIsInsteadOfTrigger') = 1
THEN 'INSTEAD OF' ELSE 'AFTER'
JOIN sysobjects sys2 ON sys1.parent_obj = sys2.id
JOIN syscomments c ON sys1.id = c.id
AND sys1.name = ". $db->quote ($trigger, 'text');
'trigger_name' => 'text',
'trigger_body' => 'text',
'trigger_type' => 'text',
'trigger_event' => 'text',
'trigger_comment' => 'text',
'trigger_enabled' => 'boolean',
'is_encripted' => 'boolean',
$def = $db->queryRow ($query, $types, MDB2_FETCHMODE_ASSOC );
if (MDB2 ::isError ($def)) {
$trg_body = $db->queryCol ('EXEC sp_helptext '. $db->quote ($trigger, 'text'), 'text');
if (!MDB2 ::isError ($trg_body)) {
$def['trigger_body'] = implode(' ', $trg_body);
* Returns information about a table or a result set
* NOTE: only supports 'table' and 'flags' if <var>$result</var>
* @param object|string $result MDB2_result object from a query or a
* string containing the name of a table.
* While this also accepts a query result
* resource identifier, this behavior is
* @param int $mode a valid tableInfo mode
* @return array an associative array with the information requested.
* A MDB2_Error object on failure.
* @see MDB2_Driver_Common::tableInfo()
return parent ::tableInfo ($result, $mode);
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$resource = MDB2 ::isResultCommon ($result) ? $result->getResource () : $result;
return $db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'Could not generate result resource', __FUNCTION__ );
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$case_func = 'strtolower';
$case_func = 'strtoupper';
$count = @mssql_num_fields ($resource);
$res['num_fields'] = $count;
$db->loadModule ('Datatype', null , true );
for ($i = 0; $i < $count; $i++ ) {
'name' => $case_func(@mssql_field_name ($resource, $i)),
'type' => @mssql_field_type ($resource, $i),
'length' => @mssql_field_length ($resource, $i),
$mdb2type_info = $db->datatype ->mapNativeDatatype ($res[$i]);
if (MDB2 ::isError ($mdb2type_info)) {
$res[$i]['mdb2type'] = $mdb2type_info[0 ][0 ];
if ($mode & MDB2_TABLEINFO_ORDER ) {
$res['order'][$res[$i]['name']] = $i;
if ($mode & MDB2_TABLEINFO_ORDERTABLE ) {
$res['ordertable'][$res[$i]['table']][$res[$i]['name']] = $i;
// {{{ _mssql_field_flags()
* 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?
* @param string $table the table name
* @param string $column the field name
* @return string the flags
* @author Joern Barthel <j_barthel@web.de>
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
static $tableName = null;
if ($table != $tableName) {
// get unique and primary keys
$res = $db->queryAll (" EXEC SP_HELPINDEX[$table]" , null , MDB2_FETCHMODE_ASSOC );
$keys = explode(', ', $val['index_keys']);
foreach ($keys as $key) {
$this->_add_flag($flags[$key], 'multiple_key');
if (strpos($val['index_description'], 'primary key')) {
foreach ($keys as $key) {
$this->_add_flag($flags[$key], 'primary_key');
} elseif (strpos($val['index_description'], 'unique')) {
foreach ($keys as $key) {
$this->_add_flag($flags[$key], 'unique_key');
// get auto_increment, not_null and timestamp
$res = $db->queryAll (" EXEC SP_COLUMNS[$table]" , null , MDB2_FETCHMODE_ASSOC );
if ($val['nullable'] == '0') {
$this->_add_flag($flags[$val['column_name']], 'not_null');
if (strpos($val['type_name'], 'identity')) {
$this->_add_flag($flags[$val['column_name']], 'auto_increment');
if (strpos($val['type_name'], 'timestamp')) {
$this->_add_flag($flags[$val['column_name']], 'timestamp');
if (!empty ($flags[$column])) {
return(implode (' ', $flags[$column]));
* 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
* @param array &$array the reference to the flag-array
* @param string $value the flag value
* @author Joern Barthel <j_barthel@web.de>
Documentation generated on Mon, 11 Mar 2019 15:51:12 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|