Class for handling database updates. More...

Inheritance diagram for DatabaseUpdater:

[legend]

Collaboration diagram for DatabaseUpdater:

[legend]

Public Member Functions
	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 ()

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

	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 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
static	newForDB (IMaintainableDatabase $db, $shared=false, Maintenance $maintenance=null)

Public Attributes
const	REPLICATION_WAIT_TIMEOUT = 300

Protected Member Functions
	__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.

	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.

	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.

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

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

	ifFieldExists ( $table, $field, $func,... $params)
	Only run a function if the named field exists.

	ifNoActorTable ( $func,... $params)

	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.

	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.

Protected Attributes
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.

Private Member Functions
	loadExtensions ()
	Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates hook.

	loadExtensionSchemaUpdates ()
	Cause extensions to register any updates they need to perform.

	runUpdates (array $updates, $passSelf)
	Helper function for doUpdates()

	writeSchemaUpdateFile (array $schemaUpdate=[])

Detailed Description

Class for handling database updates.

Stability: stable: to extend

Since: 1.17

Definition at line 40 of file DatabaseUpdater.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseUpdater::__construct	(	IMaintainableDatabase &	$db,
			$shared,
		Maintenance	$maintenance = `null`
	)

protected

Stability: stable: to call

Parameters

IMaintainableDatabase	&$db	To perform updates on
bool	$shared	Whether to perform updates on shared tables
Maintenance \| null	$maintenance	Maintenance object which created us

Definition at line 120 of file DatabaseUpdater.php.

References $maintenance, $shared, DBO_DDLMODE, Maintenance\setDB(), and Wikimedia\Rdbms\IDatabase\setFlag().

Member Function Documentation

◆ addExtensionField()

DatabaseUpdater::addExtensionField	(	$tableName,
		$columnName,
		$sqlPath
	)

Add a field to an existing extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.19

Parameters

string	$tableName
string	$columnName
string	$sqlPath

Definition at line 312 of file DatabaseUpdater.php.

References true.

◆ addExtensionIndex()

DatabaseUpdater::addExtensionIndex	(	$tableName,
		$indexName,
		$sqlPath
	)

Add an index to an existing extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.19

Parameters

string	$tableName
string	$indexName
string	$sqlPath

Definition at line 298 of file DatabaseUpdater.php.

References true.

◆ addExtensionTable()

DatabaseUpdater::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.

Since: 1.18

Parameters

string	$tableName	Name of table to create
string	$sqlPath	Full path to the schema file

Definition at line 284 of file DatabaseUpdater.php.

References true.

◆ addExtensionUpdate()

DatabaseUpdater::addExtensionUpdate ( array $update )

Add a new update coming from an extension.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.17

Parameters

array $update The update to run. Format is [ $callback, $params... ] $callback is the method to call; either a DatabaseUpdater method name or a callable. Must be serializable (ie. no anonymous functions allowed). The rest of the parameters (if any) will be passed to the callback. The first parameter passed to the callback is always this object.

Definition at line 270 of file DatabaseUpdater.php.

◆ addField()

DatabaseUpdater::addField	(	$table,
		$field,
		$patch,
		$fullpath = `false`
	)

protected

Add a new field to an existing table.

Note: Code in a LoadExtensionSchemaUpdates handler should use addExtensionField instead!

Parameters

string	$table	Name of the table to modify
string	$field	Name of the new field
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 767 of file DatabaseUpdater.php.

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

◆ addIndex()

DatabaseUpdater::addIndex	(	$table,
		$index,
		$patch,
		$fullpath = `false`
	)

protected

Add a new index to an existing table.

Note: Code in a LoadExtensionSchemaUpdates handler should use addExtensionIndex instead!

Parameters

string	$table	Name of the table to modify
string	$index	Name of the new index
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 795 of file DatabaseUpdater.php.

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

◆ addIndexIfNoneExist()

DatabaseUpdater::addIndexIfNoneExist	(	$table,
		$indexes,
		$patch,
		$fullpath = `false`
	)

protected

Add a new index to an existing table if none of the given indexes exist.

Parameters

string	$table	Name of the table to modify
string[]	$indexes	Name of the indexes to check. $indexes[0] should be the one actually being added.
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 821 of file DatabaseUpdater.php.

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

◆ addPostDatabaseUpdateMaintenance()

DatabaseUpdater::addPostDatabaseUpdateMaintenance ( $class )

Add a maintenance script to be run after the database updates are complete.

Script should subclass LoggedUpdateMaintenance

Since: 1.19

Parameters

string $class Name of a Maintenance subclass

Definition at line 430 of file DatabaseUpdater.php.

◆ addTable()

DatabaseUpdater::addTable	(	$name,
		$patch,
		$fullpath = `false`
	)

protected

Add a new table to the database.

Note: Code in a LoadExtensionSchemaUpdates handler should use addExtensionTable instead!

Parameters

string	$name	Name of the new table
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 741 of file DatabaseUpdater.php.

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

◆ appendLine()

DatabaseUpdater::appendLine ( $line )

protected

Append a line to the open filehandle.

The line is assumed to be a complete SQL statement.

This is used as a callback for sourceLine().

Note: protected since 1.35

Parameters

string $line Text to append to the file

Returns: bool False to skip actually executing the file

Exceptions

MWException

Definition at line 666 of file DatabaseUpdater.php.

References $line.

Referenced by copyFile().

◆ applyPatch()

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

protected

Applies a SQL patch.

Note: Do not use this in a LoadExtensionSchemaUpdates handler, use addExtensionUpdate instead!

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.

Definition at line 686 of file DatabaseUpdater.php.

References $path, copyFile(), output(), and patchPath().

Referenced by addField(), addIndex(), addIndexIfNoneExist(), PostgresUpdater\addPgExtIndex(), addTable(), MysqlUpdater\checkBin(), MysqlUpdater\doFixIpbAddressUniqueIndex(), SqliteUpdater\doFixIpbAddressUniqueIndex(), MysqlUpdater\doLanguageLinksLengthSync(), MysqlUpdater\doNonUniquePlTlIl(), MysqlUpdater\doRevisionPageRevIndexNonUnique(), MysqlUpdater\doUnsignedSyncronisation(), dropField(), dropIndex(), dropTable(), migrateArchiveText(), modifyField(), modifyTable(), populateArchiveRevId(), renameIndex(), and PostgresUpdater\renameTable().

◆ canUseNewUpdatelog()

DatabaseUpdater::canUseNewUpdatelog ( )

protected

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

Pre-1.17 wikis won't have this column, and really old wikis might not even have updatelog at all

Returns: bool

Definition at line 596 of file DatabaseUpdater.php.

Referenced by insertUpdateRow().

◆ checkStats()

DatabaseUpdater::checkStats ( )

protected

Check the site_stats table is not properly populated.

Definition at line 1149 of file DatabaseUpdater.php.

References SiteStatsInit\doAllAndCommit(), and output().

Referenced by doUpdates().

◆ copyFile()

DatabaseUpdater::copyFile ( $filename )

protected

Append an SQL fragment to the open file handle.

Note: protected since 1.35

Parameters

string $filename File name to open

Definition at line 642 of file DatabaseUpdater.php.

References $line, and appendLine().

Referenced by applyPatch().

◆ doCollationUpdate()

DatabaseUpdater::doCollationUpdate ( )

protected

Update CategoryLinks collation.

Definition at line 1169 of file DatabaseUpdater.php.

References $wgCategoryCollation, and output().

Referenced by doUpdates().

◆ doTable()

DatabaseUpdater::doTable ( $name )

protected

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

Updates will be prevented if the table is a shared table and it is not specified to run updates on shared tables.

Parameters

string $name Table name

Returns: bool

Definition at line 609 of file DatabaseUpdater.php.

References $wgSharedDB, $wgSharedTables, and output().

Referenced by addField(), addIndex(), addIndexIfNoneExist(), addTable(), MysqlUpdater\checkBin(), MysqlUpdater\doFixIpbAddressUniqueIndex(), MysqlUpdater\doRevisionPageRevIndexNonUnique(), MysqlUpdater\doUnsignedSyncronisation(), dropField(), dropIndex(), dropTable(), modifyField(), modifyTable(), and renameIndex().

◆ doUpdates()

DatabaseUpdater::doUpdates ( array $what = [ 'core', 'extensions', 'stats' ] )

Do all the updates.

Parameters

array $what What updates to perform

Definition at line 490 of file DatabaseUpdater.php.

References checkStats(), doCollationUpdate(), getCoreUpdateList(), getExtensionUpdates(), getSchemaVars(), loadExtensionSchemaUpdates(), runUpdates(), and writeSchemaUpdateFile().

◆ dropExtensionField()

DatabaseUpdater::dropExtensionField	(	$tableName,
		$columnName,
		$sqlPath
	)

Drop a field from an extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.20

Parameters

string	$tableName
string	$columnName
string	$sqlPath

Definition at line 326 of file DatabaseUpdater.php.

References true.

◆ dropExtensionIndex()

DatabaseUpdater::dropExtensionIndex	(	$tableName,
		$indexName,
		$sqlPath
	)

Drop an index from an extension table Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.21

Parameters

string	$tableName	The table name
string	$indexName	The index name
string	$sqlPath	The path to the SQL change path

Definition at line 340 of file DatabaseUpdater.php.

References true.

◆ dropExtensionTable()

DatabaseUpdater::dropExtensionTable	(	$tableName,
		$sqlPath = `false`
	)

Drop an extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.20

Parameters

string	$tableName
string \| bool	$sqlPath

Definition at line 353 of file DatabaseUpdater.php.

References true.

◆ dropField()

DatabaseUpdater::dropField	(	$table,
		$field,
		$patch,
		$fullpath = `false`
	)

protected

Drop a field from an existing table.

Note: Code in a LoadExtensionSchemaUpdates handler should use dropExtensionField instead!

Parameters

string	$table	Name of the table to modify
string	$field	Name of the old field
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 856 of file DatabaseUpdater.php.

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

◆ dropIndex()

DatabaseUpdater::dropIndex	(	$table,
		$index,
		$patch,
		$fullpath = `false`
	)

protected

Drop an index from an existing table.

Note: Code in a LoadExtensionSchemaUpdates handler should use dropExtensionIndex instead!

Parameters

string	$table	Name of the table to modify
string	$index	Name of the index
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 882 of file DatabaseUpdater.php.

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

◆ dropTable()

DatabaseUpdater::dropTable	(	$table,
		$patch = `false`,
		$fullpath = `false`
	)

protected

If the specified table exists, drop it, or execute the patch if one is provided.

Note: Code in a LoadExtensionSchemaUpdates handler should use dropExtensionTable instead!; protected since 1.35

Parameters

string	$table	Table to drop.
string \| bool	$patch	String of patch file that will drop the table. Default: false.
bool	$fullpath	Whether $patch is a full path. Default: false.

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 969 of file DatabaseUpdater.php.

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

Referenced by migrateImageCommentTemp().

◆ getCoreUpdateList()

DatabaseUpdater::getCoreUpdateList ( )

abstractprotected

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 in MysqlUpdater, PostgresUpdater, and SqliteUpdater.

Referenced by doUpdates().

◆ getDB()

DatabaseUpdater::getDB ( )

Get a database connection to run updates.

Returns: IMaintainableDatabase

Definition at line 236 of file DatabaseUpdater.php.

◆ getExtensionUpdates()

DatabaseUpdater::getExtensionUpdates ( )

protected

Get the list of extension-defined updates.

Returns: array

Definition at line 439 of file DatabaseUpdater.php.

Referenced by doUpdates().

◆ getPostDatabaseUpdateMaintenance()

DatabaseUpdater::getPostDatabaseUpdateMaintenance ( )

Since: 1.17

Returns: string[]

Definition at line 448 of file DatabaseUpdater.php.

◆ getSchemaVars()

DatabaseUpdater::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 in MysqlUpdater.

Definition at line 481 of file DatabaseUpdater.php.

Referenced by doUpdates().

◆ ifFieldExists()

DatabaseUpdater::ifFieldExists	(	$table,
		$field,
		$func,
		$params
	)

protected

Only run a function if the named field exists.

Since: 1.35

Parameters

string	$table	Table to check. If passed $this, it's assumed to be a call from runUpdates() with $passSelf = true: all other parameters are shifted and $this is prepended to the rest of $params.
string	$field	Field to check
string \| array \| static	$func	Normally this is the string naming the method on $this to call. It may also be an array callable.
	mixed	...$params Parameters for `$func`

Returns: mixed Whatever $func returns, or null when skipped.

Definition at line 1394 of file DatabaseUpdater.php.

◆ ifNoActorTable()

DatabaseUpdater::ifNoActorTable	(	$func,
		$params
	)

protected

Deprecated:: since 1.35, use ifTableNotExists() instead

Definition at line 1339 of file DatabaseUpdater.php.

References ifTableNotExists(), and wfDeprecated().

◆ ifTableNotExists()

DatabaseUpdater::ifTableNotExists	(	$table,
		$func,
		$params
	)

protected

Only run a function if a table does not exist.

Since: 1.35

Parameters

string	$table	Table to check. If passed $this, it's assumed to be a call from runUpdates() with $passSelf = true: all other parameters are shifted and $this is prepended to the rest of $params.
string \| array \| static	$func	Normally this is the string naming the method on $this to call. It may also be an array callable.
	mixed	...$params Parameters for `$func`

Returns: mixed Whatever $func returns, or null when skipped.

Definition at line 1357 of file DatabaseUpdater.php.

Referenced by ifNoActorTable().

◆ insertUpdateRow()

DatabaseUpdater::insertUpdateRow	(	$key,
		$val = `null`
	)

Helper function: Add a key to the updatelog table.

Note: Only use this for updates that occur after the updatelog table was created!; Extensions must only use this from within callbacks registered with addExtensionUpdate(). In particular, this method must not be called directly from a LoadExtensionSchemaUpdates handler.

Parameters

string	$key	Name of key to insert
string \| null	$val	[optional] Value to insert along with the key

Definition at line 578 of file DatabaseUpdater.php.

References canUseNewUpdatelog(), and DBO_DDLMODE.

Referenced by MysqlUpdater\dropDefault(), modifyField(), modifyTable(), and populateContentTables().

◆ loadExtensions()

DatabaseUpdater::loadExtensions ( )

private

Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates hook.

Returns: HookContainer

Definition at line 151 of file DatabaseUpdater.php.

References $queue, $wgAutoloadClasses, and Installer\getExistingLocalSettings().

Referenced by loadExtensionSchemaUpdates().

◆ loadExtensionSchemaUpdates()

DatabaseUpdater::loadExtensionSchemaUpdates ( )

private

Cause extensions to register any updates they need to perform.

Definition at line 140 of file DatabaseUpdater.php.

References loadExtensions().

Referenced by doUpdates().

◆ migrateActors()

DatabaseUpdater::migrateActors ( )

protected

Migrate actors to the new 'actor' table.

Since: 1.31

Definition at line 1247 of file DatabaseUpdater.php.

References output(), and updateRowExists().

◆ migrateArchiveText()

DatabaseUpdater::migrateArchiveText ( )

protected

Migrate ar_text to modern storage.

Since: 1.31

Definition at line 1264 of file DatabaseUpdater.php.

References applyPatch(), and output().

◆ migrateComments()

DatabaseUpdater::migrateComments ( )

protected

Migrate comments to the new 'comment' table.

Since: 1.30

Definition at line 1210 of file DatabaseUpdater.php.

References output(), and updateRowExists().

◆ migrateImageCommentTemp()

DatabaseUpdater::migrateImageCommentTemp ( )

protected

Merge image_comment_temp into the image table.

Since: 1.32

Definition at line 1227 of file DatabaseUpdater.php.

References dropTable(), output(), and tableExists().

◆ modifyExtensionField()

DatabaseUpdater::modifyExtensionField	(	$tableName,
		$fieldName,
		$sqlPath
	)

Modify an existing field in an extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.21

Parameters

string	$tableName	The table name
string	$fieldName	The field to be modified
string	$sqlPath	The path to the SQL patch

Definition at line 394 of file DatabaseUpdater.php.

References true.

◆ modifyExtensionTable()

DatabaseUpdater::modifyExtensionTable	(	$tableName,
		$sqlPath
	)

Modify an existing extension table.

Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.31

Parameters

string	$tableName	The table name
string	$sqlPath	The path to the SQL patch

Definition at line 407 of file DatabaseUpdater.php.

References true.

◆ modifyField()

DatabaseUpdater::modifyField	(	$table,
		$field,
		$patch,
		$fullpath = `false`
	)

protected

Modify an existing field.

Note: Code in a LoadExtensionSchemaUpdates handler should use modifyExtensionField instead!; protected since 1.35

Parameters

string	$table	Name of the table to which the field belongs
string	$field	Name of the field to modify
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Definition at line 1005 of file DatabaseUpdater.php.

References applyPatch(), doTable(), insertUpdateRow(), output(), and updateRowExists().

◆ modifyTable()

DatabaseUpdater::modifyTable	(	$table,
		$patch,
		$fullpath = `false`
	)

protected

Modify an existing table, similar to modifyField.

Intended for changes that touch more than one column on a table.

Note: Code in a LoadExtensionSchemaUpdates handler should use modifyExtensionTable instead!; protected since 1.35

Parameters

string	$table	Name of the table to modify
string	$patch	Name of the patch file to apply
string \| bool	$fullpath	Whether to treat $patch path as relative or not, defaults to false

Returns: bool False if this was skipped because of schema changes being skipped

Definition at line 1042 of file DatabaseUpdater.php.

References applyPatch(), doTable(), insertUpdateRow(), output(), and updateRowExists().

◆ newForDB()

static DatabaseUpdater::newForDB	(	IMaintainableDatabase	$db,
			$shared = `false`,
		Maintenance	$maintenance = `null`
	)

static

Parameters

IMaintainableDatabase	$db
bool	$shared
Maintenance \| null	$maintenance

Exceptions

MWException

Returns: DatabaseUpdater

Definition at line 205 of file DatabaseUpdater.php.

References $maintenance, $shared, $type, Installer\getDBTypes(), and Wikimedia\Rdbms\IDatabase\getType().

◆ output()

DatabaseUpdater::output ( $str )

Output some text.

If we're running from web, escape the text first.

Parameters

string	$str	Text to output
-taint	$str	escapes_html

Definition at line 246 of file DatabaseUpdater.php.

References $wgCommandLineMode.

◆ patchPath()

DatabaseUpdater::patchPath	(	IDatabase	$db,
			$patch
	)

Get the full path of a patch file.

Keep in mind this always returns a patch, as it fails back to MySQL if no DB-specific patch can be found

Parameters

IDatabase	$db
string	$patch	The name of the patch, like patch-something.sql

Returns: string Full path to patch file

Definition at line 719 of file DatabaseUpdater.php.

References $IP, and Wikimedia\Rdbms\IDatabase\getType().

Referenced by applyPatch().

◆ populateArchiveRevId()

DatabaseUpdater::populateArchiveRevId ( )

protected

Populate ar_rev_id, then make it not nullable.

Since: 1.31

Definition at line 1281 of file DatabaseUpdater.php.

References applyPatch(), and output().

◆ populateContentTables()

DatabaseUpdater::populateContentTables ( )

protected

Populates the MCR content tables.

Since: 1.32

Definition at line 1318 of file DatabaseUpdater.php.

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

◆ populateExternallinksIndex60()

DatabaseUpdater::populateExternallinksIndex60 ( )

protected

Populates the externallinks.el_index_60 field.

Since: 1.32

Definition at line 1300 of file DatabaseUpdater.php.

References output(), and updateRowExists().

◆ purgeCache()

DatabaseUpdater::purgeCache ( )

Purge various database caches.

Definition at line 1118 of file DatabaseUpdater.php.

References $wgLocalisationCacheConf, output(), and rebuildLocalisationCache().

◆ rebuildLocalisationCache()

DatabaseUpdater::rebuildLocalisationCache ( )

protected

Rebuilds the localisation cache.

Definition at line 1192 of file DatabaseUpdater.php.

References output().

Referenced by purgeCache().

◆ renameExtensionIndex()

DatabaseUpdater::renameExtensionIndex	(	$tableName,
		$oldIndexName,
		$newIndexName,
		$sqlPath,
		$skipBothIndexExistWarning = `false`
	)

Rename an index on an extension table Intended for use in LoadExtensionSchemaUpdates hook handlers.

Since: 1.21

Parameters

string	$tableName	The table name
string	$oldIndexName	The old index name
string	$newIndexName	The new index name
string	$sqlPath	The path to the SQL change path
bool	$skipBothIndexExistWarning	Whether to warn if both the old and the new indexes exist. [facultative; by default, false]

Definition at line 370 of file DatabaseUpdater.php.

References true.

◆ renameIndex()

DatabaseUpdater::renameIndex	(	$table,
		$oldIndex,
		$newIndex,
		$skipBothIndexExistWarning,
		$patch,
		$fullpath = `false`
	)

protected

Rename an index from an existing table.

Stability: stable: to override

Note: Code in a LoadExtensionSchemaUpdates handler should use renameExtensionIndex instead!

Parameters

string	$table	Name of the table to modify
string	$oldIndex	Old name of the index
string	$newIndex	New name of the index
bool	$skipBothIndexExistWarning	Whether to warn if both the old and the new indexes exist.
string	$patch	Path to the patch file
bool	$fullpath	Whether to treat $patch path as a relative or not

Returns: bool False if this was skipped because schema changes are skipped

Reimplemented in PostgresUpdater.

Definition at line 912 of file DatabaseUpdater.php.

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

◆ runMaintenance()

DatabaseUpdater::runMaintenance	(	$class,
		$script
	)

protected

Run a maintenance script.

This should only be used when the maintenance script must run before later updates. If later updates don't depend on the script, add it to DatabaseUpdater::$postDatabaseUpdateMaintenance instead.

The script's execute() method must return true to indicate successful completion, and must return false (or throw an exception) to indicate unsuccessful completion.

Note: Code in a LoadExtensionSchemaUpdates handler should use addExtensionUpdate instead!; protected since 1.35

Since: 1.32

Parameters

string	$class	Maintenance subclass
string	$script	Script path and filename, usually "maintenance/fooBar.php"

Definition at line 1082 of file DatabaseUpdater.php.

References output().

◆ runUpdates()

DatabaseUpdater::runUpdates	(	array	$updates,
			$passSelf
	)

private

Helper function for doUpdates()

Parameters

array	$updates	Array of updates to run
bool	$passSelf	Whether to pass this object we calling external functions

Definition at line 520 of file DatabaseUpdater.php.

Referenced by doUpdates().

◆ setAutoExtensionHookContainer()

DatabaseUpdater::setAutoExtensionHookContainer ( HookContainer $hookContainer )

Set the HookContainer to use for loading extension schema updates.

Access: internal: For use by DatabaseInstaller

Since: 1.36

Parameters

HookContainer $hookContainer

Definition at line 227 of file DatabaseUpdater.php.

◆ setFileAccess()

DatabaseUpdater::setFileAccess ( )

Set any .htaccess files or equivilent for storage repos.

Some zones (e.g. "temp") used to be public and may have been initialized as such

Definition at line 1097 of file DatabaseUpdater.php.

References output().

◆ tableExists()

DatabaseUpdater::tableExists ( $tableName )

Since: 1.20

Parameters

string $tableName

Returns: bool

Definition at line 417 of file DatabaseUpdater.php.

Referenced by migrateImageCommentTemp().

◆ updateRowExists()

DatabaseUpdater::updateRowExists ( $key )

Helper function: check if the given key is present in the updatelog table.

Obviously, only use this for updates that occur after the updatelog table was created!

Parameters

string $key Name of the key to check for

Returns: bool

Definition at line 553 of file DatabaseUpdater.php.

Referenced by MysqlUpdater\dropDefault(), migrateActors(), migrateComments(), modifyField(), modifyTable(), populateContentTables(), and populateExternallinksIndex60().

◆ writeSchemaUpdateFile()

DatabaseUpdater::writeSchemaUpdateFile ( array $schemaUpdate = [] )

private

Since: 1.21

Writes the schema updates desired to a file for the DB Admin to run.

Parameters

array $schemaUpdate

Definition at line 458 of file DatabaseUpdater.php.

References $args.

Referenced by doUpdates().

Member Data Documentation

◆ $autoExtensionHookContainer

HookContainer null DatabaseUpdater::$autoExtensionHookContainer

protected

Definition at line 78 of file DatabaseUpdater.php.

◆ $db

IMaintainableDatabase DatabaseUpdater::$db

protected

Handle to the database subclass.

Definition at line 68 of file DatabaseUpdater.php.

◆ $extensionUpdates

array DatabaseUpdater::$extensionUpdates = []

protected

List of extension-provided database updates.

Definition at line 61 of file DatabaseUpdater.php.

◆ $fileHandle

resource null DatabaseUpdater::$fileHandle = null

protected

File handle for SQL output.

Definition at line 105 of file DatabaseUpdater.php.

◆ $maintenance

Maintenance DatabaseUpdater::$maintenance

protected

Definition at line 73 of file DatabaseUpdater.php.

◆ $postDatabaseUpdateMaintenance

string [] DatabaseUpdater::$postDatabaseUpdateMaintenance

protected

Initial value:

= [
        DeleteDefaultMessages::class,
        PopulateRevisionLength::class,
        PopulateRevisionSha1::class,
        PopulateImageSha1::class,
        FixExtLinksProtocolRelative::class,
        PopulateFilearchiveSha1::class,
        PopulateBacklinkNamespace::class,
        FixDefaultJsonContentPages::class,
        CleanupEmptyCategories::class,
        AddRFCandPMIDInterwiki::class,
        PopulatePPSortKey::class,
        PopulateIpChanges::class,
        RefreshExternallinksIndex::class,
    ]

Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance.

Definition at line 84 of file DatabaseUpdater.php.

◆ $shared

DatabaseUpdater::$shared = false

protected

Definition at line 75 of file DatabaseUpdater.php.

Referenced by __construct(), and newForDB().

◆ $skipSchema

bool DatabaseUpdater::$skipSchema = false

protected

Flag specifying whether or not to skip schema (e.g.

SQL-only) updates.

Definition at line 112 of file DatabaseUpdater.php.

◆ $updates

array DatabaseUpdater::$updates = []

protected

Array of updates to perform on the database.

Definition at line 48 of file DatabaseUpdater.php.

◆ $updatesSkipped

array DatabaseUpdater::$updatesSkipped = []

protected

Array of updates that were skipped.

Definition at line 55 of file DatabaseUpdater.php.

◆ REPLICATION_WAIT_TIMEOUT

const DatabaseUpdater::REPLICATION_WAIT_TIMEOUT = 300

Definition at line 41 of file DatabaseUpdater.php.

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

includes/installer/DatabaseUpdater.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExtensionField()

◆ addExtensionIndex()

◆ addExtensionTable()

◆ addExtensionUpdate()

◆ addField()

◆ addIndex()

◆ addIndexIfNoneExist()

◆ addPostDatabaseUpdateMaintenance()

◆ addTable()

◆ appendLine()

◆ applyPatch()

◆ canUseNewUpdatelog()

◆ checkStats()

◆ copyFile()

◆ doCollationUpdate()

◆ doTable()

◆ doUpdates()

◆ dropExtensionField()

◆ dropExtensionIndex()

◆ dropExtensionTable()

◆ dropField()

◆ dropIndex()

◆ dropTable()

◆ getCoreUpdateList()

◆ getDB()

◆ getExtensionUpdates()

◆ getPostDatabaseUpdateMaintenance()

◆ getSchemaVars()

◆ ifFieldExists()

◆ ifNoActorTable()

◆ ifTableNotExists()

◆ insertUpdateRow()

◆ loadExtensions()

◆ loadExtensionSchemaUpdates()

◆ migrateActors()

◆ migrateArchiveText()

◆ migrateComments()

◆ migrateImageCommentTemp()

◆ modifyExtensionField()

◆ modifyExtensionTable()

◆ modifyField()

◆ modifyTable()

◆ newForDB()

◆ output()

◆ patchPath()

◆ populateArchiveRevId()

◆ populateContentTables()

◆ populateExternallinksIndex60()

◆ purgeCache()

◆ rebuildLocalisationCache()

◆ renameExtensionIndex()

◆ renameIndex()

◆ runMaintenance()

◆ runUpdates()

◆ setAutoExtensionHookContainer()

◆ setFileAccess()

◆ tableExists()

◆ updateRowExists()

◆ writeSchemaUpdateFile()

Member Data Documentation

◆ $autoExtensionHookContainer

◆ $db

◆ $extensionUpdates

◆ $fileHandle

◆ $maintenance

◆ $postDatabaseUpdateMaintenance

◆ $shared

◆ $skipSchema

◆ $updates

◆ $updatesSkipped