Mysql update list and mysql-specific update functions. More...

Inheritance diagram for MysqlUpdater:

Collaboration diagram for MysqlUpdater:

[legend]

Public Member Functions
	doSchemaRestructuring ()

	doWatchlistUpdate ()
	Check if we need to add talk page rows to the watchlist.

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

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

	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)

	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 the objectcache table.

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

	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.

Protected Member Functions
	checkBin ( $table, $field, $patchFile)
	1.4 betas were missing the 'binary' marker from logging.log_title, which causes a collation mismatch error on joins in MySQL 4.1.

	doBacklinkingIndicesUpdate ()

	doCategorylinksIndicesUpdate ()

	doCategoryPopulation ()

	doClFieldsUpdate ()

	doExtendCommentLengths ()

	doFilearchiveIndicesUpdate ()

	doFixAncientImagelinks ()

	doIndexUpdate ()
	Check that proper indexes are in place.

	doInterwikiUpdate ()
	Check that interwiki table exists; if it doesn't source it.

	doIwlinksIndexNonUnique ()

	doLangLinksLengthUpdate ()

	doMaybeProfilingMemoryUpdate ()

	doNamespaceSize ()

	doNonUniquePlTlIl ()

	doOldLinksUpdate ()

	doPagelinksUpdate ()

	doPageRandomUpdate ()
	Set page_random field to a random value where it is equals to 0.

	doPopulateParentId ()

	doRestrictionsUpdate ()
	Adding page_restrictions table, obsoleting page.page_restrictions.

	doRevisionPageRevIndexNonUnique ()

	doTemplatelinksUpdate ()

	doUnsignedSyncronisation ()

	doUpdateMimeMinorField ()

	doUserGroupsUpdate ()

	doUserNewTalkTimestampNotNull ()

	doUserUniqueUpdate ()

	doWatchlistNull ()
	Make sure wl_notificationtimestamp can be NULL, and update old broken items.

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

	indexHasField ( $table, $index, $field)
	Check whether an index contain a field.

Protected Member Functions inherited from DatabaseUpdater
	__construct (Database &$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.

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

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

	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.

	doUpdateTranscacheField ()
	Updates the timestamps in the transcache table.

	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.

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

	rebuildLocalisationCache ()
	Rebuilds the localisation cache.

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

Additional Inherited Members
Static Public Member Functions inherited from DatabaseUpdater
static	newForDB (Database $db, $shared=false, $maintenance=null)

Protected Attributes inherited from DatabaseUpdater
Database	$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.

Detailed Description

Mysql update list and mysql-specific update functions.

Since: 1.17

Definition at line 33 of file MysqlUpdater.php.

Member Function Documentation

◆ checkBin()

MysqlUpdater::checkBin	(	$table,
		$field,
		$patchFile )

protected

1.4 betas were missing the 'binary' marker from logging.log_title, which causes a collation mismatch error on joins in MySQL 4.1.

Parameters

string	$table	Table name
string	$field	Field name to check
string	$patchFile	Path to the patch to correct the field

Returns: bool

Definition at line 344 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doBacklinkingIndicesUpdate()

MysqlUpdater::doBacklinkingIndicesUpdate ( )

protected

Definition at line 916 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), and indexHasField().

◆ doCategorylinksIndicesUpdate()

MysqlUpdater::doCategorylinksIndicesUpdate ( )

protected

Definition at line 954 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), and indexHasField().

◆ doCategoryPopulation()

MysqlUpdater::doCategoryPopulation ( )

protected

Definition at line 960 of file MysqlUpdater.php.

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

◆ doClFieldsUpdate()

MysqlUpdater::doClFieldsUpdate ( )

protected

Definition at line 1054 of file MysqlUpdater.php.

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

◆ doExtendCommentLengths()

MysqlUpdater::doExtendCommentLengths ( )

protected

Definition at line 1184 of file MysqlUpdater.php.

References $res, DatabaseUpdater\applyPatch(), and output().

◆ doFilearchiveIndicesUpdate()

MysqlUpdater::doFilearchiveIndicesUpdate ( )

protected

Definition at line 1010 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch().

◆ doFixAncientImagelinks()

MysqlUpdater::doFixAncientImagelinks ( )

protected

Definition at line 432 of file MysqlUpdater.php.

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

◆ doIndexUpdate()

MysqlUpdater::doIndexUpdate ( )

protected

Check that proper indexes are in place.

Definition at line 413 of file MysqlUpdater.php.

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

◆ doInterwikiUpdate()

MysqlUpdater::doInterwikiUpdate ( )

protected

Check that interwiki table exists; if it doesn't source it.

Definition at line 389 of file MysqlUpdater.php.

References $IP, DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doIwlinksIndexNonUnique()

MysqlUpdater::doIwlinksIndexNonUnique ( )

protected

Definition at line 1106 of file MysqlUpdater.php.

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

◆ doLangLinksLengthUpdate()

MysqlUpdater::doLangLinksLengthUpdate ( )

protected

Definition at line 1068 of file MysqlUpdater.php.

References $res, DatabaseUpdater\applyPatch(), and output().

◆ doMaybeProfilingMemoryUpdate()

MysqlUpdater::doMaybeProfilingMemoryUpdate ( )

protected

Definition at line 990 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doNamespaceSize()

MysqlUpdater::doNamespaceSize ( )

protected

Definition at line 684 of file MysqlUpdater.php.

References $tables, and output().

◆ doNonUniquePlTlIl()

MysqlUpdater::doNonUniquePlTlIl ( )

protected

Definition at line 1019 of file MysqlUpdater.php.

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

◆ doOldLinksUpdate()

MysqlUpdater::doOldLinksUpdate ( )

protected

Definition at line 427 of file MysqlUpdater.php.

◆ doPagelinksUpdate()

MysqlUpdater::doPagelinksUpdate ( )

protected

Definition at line 710 of file MysqlUpdater.php.

References $wgContLang, DatabaseUpdater\applyPatch(), and output().

◆ doPageRandomUpdate()

MysqlUpdater::doPageRandomUpdate ( )

protected

Set page_random field to a random value where it is equals to 0.

See also: T5946

Definition at line 859 of file MysqlUpdater.php.

References $rows, and output().

◆ doPopulateParentId()

MysqlUpdater::doPopulateParentId ( )

protected

Definition at line 978 of file MysqlUpdater.php.

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

◆ doRestrictionsUpdate()

MysqlUpdater::doRestrictionsUpdate ( )

protected

Adding page_restrictions table, obsoleting page.page_restrictions.

Migrating old restrictions to new table – Andrew Garrett, January 2007.

Definition at line 930 of file MysqlUpdater.php.

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

◆ doRevisionPageRevIndexNonUnique()

MysqlUpdater::doRevisionPageRevIndexNonUnique ( )

protected

Definition at line 1164 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doSchemaRestructuring()

MysqlUpdater::doSchemaRestructuring ( )

Definition at line 489 of file MysqlUpdater.php.

References $rows, $t, $titles, $wgLegacySchemaConversion, list, output(), and wfTimestamp().

◆ doTemplatelinksUpdate()

MysqlUpdater::doTemplatelinksUpdate ( )

protected

Definition at line 871 of file MysqlUpdater.php.

References $res, DatabaseUpdater\applyPatch(), NS_TEMPLATE, output(), wfGetLB(), and wfWikiID().

◆ doUnsignedSyncronisation()

MysqlUpdater::doUnsignedSyncronisation ( )

protected

Definition at line 1126 of file MysqlUpdater.php.

References $fullName, $s, DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doUpdateMimeMinorField()

MysqlUpdater::doUpdateMimeMinorField ( )

protected

Definition at line 1040 of file MysqlUpdater.php.

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

◆ doUserGroupsUpdate()

MysqlUpdater::doUserGroupsUpdate ( )

protected

Definition at line 763 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doUserNewTalkTimestampNotNull()

MysqlUpdater::doUserNewTalkTimestampNotNull ( )

protected

Definition at line 1084 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doUserUniqueUpdate()

MysqlUpdater::doUserUniqueUpdate ( )

protected

Definition at line 745 of file MysqlUpdater.php.

References DatabaseUpdater\applyPatch(), DatabaseUpdater\doTable(), and output().

◆ doWatchlistNull()

MysqlUpdater::doWatchlistNull ( )

protected

Make sure wl_notificationtimestamp can be NULL, and update old broken items.

Definition at line 836 of file MysqlUpdater.php.

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

◆ doWatchlistUpdate()

MysqlUpdater::doWatchlistUpdate ( )

Check if we need to add talk page rows to the watchlist.

Definition at line 454 of file MysqlUpdater.php.

References output().

◆ getCoreUpdateList()

MysqlUpdater::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 34 of file MysqlUpdater.php.

◆ getSchemaVars()

MysqlUpdater::getSchemaVars ( )

Get appropriate schema variables in the current database connection.

This should be called after any request data has been imported, but before any write operations to the database. The result should be passed to the DB setSchemaVars() method.

Returns: array

Since: 1.28

Reimplemented from DatabaseUpdater.

Definition at line 1200 of file MysqlUpdater.php.

References $vars, and $wgDBTableOptions.

◆ indexHasField()

MysqlUpdater::indexHasField	(	$table,
		$index,
		$field )

protected

Check whether an index contain a field.

Parameters

string	$table	Table name
string	$index	Index name to check
string	$field	Field that should be in the index

Returns: bool

Definition at line 366 of file MysqlUpdater.php.

References DatabaseUpdater\doTable(), and output().

Referenced by doBacklinkingIndicesUpdate(), and doCategorylinksIndicesUpdate().

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

includes/installer/MysqlUpdater.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkBin()

◆ doBacklinkingIndicesUpdate()

◆ doCategorylinksIndicesUpdate()

◆ doCategoryPopulation()

◆ doClFieldsUpdate()

◆ doExtendCommentLengths()

◆ doFilearchiveIndicesUpdate()

◆ doFixAncientImagelinks()

◆ doIndexUpdate()

◆ doInterwikiUpdate()

◆ doIwlinksIndexNonUnique()

◆ doLangLinksLengthUpdate()

◆ doMaybeProfilingMemoryUpdate()

◆ doNamespaceSize()

◆ doNonUniquePlTlIl()

◆ doOldLinksUpdate()

◆ doPagelinksUpdate()

◆ doPageRandomUpdate()

◆ doPopulateParentId()

◆ doRestrictionsUpdate()

◆ doRevisionPageRevIndexNonUnique()

◆ doSchemaRestructuring()

◆ doTemplatelinksUpdate()

◆ doUnsignedSyncronisation()

◆ doUpdateMimeMinorField()

◆ doUserGroupsUpdate()

◆ doUserNewTalkTimestampNotNull()

◆ doUserUniqueUpdate()

◆ doWatchlistNull()

◆ doWatchlistUpdate()

◆ getCoreUpdateList()

◆ getSchemaVars()

◆ indexHasField()