3 * This is the MS SQL Server Native database abstraction layer.
7 * @author Joel Penner <a-joelpe at microsoft dot com>
8 * @author Chris Pucci <a-cpucci at microsoft dot com>
9 * @author Ryan Biesemeyer <v-ryanbi at microsoft dot com>
15 class DatabaseMssql extends DatabaseBase {
16 var $mInsertId = NULL;
17 var $mLastResult = NULL;
18 var $mAffectedRows = NULL;
20 function cascadingDeletes() {
23 function cleanupTriggers() {
26 function strictIPs() {
29 function realTimestamps() {
32 function implicitGroupby() {
35 function implicitOrderby() {
38 function functionalIndexes() {
41 function unionSupportsOrderAndLimit() {
45 static function newFromParams( $server, $user, $password, $dbName, $flags = 0 ) {
46 return new DatabaseMssql( $server, $user, $password, $dbName, $flags );
50 * Usually aborts on failure
52 function open( $server, $user, $password, $dbName ) {
53 # Test for driver support, to avoid suppressed fatal error
54 if ( !function_exists( 'sqlsrv_connect' ) ) {
55 throw new DBConnectionError( $this, "MS Sql Server Native (sqlsrv) functions missing. You can download the driver from: http://go.microsoft.com/fwlink/?LinkId=123470\n" );
60 if ( !strlen( $user ) ) { # e.g. the class is being loaded
65 $this->mServer = $server;
66 $this->mPort = $wgDBport;
68 $this->mPassword = $password;
69 $this->mDBname = $dbName;
71 $connectionInfo = array();
74 $connectionInfo['Database'] = $dbName;
78 // Quick and dirty work around to provide NT Auth designation support.
79 // Current solution requires installer to know to input 'ntauth' for both username and password
80 // to trigger connection via NT Auth. - ugly, ugly, ugly
81 // TO-DO: Make this better and add NT Auth choice to MW installer when SQL Server option is chosen.
82 $ntAuthUserTest = strtolower( $user );
83 $ntAuthPassTest = strtolower( $password );
85 // Decide which auth scenerio to use
86 if( ( $ntAuthPassTest == 'ntauth' && $ntAuthUserTest == 'ntauth' ) ){
87 // Don't add credentials to $connectionInfo
89 $connectionInfo['UID'] = $user;
90 $connectionInfo['PWD'] = $password;
94 $this->mConn = @sqlsrv_connect( $server, $connectionInfo );
96 if ( $this->mConn === false ) {
97 wfDebug( "DB connection error\n" );
98 wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
99 wfDebug( $this->lastError() . "\n" );
103 $this->mOpened = true;
108 * Closes a database connection, if it is open
109 * Returns success, true if already closed
112 $this->mOpened = false;
113 if ( $this->mConn ) {
114 return sqlsrv_close( $this->mConn );
120 function doQuery( $sql ) {
121 wfDebug( "SQL: [$sql]\n" );
124 // several extensions seem to think that all databases support limits via LIMIT N after the WHERE clause
125 // well, MSSQL uses SELECT TOP N, so to catch any of those extensions we'll do a quick check for a LIMIT
126 // clause and pass $sql through $this->LimitToTopN() which parses the limit clause and passes the result to
127 // $this->limitResult();
128 if ( preg_match( '/\bLIMIT\s*/i', $sql ) ) {
129 // massage LIMIT -> TopN
130 $sql = $this->LimitToTopN( $sql ) ;
133 // MSSQL doesn't have EXTRACT(epoch FROM XXX)
134 if ( preg_match('#\bEXTRACT\s*?\(\s*?EPOCH\s+FROM\b#i', $sql, $matches ) ) {
135 // This is same as UNIX_TIMESTAMP, we need to calc # of seconds from 1970
136 $sql = str_replace( $matches[0], "DATEDIFF(s,CONVERT(datetime,'1/1/1970'),", $sql );
140 $stmt = sqlsrv_query( $this->mConn, $sql );
141 if ( $stmt == false ) {
142 $message = "A database error has occurred. Did you forget to run maintenance/update.php after upgrading? See: http://www.mediawiki.org/wiki/Manual:Upgrading#Run_the_update_script\n" .
143 "Query: " . htmlentities( $sql ) . "\n" .
144 "Function: " . __METHOD__ . "\n";
145 // process each error (our driver will give us an array of errors unlike other providers)
146 foreach ( sqlsrv_errors() as $error ) {
147 $message .= $message . "ERROR[" . $error['code'] . "] " . $error['message'] . "\n";
150 throw new DBUnexpectedError( $this, $message );
152 // remember number of rows affected
153 $this->mAffectedRows = sqlsrv_rows_affected( $stmt );
155 // if it is a SELECT statement, or an insert with a request to output something we want to return a row.
156 if ( ( preg_match( '#\bSELECT\s#i', $sql ) ) ||
157 ( preg_match( '#\bINSERT\s#i', $sql ) && preg_match( '#\bOUTPUT\s+INSERTED\b#i', $sql ) ) ) {
158 // this is essentially a rowset, but Mediawiki calls these 'result'
159 // the rowset owns freeing the statement
160 $res = new MssqlResult( $stmt );
162 // otherwise we simply return it was successful, failure throws an exception
168 function freeResult( $res ) {
169 if ( $res instanceof ResultWrapper ) {
175 function fetchObject( $res ) {
176 if ( $res instanceof ResultWrapper ) {
179 $row = $res->fetch( 'OBJECT' );
183 function getErrors() {
185 $retErrors = sqlsrv_errors( SQLSRV_ERR_ALL );
186 if ( $retErrors != null ) {
187 foreach ( $retErrors as $arrError ) {
188 $strRet .= "SQLState: " . $arrError[ 'SQLSTATE'] . "\n";
189 $strRet .= "Error Code: " . $arrError[ 'code'] . "\n";
190 $strRet .= "Message: " . $arrError[ 'message'] . "\n";
193 $strRet = "No errors found";
198 function fetchRow( $res ) {
199 if ( $res instanceof ResultWrapper ) {
202 $row = $res->fetch( SQLSRV_FETCH_BOTH );
206 function numRows( $res ) {
207 if ( $res instanceof ResultWrapper ) {
210 return ( $res ) ? $res->numrows() : 0;
213 function numFields( $res ) {
214 if ( $res instanceof ResultWrapper ) {
217 return ( $res ) ? $res->numfields() : 0;
220 function fieldName( $res, $n ) {
221 if ( $res instanceof ResultWrapper ) {
224 return ( $res ) ? $res->fieldname( $n ) : 0;
228 * This must be called after nextSequenceVal
230 function insertId() {
231 return $this->mInsertId;
234 function dataSeek( $res, $row ) {
235 if ( $res instanceof ResultWrapper ) {
238 return ( $res ) ? $res->seek( $row ) : false;
241 function lastError() {
242 if ( $this->mConn ) {
243 return $this->getErrors();
246 return "No database connection";
250 function lastErrno() {
251 $err = sqlsrv_errors( SQLSRV_ERR_ALL );
252 if ( $err[0] ) return $err[0]['code'];
256 function affectedRows() {
257 return $this->mAffectedRows;
263 * @param $table Mixed: array or string, table name(s) (prefix auto-added)
264 * @param $vars Mixed: array or string, field name(s) to be retrieved
265 * @param $conds Mixed: array or string, condition(s) for WHERE
266 * @param $fname String: calling function name (use __METHOD__) for logs/profiling
267 * @param $options Array: associative array of options (e.g. array('GROUP BY' => 'page_title')),
268 * see Database::makeSelectOptions code for list of supported stuff
269 * @param $join_conds Array: Associative array of table join conditions (optional)
270 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
271 * @return Mixed: database result resource (feed to Database::fetchObject or whatever), or false on failure
273 function select( $table, $vars, $conds = '', $fname = 'DatabaseMssql::select', $options = array(), $join_conds = array() )
275 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
276 if ( isset( $options['EXPLAIN'] ) ) {
277 sqlsrv_query( $this->mConn, "SET SHOWPLAN_ALL ON;" );
278 $ret = $this->query( $sql, $fname );
279 sqlsrv_query( $this->mConn, "SET SHOWPLAN_ALL OFF;" );
282 return $this->query( $sql, $fname );
288 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
289 * @param $vars Mixed: Array or string, field name(s) to be retrieved
290 * @param $conds Mixed: Array or string, condition(s) for WHERE
291 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
292 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
293 * see Database::makeSelectOptions code for list of supported stuff
294 * @param $join_conds Array: Associative array of table join conditions (optional)
295 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
296 * @return string, the SQL text
298 function selectSQLText( $table, $vars, $conds = '', $fname = 'DatabaseMssql::select', $options = array(), $join_conds = array() ) {
299 if ( isset( $options['EXPLAIN'] ) ) {
300 unset( $options['EXPLAIN'] );
302 return parent::selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
306 * Estimate rows in dataset
307 * Returns estimated count, based on SHOWPLAN_ALL output
308 * This is not necessarily an accurate estimate, so use sparingly
309 * Returns -1 if count cannot be found
310 * Takes same arguments as Database::select()
312 function estimateRowCount( $table, $vars = '*', $conds = '', $fname = 'DatabaseMssql::estimateRowCount', $options = array() ) {
313 $options['EXPLAIN'] = true;// http://msdn2.microsoft.com/en-us/library/aa259203.aspx
314 $res = $this->select( $table, $vars, $conds, $fname, $options );
318 $row = $this->fetchRow( $res );
319 if ( isset( $row['EstimateRows'] ) ) $rows = $row['EstimateRows'];
326 * Returns information about an index
327 * If errors are explicitly ignored, returns NULL on failure
329 function indexInfo( $table, $index, $fname = 'DatabaseMssql::indexExists' ) {
330 # This does not return the same info as MYSQL would, but that's OK because MediaWiki never uses the
331 # returned value except to check for the existance of indexes.
332 $sql = "sp_helpindex '" . $table . "'";
333 $res = $this->query( $sql, $fname );
339 foreach ( $res as $row ) {
340 if ( $row->index_name == $index ) {
341 $row->Non_unique = !stristr( $row->index_description, "unique" );
342 $cols = explode( ", ", $row->index_keys );
343 foreach ( $cols as $col ) {
344 $row->Column_name = trim( $col );
345 $result[] = clone $row;
347 } else if ( $index == 'PRIMARY' && stristr( $row->index_description, 'PRIMARY' ) ) {
348 $row->Non_unique = 0;
349 $cols = explode( ", ", $row->index_keys );
350 foreach ( $cols as $col ) {
351 $row->Column_name = trim( $col );
352 $result[] = clone $row;
356 return empty( $result ) ? false : $result;
360 * INSERT wrapper, inserts an array into a table
362 * $arrToInsert may be a single associative array, or an array of these with numeric keys, for
365 * Usually aborts on failure
366 * If errors are explicitly ignored, returns success
368 function insert( $table, $arrToInsert, $fname = 'DatabaseMssql::insert', $options = array() ) {
369 # No rows to insert, easy just return now
370 if ( !count( $arrToInsert ) ) {
374 if ( !is_array( $options ) ) {
375 $options = array( $options );
378 $table = $this->tableName( $table );
380 if ( !( isset( $arrToInsert[0] ) && is_array( $arrToInsert[0] ) ) ) {// Not multi row
381 $arrToInsert = array( 0 => $arrToInsert );// make everything multi row compatible
387 // We know the table we're inserting into, get its identity column
389 $tableRaw = preg_replace( '#\[([^\]]*)\]#', '$1', $table ); // strip matching square brackets from table name
390 $res = $this->doQuery( "SELECT NAME AS idColumn FROM SYS.IDENTITY_COLUMNS WHERE OBJECT_NAME(OBJECT_ID)='{$tableRaw}'" );
391 if( $res && $res->numrows() ){
392 // There is an identity for this table.
393 $identity = array_pop( $res->fetch( SQLSRV_FETCH_ASSOC ) );
397 foreach ( $arrToInsert as $a ) {
398 // start out with empty identity column, this is so we can return it as a result of the insert logic
401 $identityClause = '';
403 // if we have an identity column
406 foreach ($a as $k => $v ) {
407 if ( $k == $identity ) {
409 // there is a value being passed to us, we need to turn on and off inserted identity
410 $sqlPre = "SET IDENTITY_INSERT $table ON;" ;
411 $sqlPost = ";SET IDENTITY_INSERT $table OFF;";
414 // we can't insert NULL into an identity column, so remove the column from the insert.
419 $identityClause = "OUTPUT INSERTED.$identity "; // we want to output an identity column as result
422 $keys = array_keys( $a );
425 // INSERT IGNORE is not supported by SQL Server
426 // remove IGNORE from options list and set ignore flag to true
427 $ignoreClause = false;
428 foreach ( $options as $k => $v ) {
429 if ( strtoupper( $v ) == "IGNORE" ) {
430 unset( $options[$k] );
431 $ignoreClause = true;
435 // translate MySQL INSERT IGNORE to something SQL Server can use
437 // MySQL: INSERT IGNORE INTO user_groups (ug_user,ug_group) VALUES ('1','sysop')
438 // MSSQL: IF NOT EXISTS (SELECT * FROM user_groups WHERE ug_user = '1') INSERT INTO user_groups (ug_user,ug_group) VALUES ('1','sysop')
439 if ( $ignoreClause == true ) {
440 $prival = $a[$keys[0]];
441 $sqlPre .= "IF NOT EXISTS (SELECT * FROM $table WHERE $keys[0] = '$prival')";
444 // Build the actual query
445 $sql = $sqlPre . 'INSERT ' . implode( ' ', $options ) .
446 " INTO $table (" . implode( ',', $keys ) . ") $identityClause VALUES (";
449 foreach ( $a as $value ) {
455 if ( is_string( $value ) ) {
456 $sql .= $this->addIdentifierQuotes( $value );
457 } elseif ( is_null( $value ) ) {
459 } elseif ( is_array( $value ) || is_object( $value ) ) {
460 if ( is_object( $value ) && strtolower( get_class( $value ) ) == 'blob' ) {
461 $sql .= $this->addIdentifierQuotes( $value->fetch() );
463 $sql .= $this->addIdentifierQuotes( serialize( $value ) );
469 $sql .= ')' . $sqlPost;
472 $ret = sqlsrv_query( $this->mConn, $sql );
474 if ( $ret === false ) {
475 throw new DBQueryError( $this, $this->getErrors(), $this->lastErrno(), $sql, $fname );
476 } elseif ( $ret != NULL ) {
477 // remember number of rows affected
478 $this->mAffectedRows = sqlsrv_rows_affected( $ret );
479 if ( !is_null($identity) ) {
480 // then we want to get the identity column value we were assigned and save it off
481 $row = sqlsrv_fetch_object( $ret );
482 $this->mInsertId = $row->$identity;
484 sqlsrv_free_stmt( $ret );
493 * INSERT SELECT wrapper
494 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
495 * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
496 * $conds may be "*" to copy the whole table
497 * srcTable may be an array of tables.
499 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseMssql::insertSelect',
500 $insertOptions = array(), $selectOptions = array() )
502 $ret = parent::insertSelect( $destTable, $srcTable, $varMap, $conds, $fname, $insertOptions, $selectOptions );
504 if ( $ret === false ) {
505 throw new DBQueryError( $this, $this->getErrors(), $this->lastErrno(), $sql, $fname );
506 } elseif ( $ret != NULL ) {
507 // remember number of rows affected
508 $this->mAffectedRows = sqlsrv_rows_affected( $ret );
515 * Format a table name ready for use in constructing an SQL query
517 * This does two important things: it brackets table names which as necessary,
518 * and it adds a table prefix if there is one.
520 * All functions of this object which require a table name call this function
521 * themselves. Pass the canonical name to such functions. This is only needed
522 * when calling query() directly.
524 * @param $name String: database table name
526 function tableName( $name ) {
528 # Skip quoted literals
529 if ( $name != '' && $name { 0 } != '[' ) {
530 if ( $this->mTablePrefix !== '' && strpos( '.', $name ) === false ) {
531 $name = "{$this->mTablePrefix}$name";
533 if ( isset( $wgSharedDB ) && "{$this->mTablePrefix}user" == $name ) {
534 $name = "[$wgSharedDB].[$name]";
537 if ( $name != '' ) $name = "[$name]";
544 * Return the next in a sequence, save the value for retrieval via insertId()
546 function nextSequenceValue( $seqName ) {
547 if ( !$this->tableExists( 'sequence_' . $seqName ) ) {
548 sqlsrv_query( $this->mConn, "CREATE TABLE [sequence_$seqName] (id INT NOT NULL IDENTITY PRIMARY KEY, junk varchar(10) NULL)" );
550 sqlsrv_query( $this->mConn, "INSERT INTO [sequence_$seqName] (junk) VALUES ('')" );
551 $ret = sqlsrv_query( $this->mConn, "SELECT TOP 1 id FROM [sequence_$seqName] ORDER BY id DESC" );
552 $row = sqlsrv_fetch_array( $ret, SQLSRV_FETCH_ASSOC );// KEEP ASSOC THERE, weird weird bug dealing with the return value if you don't
554 sqlsrv_free_stmt( $ret );
555 $this->mInsertId = $row['id'];
560 * Return the current value of a sequence. Assumes it has ben nextval'ed in this session.
562 function currentSequenceValue( $seqName ) {
563 $ret = sqlsrv_query( $this->mConn, "SELECT TOP 1 id FROM [sequence_$seqName] ORDER BY id DESC" );
564 if ( $ret !== false ) {
565 $row = sqlsrv_fetch_array( $ret );
566 sqlsrv_free_stmt( $ret );
569 return $this->nextSequenceValue( $seqName );
574 # REPLACE query wrapper
575 # MSSQL simulates this with a DELETE followed by INSERT
576 # $row is the row to insert, an associative array
577 # $uniqueIndexes is an array of indexes. Each element may be either a
578 # field name or an array of field names
580 # It may be more efficient to leave off unique indexes which are unlikely to collide.
581 # However if you do this, you run the risk of encountering errors which wouldn't have
583 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseMssql::replace' ) {
584 $table = $this->tableName( $table );
586 if ( count( $rows ) == 0 ) {
591 if ( !is_array( reset( $rows ) ) ) {
592 $rows = array( $rows );
595 foreach ( $rows as $row ) {
596 # Delete rows which collide
597 if ( $uniqueIndexes ) {
598 $sql = "DELETE FROM $table WHERE ";
600 foreach ( $uniqueIndexes as $index ) {
607 if ( is_array( $index ) ) {
609 foreach ( $index as $col ) {
615 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
618 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
622 $this->query( $sql, $fname );
626 $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES ) . ') VALUES (' .
627 $this->makeList( $row, LIST_COMMA ) . ')';
628 $this->query( $sql, $fname );
632 # DELETE where the condition is a join
633 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "DatabaseMssql::deleteJoin" ) {
635 throw new DBUnexpectedError( $this, 'DatabaseMssql::deleteJoin() called with empty $conds' );
638 $delTable = $this->tableName( $delTable );
639 $joinTable = $this->tableName( $joinTable );
640 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
641 if ( $conds != '*' ) {
642 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
646 $this->query( $sql, $fname );
649 # Returns the size of a text field, or -1 for "unlimited"
650 function textFieldSize( $table, $field ) {
651 $table = $this->tableName( $table );
652 $sql = "SELECT CHARACTER_MAXIMUM_LENGTH,DATA_TYPE FROM INFORMATION_SCHEMA.Columns
653 WHERE TABLE_NAME = '$table' AND COLUMN_NAME = '$field'";
654 $res = $this->query( $sql );
655 $row = $this->fetchRow( $res );
657 if ( strtolower( $row['DATA_TYPE'] ) != 'text' ) $size = $row['CHARACTER_MAXIMUM_LENGTH'];
662 * Construct a LIMIT query with optional offset
663 * This is used for query pages
664 * $sql string SQL query we will append the limit too
665 * $limit integer the SQL limit
666 * $offset integer the SQL offset (default false)
668 function limitResult( $sql, $limit, $offset = false ) {
669 if ( $offset === false || $offset == 0 ) {
670 if ( strpos( $sql, "SELECT" ) === false ) {
671 return "TOP {$limit} " . $sql;
673 return preg_replace( '/\bSELECT(\s*DISTINCT)?\b/Dsi', 'SELECT$1 TOP ' . $limit, $sql, 1 );
678 SELECT sub2.*, ROW_NUMBER() OVER(ORDER BY sub2.line2) AS line3 FROM (
679 SELECT 1 AS line2, sub1.* FROM (' . $sql . ') AS sub1
682 WHERE line3 BETWEEN ' . ( $offset + 1 ) . ' AND ' . ( $offset + $limit );
687 // If there is a limit clause, parse it, strip it, and pass the remaining sql through limitResult()
688 // with the appropriate parameters. Not the prettiest solution, but better than building a whole new parser.
689 // This exists becase there are still too many extensions that don't use dynamic sql generation.
690 function LimitToTopN( $sql ) {
691 // Matches: LIMIT {[offset,] row_count | row_count OFFSET offset}
692 $pattern = '/\bLIMIT\s+((([0-9]+)\s*,\s*)?([0-9]+)(\s+OFFSET\s+([0-9]+))?)/i';
693 if ( preg_match( $pattern, $sql, $matches ) ) {
694 // row_count = $matches[4]
695 $row_count = $matches[4];
696 // offset = $matches[3] OR $matches[6]
697 $offset = $matches[3] or
698 $offset = $matches[6] or
701 // strip the matching LIMIT clause out
702 $sql = str_replace( $matches[0], '', $sql );
703 return $this->limitResult( $sql, $row_count, $offset );
708 // MSSQL does support this, but documentation is too thin to make a generalized
709 // function for this. Apparently UPDATE TOP (N) works, but the sort order
710 // may not be what we're expecting so the top n results may be a random selection.
711 // TODO: Implement properly.
712 function limitResultForUpdate( $sql, $num ) {
717 function timestamp( $ts = 0 ) {
718 return wfTimestamp( TS_ISO_8601, $ts );
722 * @return string wikitext of a link to the server software's web site
724 public static function getSoftwareLink() {
725 return "[http://www.microsoft.com/sql/ MS SQL Server]";
729 * @return string Version information from the database
731 function getServerVersion() {
732 $server_info = sqlsrv_server_info( $this->mConn );
734 if ( isset( $server_info['SQLServerVersion'] ) ) $version = $server_info['SQLServerVersion'];
738 function tableExists ( $table, $schema = false ) {
739 $res = sqlsrv_query( $this->mConn, "SELECT * FROM information_schema.tables
740 WHERE table_type='BASE TABLE' AND table_name = '$table'" );
741 if ( $res === false ) {
742 print( "Error in tableExists query: " . $this->getErrors() );
745 if ( sqlsrv_fetch( $res ) )
752 * Query whether a given column exists in the mediawiki schema
754 function fieldExists( $table, $field, $fname = 'DatabaseMssql::fieldExists' ) {
755 $table = $this->tableName( $table );
756 $res = sqlsrv_query( $this->mConn, "SELECT DATA_TYPE FROM INFORMATION_SCHEMA.Columns
757 WHERE TABLE_NAME = '$table' AND COLUMN_NAME = '$field'" );
758 if ( $res === false ) {
759 print( "Error in fieldExists query: " . $this->getErrors() );
762 if ( sqlsrv_fetch( $res ) )
768 function fieldInfo( $table, $field ) {
769 $table = $this->tableName( $table );
770 $res = sqlsrv_query( $this->mConn, "SELECT * FROM INFORMATION_SCHEMA.Columns
771 WHERE TABLE_NAME = '$table' AND COLUMN_NAME = '$field'" );
772 if ( $res === false ) {
773 print( "Error in fieldInfo query: " . $this->getErrors() );
776 $meta = $this->fetchRow( $res );
778 return new MssqlField( $meta );
783 public function unixTimestamp( $field ) {
784 return "DATEDIFF(s,CONVERT(datetime,'1/1/1970'),$field)";
788 * Begin a transaction, committing any previously open transaction
790 function begin( $fname = 'DatabaseMssql::begin' ) {
791 sqlsrv_begin_transaction( $this->mConn );
792 $this->mTrxLevel = 1;
798 function commit( $fname = 'DatabaseMssql::commit' ) {
799 sqlsrv_commit( $this->mConn );
800 $this->mTrxLevel = 0;
804 * Rollback a transaction.
805 * No-op on non-transactional databases.
807 function rollback( $fname = 'DatabaseMssql::rollback' ) {
808 sqlsrv_rollback( $this->mConn );
809 $this->mTrxLevel = 0;
812 function setup_database() {
815 // Make sure that we can write to the correct schema
816 $ctest = "mediawiki_test_table";
817 if ( $this->tableExists( $ctest ) ) {
818 $this->doQuery( "DROP TABLE $ctest" );
820 $SQL = "CREATE TABLE $ctest (a int)";
821 $res = $this->doQuery( $SQL );
823 print "<b>FAILED</b>. Make sure that the user " . htmlspecialchars( $wgDBuser ) . " can write to the database</li>\n";
826 $this->doQuery( "DROP TABLE $ctest" );
828 $res = $this->sourceFile( "../maintenance/mssql/tables.sql" );
829 if ( $res !== true ) {
830 echo " <b>FAILED</b></li>";
831 dieout( htmlspecialchars( $res ) );
834 # Avoid the non-standard "REPLACE INTO" syntax
835 $f = fopen( "../maintenance/interwiki.sql", 'r' );
837 dieout( "<li>Could not find the interwiki.sql file" );
839 # We simply assume it is already empty as we have just created it
840 $SQL = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES ";
841 while ( ! feof( $f ) ) {
842 $line = fgets( $f, 1024 );
844 if ( !preg_match( '/^\s*(\(.+?),(\d)\)/', $line, $matches ) ) {
847 $this->query( "$SQL $matches[1],$matches[2])" );
849 print " (table interwiki successfully populated)...\n";
855 * Escapes a identifier for use inm SQL.
856 * Throws an exception if it is invalid.
857 * Reference: http://msdn.microsoft.com/en-us/library/aa224033%28v=SQL.80%29.aspx
859 private function escapeIdentifier( $identifier ) {
860 if ( strlen( $identifier ) == 0 ) {
861 throw new MWException( "An identifier must not be empty" );
863 if ( strlen( $identifier ) > 128 ) {
864 throw new MWException( "The identifier '$identifier' is too long (max. 128)" );
866 if ( ( strpos( $identifier, '[' ) !== false ) || ( strpos( $identifier, ']' ) !== false ) ) {
867 // It may be allowed if you quoted with double quotation marks, but that would break if QUOTED_IDENTIFIER is OFF
868 throw new MWException( "You can't use square brackers in the identifier '$identifier'" );
870 return "[$identifier]";
875 * Precondition: This object is connected as the superuser.
876 * Creates the database, schema, user and login.
878 function initial_setup( $dbName, $newUser, $loginPassword ) {
879 $dbName = $this->escapeIdentifier( $dbName );
881 // It is not clear what can be used as a login,
882 // From http://msdn.microsoft.com/en-us/library/ms173463.aspx
883 // a sysname may be the same as an identifier.
884 $newUser = $this->escapeIdentifier( $newUser );
885 $loginPassword = $this->addQuotes( $loginPassword );
887 $this->doQuery("CREATE DATABASE $dbName;");
888 $this->doQuery("USE $dbName;");
889 $this->doQuery("CREATE SCHEMA $dbName;");
894 PASSWORD=$loginPassword
903 DEFAULT_SCHEMA=$dbName
916 CREATE FULLTEXT CATALOG
934 function encodeBlob( $b ) {
935 // we can't have zero's and such, this is a simple encoding to make sure we don't barf
936 return base64_encode( $b );
939 function decodeBlob( $b ) {
940 // we can't have zero's and such, this is a simple encoding to make sure we don't barf
941 return base64_decode( $b );
947 function tableNamesWithUseIndexOrJOIN( $tables, $use_index = array(), $join_conds = array() ) {
950 $use_index_safe = is_array( $use_index ) ? $use_index : array();
951 $join_conds_safe = is_array( $join_conds ) ? $join_conds : array();
952 foreach ( $tables as $table ) {
953 // Is there a JOIN and INDEX clause for this table?
954 if ( isset( $join_conds_safe[$table] ) && isset( $use_index_safe[$table] ) ) {
955 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
956 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
957 $tableClause .= ' ON (' . $this->makeList( (array)$join_conds_safe[$table][1], LIST_AND ) . ')';
958 $retJOIN[] = $tableClause;
959 // Is there an INDEX clause?
960 } else if ( isset( $use_index_safe[$table] ) ) {
961 $tableClause = $this->tableName( $table );
962 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
963 $ret[] = $tableClause;
964 // Is there a JOIN clause?
965 } else if ( isset( $join_conds_safe[$table] ) ) {
966 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
967 $tableClause .= ' ON (' . $this->makeList( (array)$join_conds_safe[$table][1], LIST_AND ) . ')';
968 $retJOIN[] = $tableClause;
970 $tableClause = $this->tableName( $table );
971 $ret[] = $tableClause;
974 // We can't separate explicit JOIN clauses with ',', use ' ' for those
975 $straightJoins = !empty( $ret ) ? implode( ',', $ret ) : "";
976 $otherJoins = !empty( $retJOIN ) ? implode( ' ', $retJOIN ) : "";
977 // Compile our final table clause
978 return implode( ' ', array( $straightJoins, $otherJoins ) );
981 function strencode( $s ) { # Should not be called by us
982 return str_replace( "'", "''", $s );
985 function addQuotes( $s ) {
986 if ( $s instanceof Blob ) {
987 return "'" . $s->fetch( $s ) . "'";
989 return parent::addQuotes( $s );
993 function selectDB( $db ) {
994 return ( $this->query( "SET DATABASE $db" ) !== false );
1000 * @param $options Array: an associative array of options to be turned into
1001 * an SQL query, valid keys are listed in the function.
1004 function makeSelectOptions( $options ) {
1008 $noKeyOptions = array();
1009 foreach ( $options as $key => $option ) {
1010 if ( is_numeric( $key ) ) {
1011 $noKeyOptions[$option] = true;
1015 if ( isset( $options['GROUP BY'] ) ) $tailOpts .= " GROUP BY {$options['GROUP BY']}";
1016 if ( isset( $options['HAVING'] ) ) $tailOpts .= " HAVING {$options['GROUP BY']}";
1017 if ( isset( $options['ORDER BY'] ) ) $tailOpts .= " ORDER BY {$options['ORDER BY']}";
1019 if ( isset( $noKeyOptions['DISTINCT'] ) && isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
1021 // we want this to be compatible with the output of parent::makeSelectOptions()
1022 return array( $startOpts, '' , $tailOpts, '' );
1026 * Get the type of the DBMS, as it appears in $wgDBtype.
1032 function buildConcat( $stringList ) {
1033 return implode( ' + ', $stringList );
1036 public function getSearchEngine() {
1037 return "SearchMssql";
1040 } // end DatabaseMssql class
1047 class MssqlField implements Field {
1048 private $name, $tablename, $default, $max_length, $nullable, $type;
1049 function __construct ( $info ) {
1050 $this->name = $info['COLUMN_NAME'];
1051 $this->tablename = $info['TABLE_NAME'];
1052 $this->default = $info['COLUMN_DEFAULT'];
1053 $this->max_length = $info['CHARACTER_MAXIMUM_LENGTH'];
1054 $this->nullable = ( strtolower( $info['IS_NULLABLE'] ) == 'no' ) ? false:true;
1055 $this->type = $info['DATA_TYPE'];
1061 function tableName() {
1062 return $this->tableName;
1065 function defaultValue() {
1066 return $this->default;
1069 function maxLength() {
1070 return $this->max_length;
1073 function isNullable() {
1074 return $this->nullable;
1083 * The MSSQL PHP driver doesn't support sqlsrv_num_rows, so we recall all rows into an array and maintain our
1084 * own cursor index into that array...This is similar to the way the Oracle driver handles this same issue
1090 public function __construct( $queryresult = false ) {
1092 $this->mRows = array();
1093 $this->mNumFields = sqlsrv_num_fields( $queryresult );
1094 $this->mFieldMeta = sqlsrv_field_metadata( $queryresult );
1095 while ( $row = sqlsrv_fetch_array( $queryresult, SQLSRV_FETCH_ASSOC ) ) {
1096 if ( $row !== null ) {
1097 foreach ( $row as $k => $v ) {
1098 if ( is_object( $v ) && method_exists( $v, 'format' ) ) {// DateTime Object
1099 $row[$k] = $v->format( "Y-m-d\TH:i:s\Z" );
1102 $this->mRows[] = $row;// read results into memory, cursors are not supported
1105 $this->mRowCount = count( $this->mRows );
1106 sqlsrv_free_stmt( $queryresult );
1109 private function array_to_obj( $array, &$obj ) {
1110 foreach ( $array as $key => $value ) {
1111 if ( is_array( $value ) ) {
1112 $obj->$key = new stdClass();
1113 $this->array_to_obj( $value, $obj->$key );
1115 if ( !empty( $key ) ) {
1116 $obj->$key = $value;
1123 public function fetch( $mode = SQLSRV_FETCH_BOTH, $object_class = 'stdClass' ) {
1124 if ( $this->mCursor >= $this->mRowCount || $this->mRowCount == 0 ) {
1128 if ( $mode == SQLSRV_FETCH_NUMERIC || $mode == SQLSRV_FETCH_BOTH ) {
1129 foreach ( $this->mRows[$this->mCursor] as $value ) {
1134 case SQLSRV_FETCH_ASSOC:
1135 $ret = $this->mRows[$this->mCursor];
1137 case SQLSRV_FETCH_NUMERIC:
1141 $o = new $object_class;
1142 $ret = $this->array_to_obj( $this->mRows[$this->mCursor], $o );
1144 case SQLSRV_FETCH_BOTH:
1146 $ret = $this->mRows[$this->mCursor] + $arrNum;
1154 public function get( $pos, $fld ) {
1155 return $this->mRows[$pos][$fld];
1158 public function numrows() {
1159 return $this->mRowCount;
1162 public function seek( $iRow ) {
1163 $this->mCursor = min( $iRow, $this->mRowCount );
1166 public function numfields() {
1167 return $this->mNumFields;
1170 public function fieldname( $nr ) {
1171 $arrKeys = array_keys( $this->mRows[0] );
1172 return $arrKeys[$nr];
1175 public function fieldtype( $nr ) {
1178 foreach ( $this->mFieldMeta as $meta ) {
1180 $intType = $meta['Type'];
1185 // http://msdn.microsoft.com/en-us/library/cc296183.aspx contains type table
1186 switch( $intType ) {
1187 case SQLSRV_SQLTYPE_BIGINT: $strType = 'bigint'; break;
1188 case SQLSRV_SQLTYPE_BINARY: $strType = 'binary'; break;
1189 case SQLSRV_SQLTYPE_BIT: $strType = 'bit'; break;
1190 case SQLSRV_SQLTYPE_CHAR: $strType = 'char'; break;
1191 case SQLSRV_SQLTYPE_DATETIME: $strType = 'datetime'; break;
1192 case SQLSRV_SQLTYPE_DECIMAL/*($precision, $scale)*/: $strType = 'decimal'; break;
1193 case SQLSRV_SQLTYPE_FLOAT: $strType = 'float'; break;
1194 case SQLSRV_SQLTYPE_IMAGE: $strType = 'image'; break;
1195 case SQLSRV_SQLTYPE_INT: $strType = 'int'; break;
1196 case SQLSRV_SQLTYPE_MONEY: $strType = 'money'; break;
1197 case SQLSRV_SQLTYPE_NCHAR/*($charCount)*/: $strType = 'nchar'; break;
1198 case SQLSRV_SQLTYPE_NUMERIC/*($precision, $scale)*/: $strType = 'numeric'; break;
1199 case SQLSRV_SQLTYPE_NVARCHAR/*($charCount)*/: $strType = 'nvarchar'; break;
1200 // case SQLSRV_SQLTYPE_NVARCHAR('max'): $strType = 'nvarchar(MAX)'; break;
1201 case SQLSRV_SQLTYPE_NTEXT: $strType = 'ntext'; break;
1202 case SQLSRV_SQLTYPE_REAL: $strType = 'real'; break;
1203 case SQLSRV_SQLTYPE_SMALLDATETIME: $strType = 'smalldatetime'; break;
1204 case SQLSRV_SQLTYPE_SMALLINT: $strType = 'smallint'; break;
1205 case SQLSRV_SQLTYPE_SMALLMONEY: $strType = 'smallmoney'; break;
1206 case SQLSRV_SQLTYPE_TEXT: $strType = 'text'; break;
1207 case SQLSRV_SQLTYPE_TIMESTAMP: $strType = 'timestamp'; break;
1208 case SQLSRV_SQLTYPE_TINYINT: $strType = 'tinyint'; break;
1209 case SQLSRV_SQLTYPE_UNIQUEIDENTIFIER: $strType = 'uniqueidentifier'; break;
1210 case SQLSRV_SQLTYPE_UDT: $strType = 'UDT'; break;
1211 case SQLSRV_SQLTYPE_VARBINARY/*($byteCount)*/: $strType = 'varbinary'; break;
1212 // case SQLSRV_SQLTYPE_VARBINARY('max'): $strType = 'varbinary(MAX)'; break;
1213 case SQLSRV_SQLTYPE_VARCHAR/*($charCount)*/: $strType = 'varchar'; break;
1214 // case SQLSRV_SQLTYPE_VARCHAR('max'): $strType = 'varchar(MAX)'; break;
1215 case SQLSRV_SQLTYPE_XML: $strType = 'xml'; break;
1216 default: $strType = $intType;
1221 public function free() {
1222 unset( $this->mRows );