Class for setting up the MediaWiki database using Microsoft SQL Server. More...

Inheritance diagram for MssqlUpdater:

Collaboration diagram for MssqlUpdater:

[legend]

Protected Member Functions
	applyPatch ( $path, $isFullPath=false, $msg=null)
	Applies a SQL patch.

	getCoreUpdateList ()
	Get an array of updates to perform on the database.

	updateSchema ( $table, $updatekey, $patch, $fullpath=false)
	General schema update for a table that touches more than one field or requires destructive actions (such as dropping and recreating the table).

Protected Member Functions inherited from DatabaseUpdater
	__construct (IMaintainableDatabase &$db, $shared, Maintenance $maintenance=null)

	addField ( $table, $field, $patch, $fullpath=false)
	Add a new field to an existing table.

	addIndex ( $table, $index, $patch, $fullpath=false)
	Add a new index to an existing table.

	addIndexIfNoneExist ( $table, $indexes, $patch, $fullpath=false)
	Add a new index to an existing table if none of the given indexes exist.

	addTable ( $name, $patch, $fullpath=false)
	Add a new table to the database.

	canUseNewUpdatelog ()
	Updatelog was changed in 1.17 to have a ul_value column so we can record more information about what kind of updates we've done (that's what this class does).

	checkStats ()
	Check the site_stats table is not properly populated.

	disableContentHandlerUseDB ()
	Turns off content handler fields during parts of the upgrade where they aren't available.

	doActiveUsersInit ()
	Sets the number of active users in the site_stats table.

	doCollationUpdate ()
	Update CategoryLinks collation.

	doEnableProfiling ()
	Enable profiling table when it's turned on.

	doLogSearchPopulation ()
	Migrate log params to new table and index for searching.

	doLogUsertextPopulation ()
	Populates the log_user_text field in the logging table.

	doMigrateUserOptions ()
	Migrates user options from the user table blob to user_properties.

	doTable ( $name)
	Returns whether updates should be executed on the database table $name.

	dropField ( $table, $field, $patch, $fullpath=false)
	Drop a field from an existing table.

	dropIndex ( $table, $index, $patch, $fullpath=false)
	Drop an index from an existing table.

	enableContentHandlerUseDB ()
	Turns content handler fields back on.

	getExtensionUpdates ()
	Get the list of extension-defined updates.

	getOldGlobalUpdates ()
	Before 1.17, we used to handle updates via stuff like $wgExtNewTables/Fields/Indexes.

	migrateActors ()
	Migrate actors to the new 'actor' table.

	migrateArchiveText ()
	Migrate ar_text to modern storage.

	migrateComments ()
	Migrate comments to the new 'comment' table.

	migrateImageCommentTemp ()
	Merge `image_comment_temp` into the `image` table.

	populateArchiveRevId ()
	Populate ar_rev_id, then make it not nullable.

	populateContentTables ()
	Populates the MCR content tables.

	populateExternallinksIndex60 ()
	Populates the externallinks.el_index_60 field.

	rebuildLocalisationCache ()
	Rebuilds the localisation cache.

	renameIndex ( $table, $oldIndex, $newIndex, $skipBothIndexExistWarning, $patch, $fullpath=false)
	Rename an index from an existing table.

Protected Attributes
DatabaseMssql	$db

Protected Attributes inherited from DatabaseUpdater
IMaintainableDatabase	$db
	Handle to the database subclass.

array	$extensionUpdates = []
	List of extension-provided database updates.

resource	$fileHandle = null
	File handle for SQL output.

	$holdContentHandlerUseDB = true
	Hold the value of $wgContentHandlerUseDB during the upgrade.

Maintenance	$maintenance

string[]	$postDatabaseUpdateMaintenance
	Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance.

	$shared = false

bool	$skipSchema = false
	Flag specifying whether or not to skip schema (e.g.

array	$updates = []
	Array of updates to perform on the database.

array	$updatesSkipped = []
	Array of updates that were skipped.

Additional Inherited Members
Public Member Functions inherited from DatabaseUpdater
	addExtensionField ( $tableName, $columnName, $sqlPath)

	addExtensionIndex ( $tableName, $indexName, $sqlPath)

	addExtensionTable ( $tableName, $sqlPath)
	Convenience wrapper for addExtensionUpdate() when adding a new table (which is the most common usage of updaters in an extension)

	addExtensionUpdate (array $update)
	Add a new update coming from an extension.

	addPostDatabaseUpdateMaintenance ( $class)
	Add a maintenance script to be run after the database updates are complete.

	appendLine ( $line)
	Append a line to the open filehandle.

	copyFile ( $filename)
	Append an SQL fragment to the open file handle.

	doUpdates (array $what=[ 'core', 'extensions', 'stats'])
	Do all the updates.

	dropExtensionField ( $tableName, $columnName, $sqlPath)

	dropExtensionIndex ( $tableName, $indexName, $sqlPath)
	Drop an index from an extension table.

	dropExtensionTable ( $tableName, $sqlPath)

	dropTable ( $table, $patch=false, $fullpath=false)
	If the specified table exists, drop it, or execute the patch if one is provided.

	getDB ()
	Get a database connection to run updates.

	getPostDatabaseUpdateMaintenance ()

	getSchemaVars ()
	Get appropriate schema variables in the current database connection.

	insertUpdateRow ( $key, $val=null)
	Helper function: Add a key to the updatelog table Obviously, only use this for updates that occur after the updatelog table was created!

	modifyExtensionField ( $tableName, $fieldName, $sqlPath)

	modifyExtensionTable ( $tableName, $sqlPath)

	modifyField ( $table, $field, $patch, $fullpath=false)
	Modify an existing field.

	modifyTable ( $table, $patch, $fullpath=false)
	Modify an existing table, similar to modifyField.

	output ( $str)
	Output some text.

	patchPath (IDatabase $db, $patch)
	Get the full path of a patch file.

	purgeCache ()
	Purge various database caches.

	renameExtensionIndex ( $tableName, $oldIndexName, $newIndexName, $sqlPath, $skipBothIndexExistWarning=false)
	Rename an index on an extension table.

	runMaintenance ( $class, $script)
	Run a maintenance script.

	setFileAccess ()
	Set any .htaccess files or equivilent for storage repos.

	tableExists ( $tableName)

	updateRowExists ( $key)
	Helper function: check if the given key is present in the updatelog table.

Static Public Member Functions inherited from DatabaseUpdater
static	newForDB (IMaintainableDatabase $db, $shared=false, Maintenance $maintenance=null)

Public Attributes inherited from DatabaseUpdater
const	REPLICATION_WAIT_TIMEOUT = 300

Detailed Description

Class for setting up the MediaWiki database using Microsoft SQL Server.

Since: 1.23

Definition at line 33 of file MssqlUpdater.php.

Member Function Documentation

◆ applyPatch()

MssqlUpdater::applyPatch	(	$path,
		$isFullPath = `false`,
		$msg = `null`
	)

protected

Applies a SQL patch.

Parameters

string	$path	Path to the patch file
bool	$isFullPath	Whether to treat $path as a relative or not
string \| null	$msg	Description of the patch

Returns: bool False if patch is skipped.

Reimplemented from DatabaseUpdater.

Definition at line 163 of file MssqlUpdater.php.

References $path.

Referenced by updateSchema().

◆ getCoreUpdateList()

MssqlUpdater::getCoreUpdateList ( )

protected

Get an array of updates to perform on the database.

Should return a multi-dimensional array. The main key is the MediaWiki version (1.12, 1.13...) with the values being arrays of updates, identical to how updaters.inc did it (for now)

Returns: array[]

Reimplemented from DatabaseUpdater.

Definition at line 40 of file MssqlUpdater.php.

◆ updateSchema()

MssqlUpdater::updateSchema	(	$table,
		$updatekey,
		$patch,
		$fullpath = `false`
	)

protected

General schema update for a table that touches more than one field or requires destructive actions (such as dropping and recreating the table).

NOTE: Usage of this function is highly discouraged, use it's successor DatabaseUpdater::modifyTable instead.

Parameters

string	$table
string	$updatekey
string	$patch
bool	$fullpath

Returns: bool

Definition at line 184 of file MssqlUpdater.php.

References applyPatch(), DatabaseUpdater\insertUpdateRow(), DatabaseUpdater\output(), and DatabaseUpdater\updateRowExists().

Member Data Documentation

◆ $db

DatabaseMssql MssqlUpdater::$db

protected

Definition at line 38 of file MssqlUpdater.php.

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

includes/installer/MssqlUpdater.php

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyPatch()

◆ getCoreUpdateList()

◆ updateSchema()

Member Data Documentation

◆ $db