MediaWiki  master
Wikimedia\Rdbms\DatabaseMssql Class Reference
Inheritance diagram for Wikimedia\Rdbms\DatabaseMssql:
Collaboration diagram for Wikimedia\Rdbms\DatabaseMssql:

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. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 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...
 
 dropTable ( $tableName, $fName=__METHOD__)
 Delete a table. More...
 
 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() 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...
 
 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=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertId ()
 This must be called after nextSequenceVal. 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=[])
 Makes an encoded list of strings from an array. More...
 
 makeSelectOptions ( $options)
 
 numFields ( $res)
 
 numRows ( $res)
 
 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...
 
 scrollableCursor ( $value=null)
 Called in the installer and updater. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 SELECT wrapper. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 SELECT wrapper. More...
 
 serverIsReadOnly ()
 
 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. More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. More...
 
 addIdentifierQuotes ( $s)
 Quotes an identifier, in order to make user controlled input safe. More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 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...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 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...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildIntegerCast ( $field)
 
 buildLike ( $param,... $params)
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin(). More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. 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...
 
 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...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. 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. 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...
 
 estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ( $res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. 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)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. 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. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause. 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...
 
 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...
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ( $table, $index)
 Determines if a given index is unique. More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that sent on account of IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. 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...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking) More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. More...
 
 makeList ( $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. 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 replica DB 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...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed. More...
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More...
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array. More...
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use for query logging. 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...
 
 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. More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ( $s)
 Wrapper for addslashes() More...
 
 strreplace ( $orig, $old, $new)
 Returns a command for str_replace function in SQL query. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an 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...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited". 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...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. 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...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlock ( $lockName, $method)
 Release a lock. More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. More...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildLike ( $param)
 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...
 
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 

Static Public Member Functions

static getAttributes ()
 
- Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static attributesFromType ( $dbType, $driver=null)
 
static factory ( $type, $params=[], $connect=self::NEW_CONNECTED)
 Construct a Database subclass instance given a database type and parameters. More...
 
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. More...
 

Protected Member Functions

 closeConnection ()
 Closes a database connection, if it is open Returns success, true if already closed. More...
 
 doBegin ( $fname=__METHOD__)
 
 doCommit ( $fname=__METHOD__)
 End a transaction. More...
 
 doQuery ( $sql)
 
 doReleaseSavepoint ( $identifier, $fname)
 
 doRollback ( $fname=__METHOD__)
 Rollback a transaction. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 
 doSavepoint ( $identifier, $fname)
 
 doSelectDomain (DatabaseDomain $domain)
 
 escapeLikeInternal ( $s, $escapeChar='`')
 MS SQL supports more pattern operators than other databases (ex: [,],^) More...
 
 fetchAffectedRowCount ()
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper $varMap must be an associative array of the form [ 'dest1' => 'source1', ... More...
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 
 resultObject ( $result)
 
 wasKnownStatementRollbackError ()
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 __construct (array $params)
 
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doGetLag ()
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getBindingHandle ()
 Get the underlying binding connection handle. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTempWrites ( $sql, $pseudoPermanent)
 
 getTransactionRoundId ()
 
 hasFlags ( $field, $flags)
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ( $options)
 Helper for Database::insert(). More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions ( $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. More...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Implementation of insertSelect() based on select() and insert() More...
 
 normalizeConditions ( $conds, $fname)
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempWrites ( $ret, $tmpType, $tmpNew, $tmpDel)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 resultObject ( $result)
 Take a query result and wrap it in an iterable result wrapper if necessary. More...
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names. More...
 
 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. More...
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

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. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
array $connectionVariables = []
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Bitfield of class DBO_* constants. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string [] $indexAliases = []
 Map of (index alias => index) More...
 
array $lbInfo = []
 LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize = 10000
 Row batch size to use for emulated INSERT SELECT queries. More...
 
string $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
array bool $schemaVars = false
 Variables use for schema element placeholders. More...
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array [] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
TransactionProfiler $trxProfiler
 
string $trxShortId = ''
 ID of the active transaction or the empty string otherwise. More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
string $user
 User that this instance is currently connected under the name of. More...
 

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. More...
 
 getBitColumns ( $table)
 
 populateColumnCaches ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 

Detailed Description

Definition at line 38 of file DatabaseMssql.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 74 of file DatabaseMssql.php.

Member Function Documentation

◆ addIdentifierQuotes()

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

◆ addQuotes()

Wikimedia\Rdbms\DatabaseMssql::addQuotes (   $s)
Parameters
string | int | null | bool | Blob$s
Returns
string|int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1119 of file DatabaseMssql.php.

References $blob, and $s.

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

◆ buildConcat()

Wikimedia\Rdbms\DatabaseMssql::buildConcat (   $stringList)
Parameters
array$stringList
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1232 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$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1253 of file DatabaseMssql.php.

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

◆ buildStringCast()

Wikimedia\Rdbms\DatabaseMssql::buildStringCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1414 of file DatabaseMssql.php.

◆ buildSubstring()

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

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMssql::closeConnection ( )
protected

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

Returns
bool

Definition at line 136 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 299 of file DatabaseMssql.php.

References $res.

◆ delete()

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

DELETE query wrapper.

Parameters
string$tableTable name
string | array$condsArray of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows
string$fnameName of the calling function
Exceptions
DBUnexpectedError
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 502 of file DatabaseMssql.php.

References $e, 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$delTableThe table to delete from.
string$joinTableThe other table.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
array$condsCondition array of field names mapped to variables, ANDed together in the WHERE clause
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 489 of file DatabaseMssql.php.

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

◆ doBegin()

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

◆ doCommit()

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

◆ doQuery()

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

◆ doReleaseSavepoint()

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

Definition at line 1062 of file DatabaseMssql.php.

◆ doRollback()

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

Rollback a transaction.

No-op on non-transactional databases.

Parameters
string$fname

Definition at line 1092 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\DatabaseMssql\lastErrno(), and Wikimedia\Rdbms\DatabaseMssql\lastError().

◆ doRollbackToSavepoint()

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

◆ doSavepoint()

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

◆ doSelectDomain()

◆ dropTable()

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

Delete a table.

Parameters
string$tableName
string$fName
Returns
bool|IResultWrapper
Since
1.18

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1373 of file DatabaseMssql.php.

References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseMssql\tableExists(), and Wikimedia\Rdbms\DatabaseMssql\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

Definition at line 1159 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 529 of file DatabaseMssql.php.

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

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseMssql::fetchAffectedRowCount ( )
protected
Returns
int

Definition at line 377 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$lastAffectedRowCount.

◆ fetchObject()

Wikimedia\Rdbms\DatabaseMssql::fetchObject (   $res)
Parameters
IResultWrapper$res
Returns
stdClass

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 239 of file DatabaseMssql.php.

References $res.

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

◆ fetchRow()

Wikimedia\Rdbms\DatabaseMssql::fetchRow (   $res)
Parameters
IResultWrapper$res
Returns
array

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 248 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1019 of file DatabaseMssql.php.

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

◆ fieldInfo()

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

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

Parameters
string$tableTable name
string$fieldField name
Returns
false|Field

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1038 of file DatabaseMssql.php.

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

◆ fieldName()

Wikimedia\Rdbms\DatabaseMssql::fieldName (   $res,
  $n 
)
Parameters
mixed$res
int$n
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 282 of file DatabaseMssql.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ formatError()

Wikimedia\Rdbms\DatabaseMssql::formatError (   $err)
private
Parameters
array$err
Returns
string

Definition at line 324 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$resA SQL result

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 231 of file DatabaseMssql.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseMssql::getAttributes ( )
static

Definition at line 1418 of file DatabaseMssql.php.

References class, and true.

◆ 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 1287 of file DatabaseMssql.php.

References null, and 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 1302 of file DatabaseMssql.php.

References null, and 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 976 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 969 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 1224 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 62 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 66 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

Definition at line 563 of file DatabaseMssql.php.

References $res, as, null, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseMssql\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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 611 of file DatabaseMssql.php.

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

◆ insertId()

Wikimedia\Rdbms\DatabaseMssql::insertId ( )

This must be called after nextSequenceVal.

Returns
int|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 290 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$lastInsertId.

◆ isQuotedIdentifier()

Wikimedia\Rdbms\DatabaseMssql::isQuotedIdentifier (   $name)
Parameters
string$name
Returns
bool

Definition at line 1148 of file DatabaseMssql.php.

References $name.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseMssql::lastErrno ( )

◆ lastError()

◆ limitResult()

Wikimedia\Rdbms\DatabaseMssql::limitResult (   $sql,
  $limit,
  $offset = false 
)

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

Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
bool | int$offsetThe SQL offset (default false)
Returns
array|string
Exceptions
DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 895 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 950 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$aContaining the data
int$modeConstant
  • 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$binaryColumnsContains 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 838 of file DatabaseMssql.php.

References as, and LIST_NAMES.

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

◆ makeSelectOptions()

Wikimedia\Rdbms\DatabaseMssql::makeSelectOptions (   $options)
Parameters
array$optionsAn associative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array

Definition at line 1196 of file DatabaseMssql.php.

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

◆ nativeInsertSelect()

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

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$srcTableMay be an array of tables.
array$varMap
array$condsMay be "*" to copy the whole table.
string$fname
array$insertOptions
array$selectOptions
array$selectJoinConds
Exceptions
Exception

Definition at line 753 of file DatabaseMssql.php.

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

◆ numFields()

Wikimedia\Rdbms\DatabaseMssql::numFields (   $res)
Parameters
mixed$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 273 of file DatabaseMssql.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ numRows()

Wikimedia\Rdbms\DatabaseMssql::numRows (   $res)
Parameters
mixed$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 256 of file DatabaseMssql.php.

References $res, $ret, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ open()

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

◆ populateColumnCaches()

◆ 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 1390 of file DatabaseMssql.php.

References Wikimedia\Rdbms\DatabaseMssql\$prepareStatements, $value, and null.

Referenced by Wikimedia\Rdbms\DatabaseMssql\doQuery(), 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$formatOne of "quoted" (default), "raw", or "split".
Returns
string|array When the requested $format is "split", a list of database, schema, and table name is returned. Database and schema can be false.
Access:
private

Definition at line 1356 of file DatabaseMssql.php.

References $name, and tableName().

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

◆ resultObject()

Wikimedia\Rdbms\DatabaseMssql::resultObject (   $result)
protected
Parameters
bool | MssqlResultWrapper | resource$result
Returns
bool|MssqlResultWrapper

Definition at line 144 of file DatabaseMssql.php.

◆ scrollableCursor()

Wikimedia\Rdbms\DatabaseMssql::scrollableCursor (   $value = null)

◆ select()

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

SELECT wrapper.

Parameters
mixed$tableArray or string, table name(s) (prefix auto-added)
mixed$varsArray or string, field name(s) to be retrieved
mixed$condsArray or string, condition(s) for WHERE
string$fnameCalling function name (use METHOD) for logs/profiling
array$optionsAssociative array of options (e.g. [ 'GROUP BY' => 'page_title' ]), see Database::makeSelectOptions code for list of supported stuff
array$join_condsAssociative 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 399 of file DatabaseMssql.php.

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

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

◆ selectSQLText()

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

SELECT wrapper.

Parameters
mixed$tableArray or string, table name(s) (prefix auto-added)
mixed$varsArray or string, field name(s) to be retrieved
mixed$condsArray or string, condition(s) for WHERE
string$fnameCalling function name (use METHOD) for logs/profiling
array$optionsAssociative array of options (e.g. [ 'GROUP BY' => 'page_title' ]), see Database::makeSelectOptions code for list of supported stuff
array$join_condsAssociative array of table join conditions (optional) (e.g. [ 'page' => [ 'LEFT JOIN','page_latest=rev_id' ] ]
Returns
string The SQL text

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 451 of file DatabaseMssql.php.

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

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

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMssql::serverIsReadOnly ( )
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 363 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\DatabaseMssql\addQuotes(), Wikimedia\Rdbms\DatabaseMssql\fetchObject(), Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\query().

◆ strencode()

Wikimedia\Rdbms\DatabaseMssql::strencode (   $s)
Parameters
string$s
Returns
string

Definition at line 1110 of file DatabaseMssql.php.

References $s.

◆ tableExists()

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

◆ tableName()

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

◆ 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"

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 871 of file DatabaseMssql.php.

References $res, Wikimedia\Rdbms\DatabaseMssql\fetchRow(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseMssql\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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 70 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$tableName of the table to UPDATE. This will be passed through Database::tableName().
array$valuesAn 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$condsAn array of conditions (WHERE). See Database::select() for the details of the format of condition arrays. Use '*' to update all rows.
string$fnameThe function name of the caller (from METHOD), for logging and profiling.
array$optionsAn array of UPDATE options, can be:
  • IGNORE: Ignore unique key conflicts
  • LOW_PRIORITY: MySQL-specific, see MySQL manual.
Returns
bool
Exceptions
DBUnexpectedError
Exception

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 800 of file DatabaseMssql.php.

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

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMssql::wasKnownStatementRollbackError ( )
protected

Definition at line 341 of file DatabaseMssql.php.

References as.

Member Data Documentation

◆ $binaryColumnCache

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

Definition at line 54 of file DatabaseMssql.php.

◆ $bitColumnCache

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

Definition at line 56 of file DatabaseMssql.php.

◆ $ignoreDupKeyErrors

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

Definition at line 58 of file DatabaseMssql.php.

◆ $ignoreErrors

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

Definition at line 60 of file DatabaseMssql.php.

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

◆ $lastAffectedRowCount

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

◆ $lastInsertId

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

Definition at line 44 of file DatabaseMssql.php.

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

◆ $prepareStatements

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

Definition at line 52 of file DatabaseMssql.php.

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

◆ $scrollableCursor

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

Definition at line 50 of file DatabaseMssql.php.

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

◆ $serverPort

int Wikimedia\Rdbms\DatabaseMssql::$serverPort
protected

Definition at line 40 of file DatabaseMssql.php.

◆ $subqueryId

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

◆ $useWindowsAuth

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

Definition at line 42 of file DatabaseMssql.php.


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