MysqlUpdater Class Reference

Inheritance diagram for MysqlUpdater:

Collaboration diagram for MysqlUpdater:

Public Member Functions
	getSchemaVars ()
	Get appropriate schema variables in the current database connection.
Public Member Functions inherited from DatabaseUpdater
	addExtensionField ( $tableName, $columnName, $sqlPath)
	Add a field to an existing extension table.
	addExtensionIndex ( $tableName, $indexName, $sqlPath)
	Add an index to an existing extension table.
	addExtensionTable ( $tableName, $sqlPath)
	Convenience wrapper for addExtensionUpdate() when adding a new table (which is the most common usage of updaters in an extension) Intended for use in LoadExtensionSchemaUpdates hook handlers.
	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.
	doUpdates (array $what=[ 'core', 'extensions', 'stats'])
	Do all the updates.
	dropExtensionField ( $tableName, $columnName, $sqlPath)
	Drop a field from an extension table.
	dropExtensionIndex ( $tableName, $indexName, $sqlPath)
	Drop an index from an extension table Intended for use in LoadExtensionSchemaUpdates hook handlers.
	dropExtensionTable ( $tableName, $sqlPath=false)
	Drop an extension table.
	getDB ()
	Get a database connection to run updates.
	getPostDatabaseUpdateMaintenance ()
	insertUpdateRow ( $key, $val=null)
	Helper function: Add a key to the updatelog table.
	modifyExtensionField ( $tableName, $fieldName, $sqlPath)
	Modify an existing field in an extension table.
	modifyExtensionTable ( $tableName, $sqlPath)
	Modify an existing extension table.
	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 Intended for use in LoadExtensionSchemaUpdates hook handlers.
	setAutoExtensionHookContainer (HookContainer $hookContainer)
	Set the HookContainer to use for loading extension schema updates.
	setFileAccess ()
	Set any .htaccess files or equivalent 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)
	MW 1.4 betas were missing the 'binary' marker from logging.log_title, which caused a MySQL collation mismatch error.
	doFixIpbAddressUniqueIndex ()
	doLanguageLinksLengthSync ()
	dropDefault ( $table, $field)
	Drop a default value from a field.
	getCoreUpdateList ()
	Get an array of updates to perform on the database.
	indexHasField ( $table, $index, $field)
	Check whether an index contain a field.
	setDefault ( $table, $field, $default)
	Set a default value for a field.
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.
	addTable ( $name, $patch, $fullpath=false)
	Add a new table to the database.
	appendLine ( $line)
	Append a line to the open filehandle.
	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.
	copyFile ( $filename)
	Append an SQL fragment to the open file handle.
	doCollationUpdate ()
	Update CategoryLinks collation.
	doConvertDjvuMetadata ()
	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.
	dropTable ( $table, $patch=false, $fullpath=false)
	If the specified table exists, drop it, or execute the patch if one is provided.
	getExtensionUpdates ()
	Get the list of extension-defined updates.
	ifFieldExists ( $table, $field, $func,... $params)
	Only run a function if the named field exists.
	ifTableNotExists ( $table, $func,... $params)
	Only run a function if a table does not exist.
	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.
	migrateTemplatelinks ()
	modifyField ( $table, $field, $patch, $fullpath=false)
	Modify an existing field.
	modifyTable ( $table, $patch, $fullpath=false)
	Modify an existing table, similar to modifyField.
	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.
	runMaintenance ( $class, $script)
	Run a maintenance script.

Additional Inherited Members
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
Protected Attributes inherited from DatabaseUpdater
HookContainer null	$autoExtensionHookContainer
IMaintainableDatabase	$db
	Handle to the database subclass.
array	$extensionUpdates = []
	List of extension-provided database updates.
resource null	$fileHandle = null
	File handle for SQL output.
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

Definition at line 32 of file MysqlUpdater.php.

Member Function Documentation

checkBin()

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

protected

MW 1.4 betas were missing the 'binary' marker from logging.log_title, which caused a MySQL collation mismatch error.

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

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

doFixIpbAddressUniqueIndex()

MysqlUpdater::doFixIpbAddressUniqueIndex ( )

protected

Definition at line 301 of file MysqlUpdater.php.

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

doLanguageLinksLengthSync()

MysqlUpdater::doLanguageLinksLengthSync ( )

protected

Definition at line 276 of file MysqlUpdater.php.

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

dropDefault()

MysqlUpdater::dropDefault ( $table, $field )

protected

Drop a default value from a field.

Since

1.36

Parameters

string	$table
string	$field

Definition at line 339 of file MysqlUpdater.php.

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

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.

Returns

array[]

Reimplemented from DatabaseUpdater.

Definition at line 33 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.

Stability: stable

to override

Returns

array

Since

1.28

Reimplemented from DatabaseUpdater.

Definition at line 318 of file MysqlUpdater.php.

References $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 261 of file MysqlUpdater.php.

References DatabaseUpdater\output().

Referenced by doFixIpbAddressUniqueIndex().

setDefault()

MysqlUpdater::setDefault ( $table, $field, $default )

protected

Set a default value for a field.

Since

1.36

Parameters

string	$table
string	$field
mixed	$default

Definition at line 366 of file MysqlUpdater.php.

References DatabaseUpdater\output().

---

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

• includes/installer/MysqlUpdater.php