Inheritance diagram for DatabaseMssql:

[legend]

Collaboration diagram for DatabaseMssql:

[legend]

Public Member Functions
	addIdentifierQuotes ( $s)

	addQuotes ( $s)

	affectedRows ()

	buildConcat ( $stringList)

	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=array())
	Build a GROUP_CONCAT or equivalent statement for a query. More...

	cascadingDeletes ()
	Returns true if this database supports (and uses) cascading deletes. More...

	cleanupTriggers ()
	Returns true if this database supports (and uses) triggers (e.g. More...

	dataSeek ( $res, $row)

	delete ( $table, $conds, $fname=__METHOD__)
	DELETE query wrapper. More...

	deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
	DELETE where the condition is a join. More...

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=array())
	Estimate rows in dataset Returns estimated count, based on SHOWPLAN_ALL output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select() More...

	fetchObject ( $res)

	fetchRow ( $res)

	fieldExists ( $table, $field, $fname=__METHOD__)
	Query whether a given column exists in the mediawiki schema. More...

	fieldInfo ( $table, $field)
	mysql_fetch_field() wrapper Returns false if the field doesn't exist More...

	fieldName ( $res, $n)

	freeResult ( $res)
	Free a result object returned by query() or select(). More...

	functionalIndexes ()
	Returns true if this database can use functional indexes. More...

	getSearchEngine ()

	getServerVersion ()

	getSoftwareLink ()

	getType ()
	Get the type of the DBMS, as it appears in $wgDBtype. More...

	implicitGroupby ()
	Returns true if this database does an implicit sort when doing GROUP BY. More...

	implicitOrderby ()
	Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More...

	indexInfo ( $table, $index, $fname=__METHOD__)
	Returns information about an index If errors are explicitly ignored, returns NULL on failure. More...

	insert ( $table, $arrToInsert, $fname=__METHOD__, $options=array())
	INSERT wrapper, inserts an array into a table. More...

	insertId ()
	This must be called after nextSequenceVal. More...

	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=array(), $selectOptions=array())
	INSERT SELECT wrapper $varMap must be an associative array of the form array( 'dest1' => 'source1', ...) Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes(). More...

	isQuotedIdentifier ( $name)

	lastErrno ()

	lastError ()

	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset This is used for query pages. More...

	LimitToTopN ( $sql)
	If there is a limit clause, parse it, strip it, and pass the remaining SQL through limitResult() with the appropriate parameters. More...

	makeList ( $a, $mode=LIST_COMMA, $binaryColumns=array())
	Makes an encoded list of strings from an array. More...

	makeSelectOptions ( $options)

	numFields ( $res)

	numRows ( $res)

	open ( $server, $user, $password, $dbName)
	Usually aborts on failure. More...

	prepareStatements ( $value=null)
	Called in the installer and updater. More...

	realTableName ( $name, $format='quoted')
	call this instead of tableName() in the updater when renaming tables More...

	realTimestamps ()
	Returns true if this database uses timestamps rather than integers. More...

	resultObject ( $result)

	scrollableCursor ( $value=null)
	Called in the installer and updater. More...

	select ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array())
	SELECT wrapper. More...

	selectDB ( $db)

	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array())
	SELECT wrapper. More...

	strencode ( $s)

	strictIPs ()
	Returns true if this database is strict about what can be put into an IP field. More...

	tableExists ( $table, $fname=__METHOD__)

	tableName ( $name, $format='quoted')

	textFieldSize ( $table, $field)

	unionSupportsOrderAndLimit ()
	Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...

	update ( $table, $values, $conds, $fname=__METHOD__, $options=array())
	UPDATE wrapper. More...

Public Member Functions inherited from DatabaseBase
	__construct ( $params=null)
	Constructor. More...

	__destruct ()
	Run a few simple sanity checks. More...

	__sleep ()
	Called by serialize. More...

	__toString ()

	aggregateValue ( $valuedata, $valuename='value')
	Return aggregated value alias. More...

	anyChar ()
	Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...

	anyString ()
	Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...

	begin ( $fname=__METHOD__)
	Begin a transaction. More...

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

	bufferResults ( $buffer=null)
	Turns buffering of SQL result sets on (true) or off (false). More...

	buildLike ()
	LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...

	clearFlag ( $flag)
	Clear a flag for this connection. More...

	clearViewsCache ()
	Reset the views process cache set by listViews() More...

	close ()
	Closes a database connection. More...

	commit ( $fname=__METHOD__, $flush='')
	Commits a transaction previously started using begin(). More...

	conditional ( $cond, $trueVal, $falseVal)
	Returns an SQL expression for a simple conditional. More...

	connectionErrorHandler ( $errno, $errstr)

	dbSchema ( $schema=null)
	Get/set the db schema. More...

	deadlockLoop ()
	Perform a deadlock-prone transaction. More...

	debug ( $debug=null)
	Boolean, controls output of large amounts of debug information. More...

	decodeBlob ( $b)
	Some DBMSs return a special placeholder object representing blob fields in result objects. More...

	decodeExpiry ( $expiry, $format=TS_MW)
	Decode an expiry time into a DBMS independent format. More...

	doneWrites ()
	Returns true if the connection may have been used for write queries. More...

	dropTable ( $tableName, $fName=__METHOD__)
	Delete a table. More...

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
	Creates a new table with structure copied from existing table Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. More...

	encodeBlob ( $b)
	Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...

	encodeExpiry ( $expiry)
	Encode an expiry time into the DBMS dependent format. More...

	endAtomic ( $fname=__METHOD__)
	Ends an atomic section of SQL statements. More...

	errorCount ( $count=null)
	Get/set the number of errors logged. More...

	execute ( $prepared, $args=null)
	Execute a prepared query with the various arguments. More...

	fieldNamesWithAlias ( $fields)
	Gets an array of aliased field names. More...

	fieldNameWithAlias ( $name, $alias=false)
	Get an aliased field name e.g. More...

	fillPrepared ( $preparedQuery, $args)
	For faking prepared SQL statements on DBs that don't support it directly. More...

	getDBname ()
	Get the current DB name. More...

	getDelimiter ()

	getFlag ( $flag)
	Returns a boolean whether the flag $flag is set for this connection. More...

	getInfinity ()
	Find out when 'infinity' is. More...

	getLag ()
	Get slave lag. More...

	getLBInfo ( $name=null)
	Get properties passed down from the server info array of the load balancer. More...

	getMasterPos ()
	Get the position of this master. More...

	getProperty ( $name)
	General read-only accessor. More...

	getSchemaPath ()
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...

	getServer ()
	Get the server hostname or IP address. More...

	getServerInfo ()
	A string describing the current software version, and possibly other details in a user-friendly way. More...

	getServerUptime ()
	Determines how long the server has been up STUB. More...

	getSlavePos ()
	Get the replication position of this slave. More...

	getWikiID ()

	ignoreErrors ( $ignoreErrors=null)
	Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...

	indexExists ( $table, $index, $fname=__METHOD__)
	Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More...

	indexUnique ( $table, $index)
	Determines if a given index is unique. More...

	isOpen ()
	Is a connection to the database open? More...

	isView ( $name)
	Differentiates between a TABLE and a VIEW. More...

	isWriteQuery ( $sql)
	Determine whether a query writes to the DB. More...

	lastQuery ()
	Return the last query that went through DatabaseBase::query() More...

	listTables ( $prefix=null, $fname=__METHOD__)
	List all tables on the database. More...

	listViews ( $prefix=null, $fname=__METHOD__)
	Lists all the VIEWs in the database. More...

	lock ( $lockName, $method, $timeout=5)
	Acquire a named lock. More...

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available. More...

	lockTables ( $read, $write, $method, $lowPriority=true)
	Lock specific tables. More...

	lowPriorityOption ()
	A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More...

	makeGroupByWithHaving ( $options)
	Returns an optional GROUP BY with an optional HAVING. More...

	makeList ( $a, $mode=LIST_COMMA)
	Makes an encoded list of strings from an array. More...

	makeOrderBy ( $options)
	Returns an optional ORDER BY. More...

	makeWhereFrom2d ( $data, $baseKey, $subKey)
	Build a partial where clause from a 2-d array such as used for LinkBatch. More...

	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the slave to catch up to a given master position. More...

	maxListLen ()
	Return the maximum number of items allowed in a list, or 0 for unlimited. More...

	nextSequenceValue ( $seqName)
	Returns an appropriately quoted sequence value for inserting a new row. More...

	onTransactionIdle ( $callback)
	Run an anonymous function as soon as there is no transaction pending. More...

	onTransactionPreCommitOrIdle ( $callback)
	Run an anonymous function before the current transaction commits or now if there is none. More...

	patchPath ( $patch)
	Get the full path of a patch file. More...

	ping ()
	Ping the server and try to reconnect if it there is no connection. More...

	query ( $sql, $fname=__METHOD__, $tempIgnore=false)
	Run an SQL query and return the result. More...

	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
	REPLACE query wrapper. More...

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
	Report a query error. More...

	rollback ( $fname=__METHOD__, $flush='')
	Rollback a transaction previously started using begin(). More...

	searchableIPs ()
	Returns true if this database can do a native search on IP columns e.g. More...

	selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=array())
	A SELECT wrapper which returns a single field from a single result row. More...

	selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=array(), $join_conds=array())
	Single row SELECT wrapper. More...

	setBigSelects ( $value=true)
	Allow or deny "big selects" for this session only. More...

	setFakeMaster ( $enabled=true)
	Make this connection a fake master. More...

	setFakeSlaveLag ( $lag)
	Set lag time in seconds for a fake slave. More...

	setFileHandle ( $fh)
	Set the filehandle to copy write statements to. More...

	setFlag ( $flag)
	Set a flag for this connection. More...

	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it. More...

	setSchemaVars ( $vars)
	Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...

	setSessionOptions (array $options)
	Override database's default behavior. More...

	sourceFile ( $filename, $lineCallback=false, $resultCallback=false, $fname=false, $inputCallback=false)
	Read and execute SQL commands from a file. More...

	sourceStream ( $fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
	Read and execute commands from an open file handle. More...

	startAtomic ( $fname=__METHOD__)
	Begin an atomic section of statements. More...

	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end. More...

	strreplace ( $orig, $old, $new)
	Returns a comand for str_replace function in SQL query. More...

	tableNames ()
	Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...

	tableNamesN ()
	Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...

	tableNamesWithAlias ( $tables)
	Gets an array of aliased table names. More...

	tableNameWithAlias ( $name, $alias=false)
	Get an aliased table name e.g. More...

	tablePrefix ( $prefix=null)
	Get/set the table prefix. More...

	timestamp ( $ts=0)
	Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...

	timestampOrNull ( $ts=null)
	Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...

	trxLevel ()
	Gets the current transaction level. More...

	unionQueries ( $sqls, $all)
	Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...

	unlock ( $lockName, $method)
	Release a lock. More...

	unlockTables ( $method)
	Unlock specific tables. More...

	upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...

	useIndexClause ( $index)
	USE INDEX clause. More...

	wasDeadlock ()
	Determines if the last failure was due to a deadlock STUB. More...

	wasErrorReissuable ()
	Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query. More...

	wasLockTimeout ()
	Determines if the last failure was due to a lock timeout STUB. More...

	wasReadOnlyError ()
	Determines if the last failure was due to the database being read-only. More...

	writesOrCallbacksPending ()
	Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...

Protected Member Functions
	closeConnection ()
	Closes a database connection, if it is open Returns success, true if already closed. More...

	doBegin ( $fname=__METHOD__)
	Begin a transaction, committing any previously open transaction. More...

	doCommit ( $fname=__METHOD__)
	End a transaction. More...

	doQuery ( $sql)

	doRollback ( $fname=__METHOD__)
	Rollback a transaction. More...

Protected Member Functions inherited from DatabaseBase
	escapeLikeInternal ( $s)

	fillPreparedArg ( $matches)
	preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More...

	freePrepared ( $prepared)
	Free a prepared query, generated by prepare(). More...

	getDefaultSchemaVars ()
	Get schema variables to use if none have been set via setSchemaVars(). More...

	getSchemaVars ()
	Get schema variables. More...

	indexName ( $index)
	Get the name of an index in a given table. More...

	indexNameCallback ( $matches)
	Index name callback. More...

	installErrorHandler ()

	makeInsertOptions ( $options)
	Helper for DatabaseBase::insert(). More...

	makeUpdateOptions ( $options)
	Make UPDATE options for the DatabaseBase::update function. More...

	makeUpdateOptionsArray ( $options)
	Make UPDATE options array for DatabaseBase::makeUpdateOptions. More...

	nativeReplace ( $table, $rows, $fname)
	REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...

	prepare ( $sql, $func='DatabaseBase::prepare')
	Intended to be compatible with the PEAR::DB wrapper functions. More...

	replaceSchemaVars ( $ins)
	Database independent variable replacement. More...

	replaceVars ( $ins)
	Replace variables in sourced SQL. More...

	restoreErrorHandler ()

	runOnTransactionIdleCallbacks ()
	Actually any "on transaction idle" callbacks. More...

	runOnTransactionPreCommitCallbacks ()
	Actually any "on transaction pre-commit" callbacks. More...

	tableNameCallback ( $matches)
	Table name callback. More...

	tableNamesWithUseIndexOrJOIN ( $tables, $use_index=array(), $join_conds=array())
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More...

Protected Attributes
	$mAffectedRows = null

	$mBinaryColumnCache = null

	$mBitColumnCache = null

	$mIgnoreDupKeyErrors = false

	$mInsertId = null

	$mLastResult = null

	$mPort

	$mPrepareStatements = true

	$mScrollableCursor = true

	$mSubqueryId = 0

Protected Attributes inherited from DatabaseBase
string[]	$allViews = null

	$delimiter = ';'

resource	$fileHandle = null

	$htmlErrors

resource	$mConn = null
	Database connection *. More...

	$mDefaultBigSelects = null

	$mDoneWrites = false

	$mErrorCount = 0

	$mFlags

	$mForeign

	$mLastQuery = ''

	$mLBInfo = array()

	$mOpened = false

	$mPHPError = false

	$mSchema

	$mSchemaVars = false

	$mServer

	$mTablePrefix

callable[]	$mTrxIdleCallbacks = array()

int	$mTrxLevel = 0
	Either 1 if a transaction is active or 0 otherwise. More...

callable[]	$mTrxPreCommitCallbacks = array()

	$preparedArgs

Private Member Functions
	escapeIdentifier ( $identifier)
	Escapes a identifier for use inm SQL. More...

	formatError ( $err)

	getBinaryColumns ( $table)
	Returns an associative array for fields that are of type varbinary, binary, or image $table can be either a raw table name or passed through tableName() first. More...

	getBitColumns ( $table)

	populateColumnCaches ()
	@void More...

Additional Inherited Members
Static Public Member Functions inherited from DatabaseBase
static	factory ( $dbType, $p=array())
	Given a DB type, construct the name of the appropriate child class of DatabaseBase. More...

static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers. More...

Public Attributes inherited from DatabaseBase
	$mDBname

	$mPassword

	$mUser

const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry. More...

const	DEADLOCK_DELAY_MIN = 500000
	Minimum time to wait before retry, in microseconds. More...

const	DEADLOCK_TRIES = 4
	Number of times to re-try an operation in case of deadlock. More...

Detailed Description

Definition at line 31 of file DatabaseMssql.php.

Member Function Documentation

◆ addIdentifierQuotes()

DatabaseMssql::addIdentifierQuotes ( $s )

Parameters

string $s

Returns: string

Reimplemented from DatabaseBase.

Definition at line 1147 of file DatabaseMssql.php.

References $s.

◆ addQuotes()

DatabaseMssql::addQuotes ( $s )

Parameters

string $s

Returns: string

Reimplemented from DatabaseBase.

Definition at line 1127 of file DatabaseMssql.php.

References $blob, and $s.

Referenced by insert(), and makeList().

◆ affectedRows()

DatabaseMssql::affectedRows ( )

Returns: int

Implements DatabaseType.

Definition at line 364 of file DatabaseMssql.php.

References $mAffectedRows.

◆ buildConcat()

DatabaseMssql::buildConcat ( $stringList )

Parameters

array $stringList

Returns: string

Reimplemented from DatabaseBase.

Definition at line 1219 of file DatabaseMssql.php.

◆ buildGroupConcatField()

DatabaseMssql::buildGroupConcatField	(	$delim,
		$table,
		$field,
		$conds = `''`,
		$join_conds = `array()`
	)

Build a GROUP_CONCAT or equivalent statement for a query.

MS SQL doesn't have GROUP_CONCAT so we emulate it with other stuff (and boy is it nasty)

This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters

string	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: String SQL text

Since: 1.23

Reimplemented from DatabaseBase.

Definition at line 1240 of file DatabaseMssql.php.

References $mSubqueryId, array(), and selectSQLText().

◆ cascadingDeletes()

DatabaseMssql::cascadingDeletes ( )

Returns true if this database supports (and uses) cascading deletes.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 44 of file DatabaseMssql.php.

◆ cleanupTriggers()

DatabaseMssql::cleanupTriggers ( )

Returns true if this database supports (and uses) triggers (e.g.

on the page table)

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 48 of file DatabaseMssql.php.

◆ closeConnection()

DatabaseMssql::closeConnection ( )

protected

Closes a database connection, if it is open Returns success, true if already closed.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 140 of file DatabaseMssql.php.

◆ dataSeek()

DatabaseMssql::dataSeek	(	$res,
		$row
	)

Parameters

MssqlResultWrapper	$res
int	$row

Returns: bool

Implements DatabaseType.

Definition at line 321 of file DatabaseMssql.php.

References $res.

◆ delete()

DatabaseMssql::delete	(	$table,
		$conds,
		$fname = `__METHOD__`
	)

DELETE query wrapper.

Parameters

array	$table	Table name
string \| array	$conds	of conditions. See $conds in DatabaseBase::select() for the format. Use $conds == "*" to delete all rows
string	$fname	name of the calling function

Exceptions

DBUnexpectedError

Returns: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 482 of file DatabaseMssql.php.

References $e, and $fname.

◆ deleteJoin()

DatabaseMssql::deleteJoin	(	$delTable,
		$joinTable,
		$delVar,
		$joinVar,
		$conds,
		$fname = `__METHOD__`
	)

DELETE where the condition is a join.

MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selects

For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds='*'.

DO NOT put the join condition in $conds.

Parameters

string	$delTable	The table to delete from.
string	$joinTable	The other table.
string	$delVar	The variable to join on, in the first table.
string	$joinVar	The variable to join on, in the second table.
array	$conds	Condition array of field names mapped to variables, ANDed together in the WHERE clause
string	$fname	Calling function name (use METHOD) for logs/profiling

Exceptions

DBUnexpectedError

Reimplemented from DatabaseBase.

Definition at line 469 of file DatabaseMssql.php.

References $e, and $fname.

◆ doBegin()

DatabaseMssql::doBegin ( $fname = __METHOD__ )

protected

Begin a transaction, committing any previously open transaction.

Reimplemented from DatabaseBase.

Definition at line 1067 of file DatabaseMssql.php.

◆ doCommit()

DatabaseMssql::doCommit ( $fname = __METHOD__ )

protected

End a transaction.

Reimplemented from DatabaseBase.

Definition at line 1075 of file DatabaseMssql.php.

◆ doQuery()

DatabaseMssql::doQuery ( $sql )

protected

Parameters

string $sql

Returns: bool|MssqlResult

Exceptions

DBUnexpectedError

Reimplemented from DatabaseBase.

Definition at line 166 of file DatabaseMssql.php.

References $matches, $success, array(), as, DatabaseBase\debug(), LimitToTopN(), and wfDebug().

Referenced by insert().

◆ doRollback()

DatabaseMssql::doRollback ( $fname = __METHOD__ )

protected

Rollback a transaction.

No-op on non-transactional databases.

Reimplemented from DatabaseBase.

Definition at line 1084 of file DatabaseMssql.php.

◆ escapeIdentifier()

DatabaseMssql::escapeIdentifier ( $identifier )

private

Escapes a identifier for use inm SQL.

Throws an exception if it is invalid. Reference: http://msdn.microsoft.com/en-us/library/aa224033%28v=SQL.80%29.aspx

Parameters

string $identifier

Exceptions

MWException

Returns: string

Definition at line 1097 of file DatabaseMssql.php.

◆ estimateRowCount()

DatabaseMssql::estimateRowCount	(	$table,
		$vars = `'*'`,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `array()`
	)

Estimate rows in dataset Returns estimated count, based on SHOWPLAN_ALL output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select()

Parameters

string	$table
string	$vars
string	$conds
string	$fname
array	$options

Returns: int

Reimplemented from DatabaseBase.

Definition at line 506 of file DatabaseMssql.php.

References $fname, $options, $res, $vars, fetchRow(), and select().

◆ fetchObject()

DatabaseMssql::fetchObject ( $res )

Parameters

MssqlResultWrapper $res

Returns: stdClass

Implements DatabaseType.

Definition at line 257 of file DatabaseMssql.php.

References $res.

◆ fetchRow()

DatabaseMssql::fetchRow ( $res )

Parameters

MssqlResultWrapper $res

Returns: array

Implements DatabaseType.

Definition at line 266 of file DatabaseMssql.php.

References $res.

Referenced by estimateRowCount(), and textFieldSize().

◆ fieldExists()

DatabaseMssql::fieldExists	(	$table,
		$field,
		$fname = `__METHOD__`
	)

Query whether a given column exists in the mediawiki schema.

Parameters

string	$table
string	$field
string	$fname

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 1025 of file DatabaseMssql.php.

References $res, list, DatabaseBase\query(), tableName(), and wfDebug().

◆ fieldInfo()

DatabaseMssql::fieldInfo	(	$table,
		$field
	)

mysql_fetch_field() wrapper Returns false if the field doesn't exist

Parameters

string	$table	Table name
string	$field	Field name

Returns: Field

Implements DatabaseType.

Definition at line 1044 of file DatabaseMssql.php.

References $res, list, DatabaseBase\query(), tableName(), and wfDebug().

◆ fieldName()

DatabaseMssql::fieldName	(	$res,
		$n
	)

Parameters

mixed	$res
int	$n

Returns: int

Implements DatabaseType.

Definition at line 299 of file DatabaseMssql.php.

References $n, and $res.

◆ formatError()

DatabaseMssql::formatError ( $err )

private

Returns: string

Definition at line 345 of file DatabaseMssql.php.

Referenced by lastError().

◆ freeResult()

DatabaseMssql::freeResult ( $res )

Free a result object returned by query() or select().

It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.

Parameters

mixed $res A SQL result

Reimplemented from DatabaseBase.

Definition at line 245 of file DatabaseMssql.php.

References $res.

◆ functionalIndexes()

DatabaseMssql::functionalIndexes ( )

Returns true if this database can use functional indexes.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 68 of file DatabaseMssql.php.

◆ getBinaryColumns()

DatabaseMssql::getBinaryColumns ( $table )

private

Returns an associative array for fields that are of type varbinary, binary, or image $table can be either a raw table name or passed through tableName() first.

Parameters

string $table

Returns: array

Definition at line 1268 of file DatabaseMssql.php.

References array(), and populateColumnCaches().

Referenced by insert(), and update().

◆ getBitColumns()

DatabaseMssql::getBitColumns ( $table )

private

Parameters

string $table

Returns: array

Definition at line 1285 of file DatabaseMssql.php.

References array(), and populateColumnCaches().

Referenced by selectSQLText().

◆ getSearchEngine()

DatabaseMssql::getSearchEngine ( )

Returns: string

Reimplemented from DatabaseBase.

Definition at line 1258 of file DatabaseMssql.php.

◆ getServerVersion()

DatabaseMssql::getServerVersion ( )

Returns: string Version information from the database

Implements DatabaseType.

Definition at line 983 of file DatabaseMssql.php.

References $version.

◆ getSoftwareLink()

DatabaseMssql::getSoftwareLink ( )

Returns: string Wikitext of a link to the server software's web site

Implements DatabaseType.

Definition at line 976 of file DatabaseMssql.php.

◆ getType()

DatabaseMssql::getType ( )

Get the type of the DBMS, as it appears in $wgDBtype.

Returns: string

Implements DatabaseType.

Definition at line 1211 of file DatabaseMssql.php.

◆ implicitGroupby()

DatabaseMssql::implicitGroupby ( )

Returns true if this database does an implicit sort when doing GROUP BY.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 60 of file DatabaseMssql.php.

◆ implicitOrderby()

DatabaseMssql::implicitOrderby ( )

Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 64 of file DatabaseMssql.php.

◆ indexInfo()

DatabaseMssql::indexInfo	(	$table,
		$index,
		$fname = `__METHOD__`
	)

Returns information about an index If errors are explicitly ignored, returns NULL on failure.

Parameters

string	$table
string	$index
string	$fname

Returns: array|bool|null

Implements DatabaseType.

Definition at line 534 of file DatabaseMssql.php.

References $fname, $res, array(), as, false, and DatabaseBase\query().

◆ insert()

DatabaseMssql::insert	(	$table,
		$arrToInsert,
		$fname = `__METHOD__`,
		$options = `array()`
	)

INSERT wrapper, inserts an array into a table.

$arrToInsert may be a single associative array, or an array of these with numeric keys, for multi-row insert.

Usually aborts on failure If errors are explicitly ignored, returns success

Parameters

string	$table
array	$arrToInsert
string	$fname
array	$options

Exceptions

DBQueryError

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 581 of file DatabaseMssql.php.

References $e, $keys, $options, $res, $ret, $value, addQuotes(), array(), as, doQuery(), getBinaryColumns(), DatabaseBase\query(), and tableName().

◆ insertId()

DatabaseMssql::insertId ( )

This must be called after nextSequenceVal.

Returns: int|null

Implements DatabaseType.

Definition at line 312 of file DatabaseMssql.php.

References $mInsertId.

◆ insertSelect()

DatabaseMssql::insertSelect	(	$destTable,
		$srcTable,
		$varMap,
		$conds,
		$fname = `__METHOD__`,
		$insertOptions = `array()`,
		$selectOptions = `array()`
	)

INSERT SELECT wrapper $varMap must be an associative array of the form array( 'dest1' => 'source1', ...) Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes().

Parameters

string	$destTable
array \| string	$srcTable	May be an array of tables.
array	$varMap
array	$conds	May be "*" to copy the whole table.
string	$fname
array	$insertOptions
array	$selectOptions

Exceptions

DBQueryError

Returns: null|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 720 of file DatabaseMssql.php.

References $e, $fname, and $ret.

◆ isQuotedIdentifier()

DatabaseMssql::isQuotedIdentifier ( $name )

Parameters

string $name

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 1156 of file DatabaseMssql.php.

References $name.

◆ lastErrno()

DatabaseMssql::lastErrno ( )

Returns: string

Implements DatabaseType.

Definition at line 352 of file DatabaseMssql.php.

◆ lastError()

DatabaseMssql::lastError ( )

Returns: string

Implements DatabaseType.

Definition at line 328 of file DatabaseMssql.php.

References as, and formatError().

Referenced by open().

◆ limitResult()

DatabaseMssql::limitResult	(	$sql,
		$limit,
		$offset = `false`
	)

Construct a LIMIT query with optional offset This is used for query pages.

Parameters

string	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
bool \| int	$offset	The SQL offset (default false)

Returns: array|string

Reimplemented from DatabaseBase.

Definition at line 898 of file DatabaseMssql.php.

References $last, $limit, $mSubqueryId, and array().

Referenced by LimitToTopN().

◆ LimitToTopN()

DatabaseMssql::LimitToTopN ( $sql )

If there is a limit clause, parse it, strip it, and pass the remaining SQL through limitResult() with the appropriate parameters.

Not the prettiest solution, but better than building a whole new parser. This exists becase there are still too many extensions that don't use dynamic sql generation.

Parameters

string $sql

Returns: array|mixed|string

Definition at line 953 of file DatabaseMssql.php.

References $matches, and limitResult().

Referenced by doQuery().

◆ makeList()

DatabaseMssql::makeList	(	$a,
		$mode = `LIST_COMMA`,
		$binaryColumns = `array()`
	)

Makes an encoded list of strings from an array.

Parameters

array	$a	containing the data
int	$mode	Constant LIST_COMMA: comma separated, no field names LIST_AND: ANDed WHERE clause (without the WHERE). See the documentation for $conds in DatabaseBase::select(). LIST_OR: ORed WHERE clause (without the WHERE) LIST_SET: comma separated with field names, like a SET clause LIST_NAMES: comma separated field names
array	$binaryColumns	Contains a list of column names that are binary types This is a custom parameter only present for MS SQL.

Exceptions

MWException|DBUnexpectedError

Returns: string

Definition at line 804 of file DatabaseMssql.php.

References $value, addQuotes(), as, LIST_AND, LIST_NAMES, LIST_OR, and LIST_SET.

Referenced by update().

◆ makeSelectOptions()

DatabaseMssql::makeSelectOptions ( $options )

Parameters

array $options an associative array of options to be turned into an SQL query, valid keys are listed in the function.

Returns: array

Reimplemented from DatabaseBase.

Definition at line 1179 of file DatabaseMssql.php.

References $options, array(), as, DatabaseBase\makeGroupByWithHaving(), and DatabaseBase\makeOrderBy().

◆ numFields()

DatabaseMssql::numFields ( $res )

Parameters

mixed $res

Returns: int

Implements DatabaseType.

Definition at line 286 of file DatabaseMssql.php.

References $res.

◆ numRows()

DatabaseMssql::numRows ( $res )

Parameters

mixed $res

Returns: int

Implements DatabaseType.

Definition at line 274 of file DatabaseMssql.php.

References $res.

◆ open()

DatabaseMssql::open	(	$server,
		$user,
		$password,
		$dbName
	)

Usually aborts on failure.

Parameters

string	$server
string	$user
string	$password
string	$dbName

Exceptions

DBConnectionError

Returns: bool|DatabaseBase|null

Implements DatabaseType.

Definition at line 85 of file DatabaseMssql.php.

References DatabaseBase\$mConn, $password, $user, array(), DatabaseBase\close(), global, lastError(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ populateColumnCaches()

DatabaseMssql::populateColumnCaches ( )

private

@void

Definition at line 1301 of file DatabaseMssql.php.

References $res, array(), as, and select().

Referenced by getBinaryColumns(), and getBitColumns().

◆ prepareStatements()

DatabaseMssql::prepareStatements ( $value = null )

Called in the installer and updater.

Probably doesn't need to be called anywhere else in the codebase.

Parameters

bool | null $value

Returns: bool|null

Definition at line 1360 of file DatabaseMssql.php.

References $value, and wfSetVar().

◆ realTableName()

DatabaseMssql::realTableName	(	$name,
		$format = `'quoted'`
	)

call this instead of tableName() in the updater when renaming tables

Parameters

string	$name
string	$format	One of quoted, raw, or split

Returns: string

Definition at line 1341 of file DatabaseMssql.php.

References $name, and tableName().

Referenced by tableName().

◆ realTimestamps()

DatabaseMssql::realTimestamps ( )

Returns true if this database uses timestamps rather than integers.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 56 of file DatabaseMssql.php.

◆ resultObject()

DatabaseMssql::resultObject ( $result )

Parameters

bool | MssqlResultWrapper | resource $result

Returns: bool|MssqlResultWrapper

Reimplemented from DatabaseBase.

Definition at line 148 of file DatabaseMssql.php.

◆ scrollableCursor()

DatabaseMssql::scrollableCursor ( $value = null )

Called in the installer and updater.

Probably doesn't need to be called anywhere else in the codebase.

Parameters

bool | null $value

Returns: bool|null

Definition at line 1370 of file DatabaseMssql.php.

References $value, and wfSetVar().

◆ select()

DatabaseMssql::select	(	$table,
		$vars,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `array()`,
		$join_conds = `array()`
	)

SELECT wrapper.

Parameters

mixed	$table	Array or string, table name(s) (prefix auto-added)
mixed	$vars	Array or string, field name(s) to be retrieved
mixed	$conds	Array or string, condition(s) for WHERE
string	$fname	Calling function name (use METHOD) for logs/profiling
array	$options	Associative array of options (e.g. array('GROUP BY' => 'page_title')), see Database::makeSelectOptions code for list of supported stuff
array	$join_conds	Associative array of table join conditions (optional) (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )

Returns: mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure

Reimplemented from DatabaseBase.

Definition at line 383 of file DatabaseMssql.php.

References $fname, $options, $ret, $vars, DatabaseBase\query(), and selectSQLText().

Referenced by estimateRowCount(), and populateColumnCaches().

◆ selectDB()

DatabaseMssql::selectDB ( $db )

Parameters

string $db

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 1164 of file DatabaseMssql.php.

References $e, and DatabaseBase\query().

◆ selectSQLText()

DatabaseMssql::selectSQLText	(	$table,
		$vars,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `array()`,
		$join_conds = `array()`
	)

SELECT wrapper.

Parameters

mixed	$table	Array or string, table name(s) (prefix auto-added)
mixed	$vars	Array or string, field name(s) to be retrieved
mixed	$conds	Array or string, condition(s) for WHERE
string	$fname	Calling function name (use METHOD) for logs/profiling
array	$options	Associative array of options (e.g. array('GROUP BY' => 'page_title')), see Database::makeSelectOptions code for list of supported stuff
array	$join_conds	Associative array of table join conditions (optional) (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )

Returns: string The SQL text

Reimplemented from DatabaseBase.

Definition at line 437 of file DatabaseMssql.php.

References $fname, $options, $t, $vars, array(), as, getBitColumns(), and tableName().

Referenced by buildGroupConcatField(), and select().

◆ strencode()

DatabaseMssql::strencode ( $s )

Parameters

string $s

Returns: string

Implements DatabaseType.

Definition at line 1119 of file DatabaseMssql.php.

References $s.

◆ strictIPs()

DatabaseMssql::strictIPs ( )

Returns true if this database is strict about what can be put into an IP field.

Specifically, it uses a NULL value instead of an empty string.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 52 of file DatabaseMssql.php.

◆ tableExists()

DatabaseMssql::tableExists	(	$table,
		$fname = `__METHOD__`
	)

Parameters

string	$table
string	$fname

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 998 of file DatabaseMssql.php.

References $res, list, DatabaseBase\query(), tableName(), and wfDebug().

◆ tableName()

DatabaseMssql::tableName	(	$name,
		$format = `'quoted'`
	)

Parameters

string	$name
string	$format

Returns: string

Reimplemented from DatabaseBase.

Definition at line 1325 of file DatabaseMssql.php.

References $name, and realTableName().

Referenced by fieldExists(), fieldInfo(), insert(), selectSQLText(), tableExists(), textFieldSize(), and update().

◆ textFieldSize()

DatabaseMssql::textFieldSize	(	$table,
		$field
	)

Parameters

string	$table
string	$field

Returns: int Returns the size of a text field, or -1 for "unlimited"

Reimplemented from DatabaseBase.

Definition at line 875 of file DatabaseMssql.php.

References $res, $size, fetchRow(), DatabaseBase\query(), and tableName().

◆ unionSupportsOrderAndLimit()

DatabaseMssql::unionSupportsOrderAndLimit ( )

Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.

Returns: Boolean

Reimplemented from DatabaseBase.

Definition at line 72 of file DatabaseMssql.php.

◆ update()

DatabaseMssql::update	(	$table,
		$values,
		$conds,
		$fname = `__METHOD__`,
		$options = `array()`
	)

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters

string	$table	name of the table to UPDATE. This will be passed through DatabaseBase::tableName().
array	$values	An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by DatabaseBase::addQuotes().
array	$conds	An array of conditions (WHERE). See DatabaseBase::select() for the details of the format of condition arrays. Use '*' to update all rows.
string	$fname	The function name of the caller (from METHOD), for logging and profiling.
array	$options	An array of UPDATE options, can be: IGNORE: Ignore unique key conflicts LOW_PRIORITY: MySQL-specific, see MySQL manual.

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 766 of file DatabaseMssql.php.

References $e, $options, $ret, array(), getBinaryColumns(), LIST_AND, LIST_SET, makeList(), DatabaseBase\makeUpdateOptions(), DatabaseBase\query(), and tableName().

Member Data Documentation

◆ $mAffectedRows

DatabaseMssql::$mAffectedRows = null

protected

Definition at line 34 of file DatabaseMssql.php.

Referenced by affectedRows().

◆ $mBinaryColumnCache

DatabaseMssql::$mBinaryColumnCache = null

protected

Definition at line 38 of file DatabaseMssql.php.

◆ $mBitColumnCache

DatabaseMssql::$mBitColumnCache = null

protected

Definition at line 39 of file DatabaseMssql.php.

◆ $mIgnoreDupKeyErrors

DatabaseMssql::$mIgnoreDupKeyErrors = false

protected

Definition at line 40 of file DatabaseMssql.php.

◆ $mInsertId

DatabaseMssql::$mInsertId = null

protected

Definition at line 32 of file DatabaseMssql.php.

Referenced by insertId().

◆ $mLastResult

DatabaseMssql::$mLastResult = null

protected

Definition at line 33 of file DatabaseMssql.php.

◆ $mPort

DatabaseMssql::$mPort

protected

Definition at line 42 of file DatabaseMssql.php.

◆ $mPrepareStatements

DatabaseMssql::$mPrepareStatements = true

protected

Definition at line 37 of file DatabaseMssql.php.

◆ $mScrollableCursor

DatabaseMssql::$mScrollableCursor = true

protected

Definition at line 36 of file DatabaseMssql.php.

◆ $mSubqueryId

DatabaseMssql::$mSubqueryId = 0

protected

Definition at line 35 of file DatabaseMssql.php.

Referenced by buildGroupConcatField(), and limitResult().

The documentation for this class was generated from the following file:

includes/db/DatabaseMssql.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addIdentifierQuotes()

◆ addQuotes()

◆ affectedRows()

◆ buildConcat()

◆ buildGroupConcatField()

◆ cascadingDeletes()

◆ cleanupTriggers()

◆ closeConnection()

◆ dataSeek()

◆ delete()

◆ deleteJoin()

◆ doBegin()

◆ doCommit()

◆ doQuery()

◆ doRollback()

◆ escapeIdentifier()

◆ estimateRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldExists()

◆ fieldInfo()

◆ fieldName()

◆ formatError()

◆ freeResult()

◆ functionalIndexes()

◆ getBinaryColumns()

◆ getBitColumns()

◆ getSearchEngine()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ implicitGroupby()

◆ implicitOrderby()

◆ indexInfo()

◆ insert()

◆ insertId()

◆ insertSelect()

◆ isQuotedIdentifier()

◆ lastErrno()

◆ lastError()

◆ limitResult()

◆ LimitToTopN()

◆ makeList()

◆ makeSelectOptions()

◆ numFields()

◆ numRows()

◆ open()

◆ populateColumnCaches()

◆ prepareStatements()

◆ realTableName()

◆ realTimestamps()

◆ resultObject()

◆ scrollableCursor()

◆ select()

◆ selectDB()

◆ selectSQLText()

◆ strencode()

◆ strictIPs()

◆ tableExists()

◆ tableName()

◆ textFieldSize()

◆ unionSupportsOrderAndLimit()

◆ update()

Member Data Documentation

◆ $mAffectedRows

◆ $mBinaryColumnCache

◆ $mBitColumnCache

◆ $mIgnoreDupKeyErrors

◆ $mInsertId

◆ $mLastResult

◆ $mPort

◆ $mPrepareStatements

◆ $mScrollableCursor