Inheritance diagram for Wikimedia\Rdbms\DatabaseMssql:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabaseMssql:

[legend]

Public Member Functions
	__construct (array $params)

	addIdentifierQuotes ( $s)

	addQuotes ( $s)

	buildConcat ( $stringList)

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

	buildSubstring ( $input, $startPosition, $length=null)

	dataSeek ( $res, $row)

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

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

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

	estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	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()

	fetchObject ( $res)

	fetchRow ( $res)

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

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

	fieldName ( $res, $n)

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

	getServerVersion ()

	getSoftwareLink ()

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

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

	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.

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

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

	insertId ()
	This must be called after nextSequenceVal.

	isQuotedIdentifier ( $name)

	lastErrno ()

	lastError ()

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

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

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

	makeSelectOptions ( $options)

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

	numFields ( $res)

	numRows ( $res)

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

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

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

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

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

	selectDB ( $db)

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

	strencode ( $s)

	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.

	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	UPDATE wrapper.

Public Member Functions inherited from Wikimedia\Rdbms\Database
	__clone ()
	Make sure that copies do not share the same client binding handle.

	__destruct ()
	Run a few simple sanity checks and close dangling connections.

	__sleep ()
	Called by serialize.

	__toString ()

	affectedRows ()
	Get the number of rows affected by the last write query.

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

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

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

	begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
	Begin a transaction.

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

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

	buildIntegerCast ( $field)

	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().

	buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.

	buildStringCast ( $field)

	cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
	Cancel an atomic section of SQL statements.

	clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Clear a flag for this connection.

	close ()
	Close the database connection.

	commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	Commits a transaction previously started using begin().

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

	connectionErrorLogger ( $errno, $errstr)
	Error handler for logging errors during database connection This method should not be used outside of Database classes.

	databasesAreIndependent ()
	Returns true if DBs are assumed to be on potentially different servers.

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

	deadlockLoop ()
	Perform a deadlock-prone transaction.

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

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

	doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Perform an atomic section of reversable SQL statements from a callback.

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

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
	Creates a new table with structure copied from existing table.

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

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

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

	explicitTrxActive ()

	flushSnapshot ( $fname=__METHOD__)
	Commit any transaction but error out if writes or callbacks are pending.

	getDBname ()
	Get the current DB name.

	getDomainID ()

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

	getInfinity ()
	Find out when 'infinity' is.

	getLag ()
	Get the amount of replication lag for this database server.

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

	getMasterPos ()
	Get the position of this master.

	getProperty ( $name)

	getReplicaPos ()
	Get the replication position of this replica DB.

	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

	getServer ()
	Get the server hostname or IP address.

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

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

	getSessionLagStatus ()
	Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.

	getWikiID ()
	Alias for getDomainID()

	ignoreIndexClause ( $index)
	IGNORE INDEX clause.

	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.

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

	initConnection ()
	Initialize the connection to the database over the wire (or to local files)

	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	INSERT SELECT wrapper.

	isOpen ()
	Is a connection to the database open?

	isReadOnly ()

	lastDoneWrites ()
	Returns the last time the connection may have been used for write queries.

	lastQuery ()
	Return the last query that went through IDatabase::query()

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

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

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

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is not locked by any thread (non-blocking)

	lockTables (array $read, array $write, $method)
	Lock specific tables.

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

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

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

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

	namedLocksEnqueue ()
	Check to see if a named lock used by lock() use blocking queues.

	nextSequenceValue ( $seqName)
	Deprecated method, calls should be removed.

	onTransactionIdle (callable $callback, $fname=__METHOD__)
	Run a callback as soon as there is no transaction pending.

	onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback before the current transaction commits or now if there is none.

	onTransactionResolution (callable $callback, $fname=__METHOD__)
	Run a callback as soon as the current transaction commits or rolls back.

	pendingWriteCallers ()
	Get the list of method names that did write queries for this transaction.

	pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
	Get the time spend running write queries for this transaction.

	pendingWriteRowsAffected ()
	Get the number of affected rows from pending write queries.

	ping (&$rtt=null)
	Ping the server and try to reconnect if it there is no connection.

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

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

	reportConnectionError ( $error='Unknown error')

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

	restoreFlags ( $state=self::RESTORE_PRIOR)
	Restore the flags to their prior state before the last setFlag/clearFlag call.

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

	runOnTransactionIdleCallbacks ( $trigger)
	Actually run and consume any "on transaction idle/resolution" callbacks.

	runOnTransactionPreCommitCallbacks ()
	Actually run and consume any "on transaction pre-commit" callbacks.

	runTransactionListenerCallbacks ( $trigger)
	Actually run any "transaction listener" callbacks.

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

	selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	A SELECT wrapper which returns a list of single field values from result rows.

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

	selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Get the number of rows in dataset.

	serverIsReadOnly ()

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

	setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Set a flag for this connection.

	setIndexAliases (array $aliases)
	Convert certain index names to alternative names before querying the DB.

	setLazyMasterHandle (IDatabase $conn)
	Set a lazy-connecting DB handle to the master DB (for replication status purposes)

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

	setLogger (LoggerInterface $logger)
	Set the PSR-3 logger interface to use for query logging.

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

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

	setTableAliases (array $aliases)
	Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

	setTransactionListener ( $name, callable $callback=null)
	Run a callback each time any transaction commits or rolls back.

	setTrxEndCallbackSuppression ( $suppress)
	Whether to disable running of post-COMMIT/ROLLBACK callbacks.

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

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

	startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Begin an atomic section of SQL statements.

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

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

	tableLocksHaveTransactionScope ()
	Checks if table locks acquired by lockTables() are transaction-bound in their scope.

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

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

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

	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.

	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.

	trxLevel ()
	Gets the current transaction level.

	trxStatus ()

	trxTimestamp ()
	Get the UNIX timestamp of the time that the transaction was established.

	unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Construct a UNION query for permutations of conditions.

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

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

	unlockTables ( $method)
	Unlock all tables locked via lockTables()

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

	useIndexClause ( $index)
	USE INDEX clause.

	wasConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes.

	wasConnectionLoss ()
	Determines if the last query error was due to a dropped connection.

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

	wasErrorReissuable ()
	Determines if the last query error was due to something outside of the query itself.

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

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

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

	writesPending ()

Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
	buildSubString ( $input, $startPosition, $length=null)
	Build a SUBSTRING function.

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

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

	doCommit ( $fname=__METHOD__)
	End a transaction.

	doQuery ( $sql)

	doReleaseSavepoint ( $identifier, $fname)
	Release a savepoint.

	doRollback ( $fname=__METHOD__)
	Rollback a transaction.

	doRollbackToSavepoint ( $identifier, $fname)
	Rollback to a savepoint.

	doSavepoint ( $identifier, $fname)
	Create a savepoint.

	escapeLikeInternal ( $s, $escapeChar='`')
	MS SQL supports more pattern operators than other databases (ex: [,],^)

	fetchAffectedRowCount ()

	resultObject ( $result)

	wasKnownStatementRollbackError ()

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertBuildSubstringParams ( $startPosition, $length)
	Check type and bounds for parameters to self::buildSubstring()

	assertOpen ()
	Make sure isOpen() returns true as a sanity check.

	doInitConnection ()
	Actually connect to the database over the wire (or to local files)

	doLockTables (array $read, array $write, $method)
	Helper function for lockTables() that handles the actual table locking.

	doUnlockTables ( $method)
	Helper function for unlockTables() that handles the actual table unlocking.

	extractSingleFieldFromList ( $var)

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

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

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server.

	getBindingHandle ()
	Get the underlying binding connection handle.

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

	getLastPHPError ()

	getLazyMasterHandle ()

	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.

	getQueryVerb ( $sql)

	getReadOnlyReason ()

	getRecordedTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.

	getSchemaVars ()
	Get schema variables.

	getTransactionRoundId ()

	indexName ( $index)
	Allows for index remapping in queries where this is not consistent across DBMS.

	installErrorHandler ()
	Set a custom error handler for logging errors during database connection.

	isInsertSelectSafe (array $insertOptions, array $selectOptions)

	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.

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

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

	makeInsertOptions ( $options)
	Helper for Database::insert().

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

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

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

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

	nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	Implementation of insertSelect() based on select() and insert()

	normalizeConditions ( $conds, $fname)

	pendingWriteAndCallbackCallers ()
	Get the list of method names that have pending write queries or callbacks for this transaction.

	qualifiedTableComponents ( $name)
	Get the table components needed for a query given the currently selected database.

	registerTempTableOperation ( $sql)

	replaceLostConnection ( $fname)
	Close any existing (dead) database connection and open a new connection.

	replaceVars ( $ins)
	Database independent variable replacement.

	restoreErrorHandler ()
	Restore the previous error handler and return the last PHP error for this DB.

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

	tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.

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

	wasQueryTimeout ( $error, $errno)
	Checks whether the cause of the error is detected to be a timeout.

Protected Attributes
stdClass[][] null	$binaryColumnCache = null

stdClass[][] null	$bitColumnCache = null

bool	$ignoreDupKeyErrors = false

string[]	$ignoreErrors = []

int null	$lastAffectedRowCount = null

int null	$lastInsertId = null

bool	$prepareStatements = true

bool	$scrollableCursor = true

int	$serverPort

int	$subqueryId = 0

bool	$useWindowsAuth = false

Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null	$affectedRowCount
	Rows affected by the last query to query() or its CRUD wrappers.

string	$agent
	Agent name for query profiling.

bool	$cliMode
	Whether this PHP instance is for a CLI script.

resource null	$conn = null
	Database connection.

array	$connectionParams = []
	Parameters used by initConnection() to establish a connection.

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$dbName
	Database that this instance is currently connected to.

string	$delimiter = ';'

callback	$deprecationLogger
	Deprecation logging callback.

callback	$errorLogger
	Error logging callback.

int	$flags

string bool null	$htmlErrors
	Stashed value of html_errors INI setting.

string[]	$indexAliases = []
	Map of (index alias => index)

float	$lastPing = 0.0
	UNIX timestamp.

string	$lastQuery = ''
	SQL query.

float bool	$lastWriteTime = false
	UNIX timestamp of last write query.

array	$lbInfo = []

int	$nonNativeInsertSelectBatchSize = 10000

bool	$opened = false

string	$password
	Password used to establish the current connection.

string bool	$phpError = false

array null	$preparedArgs

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

string	$schema = ''

array bool	$schemaVars = false

string	$server
	Server that this instance is currently connected to.

array	$sessionTempTables = []
	Map of (table name => 1) for TEMPORARY tables.

array	$sessionVars = []

BagOStuff	$srvCache
	APC cache.

array[]	$tableAliases = []
	Map of (table => (dbname, schema, prefix) map)

string	$tablePrefix = ''

array[]	$trxEndCallbacks = []
	List of (callable, method name, atomic section id)

bool	$trxEndCallbacksSuppressed = false
	Whether to suppress triggering of transaction end callbacks.

array[]	$trxIdleCallbacks = []
	List of (callable, method name, atomic section id)

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

array[]	$trxPreCommitCallbacks = []
	List of (callable, method name, atomic section id)

TransactionProfiler	$trxProfiler

callable[]	$trxRecurringCallbacks = []
	Map of (name => callable)

string	$trxShortId = ''
	Either a short hexidecimal string if a transaction is active or "".

int	$trxStatus = self::STATUS_TRX_NONE
	Transaction status.

Exception null	$trxStatusCause
	The last error that caused the status to become STATUS_TRX_ERROR.

array null	$trxStatusIgnoredCause
	If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here.

string	$user
	User that this instance is currently connected under the name of.

Private Member Functions
	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.

	getBitColumns ( $table)

	populateColumnCaches ()

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	attributesFromType ( $dbType, $driver=null)

static	factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED)
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
	Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

Public Attributes inherited from Wikimedia\Rdbms\Database
const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry.

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

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

const	PING_QUERY = 'SELECT 1 AS ping'

const	PING_TTL = 1.0
	How long before it is worth doing a dummy query to test the connection.

const	SLOW_WRITE_SEC = 0.500

const	SMALL_WRITE_ROWS = 100

const	TINY_WRITE_SEC = 0.010

Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers.

static	getAttributes ()

Detailed Description

Definition at line 37 of file DatabaseMssql.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseMssql::__construct ( array $params )

Note: : exceptions for missing libraries/drivers should be thrown in initConnection()

Parameters

array $params Parameters passed from Database::factory()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 73 of file DatabaseMssql.php.

References $params.

Member Function Documentation

◆ addIdentifierQuotes()

Wikimedia\Rdbms\DatabaseMssql::addIdentifierQuotes ( $s )

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1152 of file DatabaseMssql.php.

References $s.

Referenced by Wikimedia\Rdbms\DatabaseMssql\doRollbackToSavepoint(), and Wikimedia\Rdbms\DatabaseMssql\doSavepoint().

◆ addQuotes()

Wikimedia\Rdbms\DatabaseMssql::addQuotes ( $s )

Parameters

string | int | null | bool | Blob $s

Returns: string|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1132 of file DatabaseMssql.php.

References $blob, and $s.

Referenced by Wikimedia\Rdbms\DatabaseMssql\insert().

◆ buildConcat()

Wikimedia\Rdbms\DatabaseMssql::buildConcat ( $stringList )

Parameters

array $stringList

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1234 of file DatabaseMssql.php.

◆ buildGroupConcatField()

Wikimedia\Rdbms\DatabaseMssql::buildGroupConcatField	(	$delim,
		$table,
		$field,
		$conds = '',
		$join_conds = [] )

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 Wikimedia\Rdbms\Database.

Definition at line 1255 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$subqueryId, and Wikimedia\Rdbms\DatabaseMssql\selectSQLText().

◆ buildSubstring()

Wikimedia\Rdbms\DatabaseMssql::buildSubstring	(	$input,
		$startPosition,
		$length = null )

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1270 of file DatabaseMssql.php.

References $input, and Wikimedia\Rdbms\Database\assertBuildSubstringParams().

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMssql::closeConnection ( )

protected

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 141 of file DatabaseMssql.php.

◆ dataSeek()

Wikimedia\Rdbms\DatabaseMssql::dataSeek	(		$res,
			$row )

Parameters

MssqlResultWrapper	$res
int	$row

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 320 of file DatabaseMssql.php.

References $res.

◆ delete()

Wikimedia\Rdbms\DatabaseMssql::delete	(	$table,
		$conds,
		$fname = __METHOD__ )

DELETE query wrapper.

Parameters

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

Exceptions

DBUnexpectedError

Returns: bool|IResultWrapper

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 512 of file DatabaseMssql.php.

References $e, $fname, and Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

◆ deleteJoin()

Wikimedia\Rdbms\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

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 499 of file DatabaseMssql.php.

References $e, $fname, and Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

◆ doBegin()

Wikimedia\Rdbms\DatabaseMssql::doBegin ( $fname = __METHOD__ )

protected

Begin a transaction, committing any previously open transaction.

Parameters

string $fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1095 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\trxLevel().

◆ doCommit()

Wikimedia\Rdbms\DatabaseMssql::doCommit ( $fname = __METHOD__ )

protected

End a transaction.

Parameters

string $fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1104 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\trxLevel().

◆ doQuery()

Wikimedia\Rdbms\DatabaseMssql::doQuery ( $sql )

protected

Parameters

string $sql

Returns: bool|MssqlResultWrapper|resource

Exceptions

DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 167 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$ignoreErrors, $matches, $success, Wikimedia\Rdbms\DatabaseMssql\LimitToTopN(), Wikimedia\Rdbms\DatabaseMssql\prepareStatements(), and Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

Referenced by Wikimedia\Rdbms\DatabaseMssql\insert().

◆ doReleaseSavepoint()

Wikimedia\Rdbms\DatabaseMssql::doReleaseSavepoint	(		$identifier,
			$fname )

protected

Release a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since: 1.31

Parameters

string	$identifier	Identifier for the savepoint
string	$fname	Calling function name

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1082 of file DatabaseMssql.php.

◆ doRollback()

Wikimedia\Rdbms\DatabaseMssql::doRollback ( $fname = __METHOD__ )

protected

Rollback a transaction.

No-op on non-transactional databases.

Parameters

string $fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1114 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\trxLevel().

◆ doRollbackToSavepoint()

Wikimedia\Rdbms\DatabaseMssql::doRollbackToSavepoint	(		$identifier,
			$fname )

protected

Rollback to a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since: 1.31

Parameters

string	$identifier	Identifier for the savepoint
string	$fname	Calling function name

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1087 of file DatabaseMssql.php.

References $fname, Wikimedia\Rdbms\DatabaseMssql\addIdentifierQuotes(), and query.

◆ doSavepoint()

Wikimedia\Rdbms\DatabaseMssql::doSavepoint	(		$identifier,
			$fname )

protected

Create a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since: 1.31

Parameters

string	$identifier	Identifier for the savepoint
string	$fname	Calling function name

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1078 of file DatabaseMssql.php.

References $fname, Wikimedia\Rdbms\DatabaseMssql\addIdentifierQuotes(), and query.

◆ dropTable()

Wikimedia\Rdbms\DatabaseMssql::dropTable	(		$tableName,
			$fName = __METHOD__ )

Delete a table.

Parameters

string	$tableName
string	$fName

Returns: bool|ResultWrapper

Since: 1.18

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1379 of file DatabaseMssql.php.

References query, Wikimedia\Rdbms\DatabaseMssql\tableExists(), and tableName().

◆ escapeLikeInternal()

Wikimedia\Rdbms\DatabaseMssql::escapeLikeInternal	(		$s,
			$escapeChar = '`' )

protected

MS SQL supports more pattern operators than other databases (ex: [,],^)

Parameters

string	$s
string	$escapeChar

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1172 of file DatabaseMssql.php.

References $s.

◆ estimateRowCount()

Wikimedia\Rdbms\DatabaseMssql::estimateRowCount	(	$table,
		$var = '*',
		$conds = '',
		$fname = __METHOD__,
		$options = [],
		$join_conds = [] )

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	$var
string	$conds
string	$fname
array	$options
array	$join_conds

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 537 of file DatabaseMssql.php.

References $fname, $options, $res, $rows, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\DatabaseMssql\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and select().

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseMssql::fetchAffectedRowCount ( )

protected

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 387 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$lastAffectedRowCount.

◆ fetchObject()

Wikimedia\Rdbms\DatabaseMssql::fetchObject ( $res )

Parameters

MssqlResultWrapper $res

Returns: stdClass

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 249 of file DatabaseMssql.php.

References $res.

◆ fetchRow()

Wikimedia\Rdbms\DatabaseMssql::fetchRow ( $res )

Parameters

MssqlResultWrapper $res

Returns: array

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 258 of file DatabaseMssql.php.

References $res.

Referenced by Wikimedia\Rdbms\DatabaseMssql\estimateRowCount(), and Wikimedia\Rdbms\DatabaseMssql\textFieldSize().

◆ fieldExists()

Wikimedia\Rdbms\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 Wikimedia\Rdbms\Database.

Definition at line 1039 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\Database\$schema, list, query, and tableName().

◆ fieldInfo()

Wikimedia\Rdbms\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 Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1058 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\Database\$schema, list, query, and tableName().

◆ fieldName()

Wikimedia\Rdbms\DatabaseMssql::fieldName	(		$res,
			$n )

Parameters

mixed	$res
int	$n

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 299 of file DatabaseMssql.php.

References $res.

◆ formatError()

Wikimedia\Rdbms\DatabaseMssql::formatError ( $err )

private

Parameters

array $err

Returns: string

Definition at line 345 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\lastError().

◆ freeResult()

Wikimedia\Rdbms\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 Wikimedia\Rdbms\Database.

Definition at line 237 of file DatabaseMssql.php.

References $res.

◆ getBinaryColumns()

Wikimedia\Rdbms\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 1289 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\populateColumnCaches().

Referenced by Wikimedia\Rdbms\DatabaseMssql\insert(), and Wikimedia\Rdbms\DatabaseMssql\update().

◆ getBitColumns()

Wikimedia\Rdbms\DatabaseMssql::getBitColumns ( $table )

private

Parameters

string $table

Returns: array

Definition at line 1306 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\populateColumnCaches().

Referenced by Wikimedia\Rdbms\DatabaseMssql\selectSQLText().

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMssql::getServerVersion ( )

Returns: string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 993 of file DatabaseMssql.php.

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseMssql::getSoftwareLink ( )

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 986 of file DatabaseMssql.php.

◆ getType()

Wikimedia\Rdbms\DatabaseMssql::getType ( )

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

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1226 of file DatabaseMssql.php.

◆ implicitGroupby()

Wikimedia\Rdbms\DatabaseMssql::implicitGroupby ( )

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

Returns: bool

Deprecated: Since 1.30; only use grouped or aggregated fields in the SELECT

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 61 of file DatabaseMssql.php.

◆ implicitOrderby()

Wikimedia\Rdbms\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 Wikimedia\Rdbms\Database.

Definition at line 65 of file DatabaseMssql.php.

◆ indexInfo()

Wikimedia\Rdbms\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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 571 of file DatabaseMssql.php.

References $fname, $res, query, and tableName().

◆ insert()

Wikimedia\Rdbms\DatabaseMssql::insert	(	$table,
		$arrToInsert,
		$fname = __METHOD__,
		$options = [] )

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

Returns: bool

Exceptions

Exception

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 619 of file DatabaseMssql.php.

References $e, $keys, $options, $res, $ret, $value, Wikimedia\Rdbms\DatabaseMssql\addQuotes(), Wikimedia\Rdbms\DatabaseMssql\doQuery(), Wikimedia\Rdbms\DatabaseMssql\getBinaryColumns(), query, Wikimedia\Rdbms\DatabaseMssql\scrollableCursor(), serialize(), and tableName().

◆ insertId()

Wikimedia\Rdbms\DatabaseMssql::insertId ( )

This must be called after nextSequenceVal.

Returns: int|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 311 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$lastInsertId.

◆ isQuotedIdentifier()

Wikimedia\Rdbms\DatabaseMssql::isQuotedIdentifier ( $name )

Parameters

string $name

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1161 of file DatabaseMssql.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseMssql::lastErrno ( )

Returns: string|int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 353 of file DatabaseMssql.php.

◆ lastError()

Wikimedia\Rdbms\DatabaseMssql::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 327 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\formatError().

Referenced by Wikimedia\Rdbms\DatabaseMssql\open().

◆ limitResult()

Wikimedia\Rdbms\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

Exceptions

DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 912 of file DatabaseMssql.php.

References $last, and Wikimedia\Rdbms\DatabaseMssql\$subqueryId.

Referenced by Wikimedia\Rdbms\DatabaseMssql\LimitToTopN().

◆ LimitToTopN()

Wikimedia\Rdbms\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 967 of file DatabaseMssql.php.

References $matches, and Wikimedia\Rdbms\DatabaseMssql\limitResult().

Referenced by Wikimedia\Rdbms\DatabaseMssql\doQuery().

◆ makeList()

Wikimedia\Rdbms\DatabaseMssql::makeList	(	$a,
		$mode = LIST_COMMA,
		$binaryColumns = [] )

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 Database::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

DBUnexpectedError

Returns: string

Definition at line 855 of file DatabaseMssql.php.

References LIST_NAMES.

Referenced by Wikimedia\Rdbms\DatabaseMssql\update().

◆ makeSelectOptions()

Wikimedia\Rdbms\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 Wikimedia\Rdbms\Database.

Definition at line 1198 of file DatabaseMssql.php.

References $options, Wikimedia\Rdbms\Database\makeGroupByWithHaving(), and Wikimedia\Rdbms\Database\makeOrderBy().

◆ nativeInsertSelect()

Wikimedia\Rdbms\DatabaseMssql::nativeInsertSelect	(	$destTable,
		$srcTable,
		$varMap,
		$conds,
		$fname = __METHOD__,
		$insertOptions = [],
		$selectOptions = [],
		$selectJoinConds = [] )

INSERT SELECT wrapper $varMap must be an associative array of the form [ '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
array	$selectJoinConds

Returns: bool

Exceptions

Exception

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 768 of file DatabaseMssql.php.

References $e, $fname, $ret, and Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

◆ numFields()

Wikimedia\Rdbms\DatabaseMssql::numFields ( $res )

Parameters

mixed $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 286 of file DatabaseMssql.php.

References $res.

◆ numRows()

Wikimedia\Rdbms\DatabaseMssql::numRows ( $res )

Parameters

mixed $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 266 of file DatabaseMssql.php.

References $res, and $ret.

◆ open()

Wikimedia\Rdbms\DatabaseMssql::open	(	$server,
		$user,
		$password,
		$dbName )

Usually aborts on failure.

Parameters

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

Exceptions

DBConnectionError

Returns: bool|resource|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 89 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\Database\$dbName, Wikimedia\Rdbms\Database\$password, Wikimedia\Rdbms\Database\$server, Wikimedia\Rdbms\Database\$user, Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\DatabaseMssql\lastError().

◆ populateColumnCaches()

Wikimedia\Rdbms\DatabaseMssql::populateColumnCaches ( )

private

Definition at line 1319 of file DatabaseMssql.php.

References $res, and select().

Referenced by Wikimedia\Rdbms\DatabaseMssql\getBinaryColumns(), and Wikimedia\Rdbms\DatabaseMssql\getBitColumns().

◆ prepareStatements()

Wikimedia\Rdbms\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 1396 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$prepareStatements, $value, and Wikimedia\Rdbms\DatabaseMssql\prepareStatements().

Referenced by Wikimedia\Rdbms\DatabaseMssql\doQuery(), Wikimedia\Rdbms\DatabaseMssql\prepareStatements(), and Wikimedia\Rdbms\DatabaseMssql\select().

◆ realTableName()

Wikimedia\Rdbms\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 1359 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\tableName().

◆ resultObject()

Wikimedia\Rdbms\DatabaseMssql::resultObject ( $result )

protected

Parameters

bool | MssqlResultWrapper | resource $result

Returns: bool|MssqlResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 149 of file DatabaseMssql.php.

References $result.

◆ scrollableCursor()

Wikimedia\Rdbms\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 1411 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$scrollableCursor, $value, and Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

Referenced by Wikimedia\Rdbms\DatabaseMssql\delete(), Wikimedia\Rdbms\DatabaseMssql\deleteJoin(), Wikimedia\Rdbms\DatabaseMssql\doQuery(), Wikimedia\Rdbms\DatabaseMssql\insert(), Wikimedia\Rdbms\DatabaseMssql\nativeInsertSelect(), Wikimedia\Rdbms\DatabaseMssql\scrollableCursor(), Wikimedia\Rdbms\DatabaseMssql\select(), and Wikimedia\Rdbms\DatabaseMssql\update().

◆ select()

Wikimedia\Rdbms\DatabaseMssql::select	(	$table,
		$vars,
		$conds = '',
		$fname = __METHOD__,
		$options = [],
		$join_conds = [] )

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. [ '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. [ 'page' => [ 'LEFT JOIN','page_latest=rev_id' ] ]

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

Exceptions

DBQueryError
DBUnexpectedError
Exception

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 409 of file DatabaseMssql.php.

References $fname, $options, $ret, $vars, Wikimedia\Rdbms\DatabaseMssql\prepareStatements(), query, Wikimedia\Rdbms\DatabaseMssql\scrollableCursor(), select(), and Wikimedia\Rdbms\DatabaseMssql\selectSQLText().

◆ selectDB()

Wikimedia\Rdbms\DatabaseMssql::selectDB ( $db )

Parameters

string $db

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1183 of file DatabaseMssql.php.

References $e, and query.

◆ selectSQLText()

Wikimedia\Rdbms\DatabaseMssql::selectSQLText	(	$table,
		$vars,
		$conds = '',
		$fname = __METHOD__,
		$options = [],
		$join_conds = [] )

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. [ '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. [ 'page' => [ 'LEFT JOIN','page_latest=rev_id' ] ]

Returns: string The SQL text

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 461 of file DatabaseMssql.php.

References $fname, $options, $t, $tables, $vars, Wikimedia\Rdbms\DatabaseMssql\getBitColumns(), and tableName().

Referenced by Wikimedia\Rdbms\DatabaseMssql\buildGroupConcatField(), and Wikimedia\Rdbms\DatabaseMssql\select().

◆ strencode()

Wikimedia\Rdbms\DatabaseMssql::strencode ( $s )

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1123 of file DatabaseMssql.php.

References $s.

◆ tableExists()

Wikimedia\Rdbms\DatabaseMssql::tableExists	(		$table,
			$fname = __METHOD__ )

Parameters

string	$table
string	$fname

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1008 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\Database\$schema, list, query, and tableName().

Referenced by Wikimedia\Rdbms\DatabaseMssql\dropTable().

◆ tableName()

Wikimedia\Rdbms\DatabaseMssql::tableName	(		$name,
			$format = 'quoted' )

Parameters

string	$name
string	$format

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1343 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\realTableName().

◆ textFieldSize()

Wikimedia\Rdbms\DatabaseMssql::textFieldSize	(		$table,
			$field )

Parameters

string	$table
string	$field

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 888 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\DatabaseMssql\fetchRow(), query, and tableName().

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\DatabaseMssql::unionSupportsOrderAndLimit ( )

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 69 of file DatabaseMssql.php.

◆ update()

Wikimedia\Rdbms\DatabaseMssql::update	(	$table,
		$values,
		$conds,
		$fname = __METHOD__,
		$options = [] )

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters

string	$table	Name of the table to UPDATE. This will be passed through Database::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 Database::addQuotes().
array	$conds	An array of conditions (WHERE). See Database::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

Exceptions

DBUnexpectedError
Exception

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 817 of file DatabaseMssql.php.

References $e, $options, Wikimedia\Rdbms\DatabaseMssql\getBinaryColumns(), LIST_AND, LIST_SET, Wikimedia\Rdbms\DatabaseMssql\makeList(), Wikimedia\Rdbms\Database\makeUpdateOptions(), query, Wikimedia\Rdbms\DatabaseMssql\scrollableCursor(), and tableName().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMssql::wasKnownStatementRollbackError ( )

protected

Returns: bool Whether it is safe to assume the given error only caused statement rollback

Note: This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foriegn key violations

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 362 of file DatabaseMssql.php.

Member Data Documentation

◆ $binaryColumnCache

stdClass [][] null Wikimedia\Rdbms\DatabaseMssql::$binaryColumnCache = null

protected

Definition at line 53 of file DatabaseMssql.php.

◆ $bitColumnCache

stdClass [][] null Wikimedia\Rdbms\DatabaseMssql::$bitColumnCache = null

protected

Definition at line 55 of file DatabaseMssql.php.

◆ $ignoreDupKeyErrors

bool Wikimedia\Rdbms\DatabaseMssql::$ignoreDupKeyErrors = false

protected

Definition at line 57 of file DatabaseMssql.php.

◆ $ignoreErrors

string [] Wikimedia\Rdbms\DatabaseMssql::$ignoreErrors = []

protected

Definition at line 59 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\doQuery().

◆ $lastAffectedRowCount

int null Wikimedia\Rdbms\DatabaseMssql::$lastAffectedRowCount = null

protected

Definition at line 45 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\fetchAffectedRowCount().

◆ $lastInsertId

int null Wikimedia\Rdbms\DatabaseMssql::$lastInsertId = null

protected

Definition at line 43 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\insertId().

◆ $prepareStatements

bool Wikimedia\Rdbms\DatabaseMssql::$prepareStatements = true

protected

Definition at line 51 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\prepareStatements().

◆ $scrollableCursor

bool Wikimedia\Rdbms\DatabaseMssql::$scrollableCursor = true

protected

Definition at line 49 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\scrollableCursor().

◆ $serverPort

int Wikimedia\Rdbms\DatabaseMssql::$serverPort

protected

Definition at line 39 of file DatabaseMssql.php.

◆ $subqueryId

int Wikimedia\Rdbms\DatabaseMssql::$subqueryId = 0

protected

Definition at line 47 of file DatabaseMssql.php.

Referenced by Wikimedia\Rdbms\DatabaseMssql\buildGroupConcatField(), and Wikimedia\Rdbms\DatabaseMssql\limitResult().

◆ $useWindowsAuth

bool Wikimedia\Rdbms\DatabaseMssql::$useWindowsAuth = false

protected

Definition at line 41 of file DatabaseMssql.php.

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

includes/libs/rdbms/database/DatabaseMssql.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIdentifierQuotes()

◆ addQuotes()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildSubstring()

◆ closeConnection()

◆ dataSeek()

◆ delete()

◆ deleteJoin()

◆ doBegin()

◆ doCommit()

◆ doQuery()

◆ doReleaseSavepoint()

◆ doRollback()

◆ doRollbackToSavepoint()

◆ doSavepoint()

◆ dropTable()

◆ escapeLikeInternal()

◆ estimateRowCount()

◆ fetchAffectedRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldExists()

◆ fieldInfo()

◆ fieldName()

◆ formatError()

◆ freeResult()

◆ getBinaryColumns()

◆ getBitColumns()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ implicitGroupby()

◆ implicitOrderby()

◆ indexInfo()

◆ insert()

◆ insertId()

◆ isQuotedIdentifier()

◆ lastErrno()

◆ lastError()

◆ limitResult()

◆ LimitToTopN()

◆ makeList()

◆ makeSelectOptions()

◆ nativeInsertSelect()

◆ numFields()

◆ numRows()

◆ open()

◆ populateColumnCaches()

◆ prepareStatements()

◆ realTableName()

◆ resultObject()

◆ scrollableCursor()

◆ select()

◆ selectDB()

◆ selectSQLText()

◆ strencode()

◆ tableExists()

◆ tableName()

◆ textFieldSize()

◆ unionSupportsOrderAndLimit()

◆ update()

◆ wasKnownStatementRollbackError()

Member Data Documentation

◆ $binaryColumnCache

◆ $bitColumnCache

◆ $ignoreDupKeyErrors

◆ $ignoreErrors

◆ $lastAffectedRowCount

◆ $lastInsertId

◆ $prepareStatements