Inherits MediaWiki\Installer\DatabaseUpdater.

Collaboration diagram for MediaWiki\Installer\MysqlUpdater:

[legend]

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

Public Member Functions inherited from MediaWiki\Installer\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.

	addExtensionUpdateOnVirtualDomain (array $update)
	Add a new update coming from an extension on virtual domain databases.

	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.

	fieldExists ( $tableName, $fieldName)

	getDB ()
	Get a database connection to run updates.

	getPostDatabaseUpdateMaintenance ()

	insertInitialUpdateKeys ()
	Add initial keys to the updatelog table.

	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.

	outputApplied (string $str)
	Output a note about an update that has already been applied.

	outputAppliedSummary ()
	If notes about updates that have already been applied are silenced, output a message with the count of skipped updates.

	patchPath (IDatabase $db, $patch)
	Get the full path to 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
	changeTableOption (string $table, string $tableOption, string $updateName)
	Change the table options of a table.

	dropDefault ( $table, $field)
	Drops the default value from a field.

	getCoreUpdateList ()
	Get an array of updates to perform on the database.Should return a multidimensional array. The main key is the MediaWiki version (1.12, 1.13...) with the values being arrays of updates. Returns array[]

	getInitialUpdateKeys ()
	Get an array of update keys to insert into the updatelog table after a new installation.The named operations will then be skipped by a subsequent update.Add keys here to skip updates that are redundant or harmful on a new installation, for example reducing field sizes, adding constraints, etc. Returns string[]

	migrateSearchindex ()

	setDefault ( $table, $field, $default)
	Set a default value for a field.

Protected Member Functions inherited from MediaWiki\Installer\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 file handle.

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

	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.

	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.

	migrateCategorylinks ()

	migrateImagelinks ()

	migratePagelinks ()

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

	modifyFieldIfNullable ( $table, $field, $patch, $fullpath=false)
	Modify a field if the field exists and is nullable.

	modifyPrimaryKey ( $table, array $columns, $patch, $fullpath=false)
	Modify or set a PRIMARY KEY on a table.

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

	modifyTableIfFieldNotExists ( $table, $field, $patch, $fullpath=false, $fieldBeingModified=null)
	Modify a table if a field doesn't exist.

	normalizeCollation ()

	rebuildLocalisationCache ()
	Rebuilds the localisation cache.

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

	runMaintenance ( $class, $unused='')
	Run a maintenance script.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Installer\DatabaseUpdater
static	newForDB (IMaintainableDatabase $db, $shared=false, ?Maintenance $maintenance=null)

Public Attributes inherited from MediaWiki\Installer\DatabaseUpdater
int	$appliedUpdateCount = 0
	When not outputting notes about already applied updates, their number if stored here.

bool	$logApplied = false
	Flag specifying whether to output notes about updates that were already applied.

const	REPLICATION_WAIT_TIMEOUT = 300

Protected Attributes inherited from MediaWiki\Installer\DatabaseUpdater
HookContainer null	$autoExtensionHookContainer

IMaintainableDatabase	$db
	Handle to the database subclass.

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

array	$extensionUpdatesWithVirtualDomains = []
	List of extension-provided database updates on virtual domain dbs.

resource null	$fileHandle = null
	File handle for SQL output.

Maintenance	$maintenance

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

bool	$shared = false

bool	$skipSchema = false
	Flag specifying whether to skip schema (e.g., SQL-only) updates.

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

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

Detailed Description

Definition at line 27 of file MysqlUpdater.php.

Member Function Documentation

◆ changeTableOption()

MediaWiki\Installer\MysqlUpdater::changeTableOption	(	string	$table,
		string	$tableOption,
		string	$updateName )

protected

Change the table options of a table.

Since: 1.43

Parameters

string	$table
string	$tableOption	Raw table option that should already have been escaped !!!!
string	$updateName

Definition at line 182 of file MysqlUpdater.php.

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

◆ dropDefault()

MediaWiki\Installer\MysqlUpdater::dropDefault	(		$table,
			$field )

protected

Drops the default value from a field.

Since: 1.36

Parameters

string	$table
string	$field

Definition at line 135 of file MysqlUpdater.php.

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

◆ getCoreUpdateList()

MediaWiki\Installer\MysqlUpdater::getCoreUpdateList ( )

protected

Get an array of updates to perform on the database.Should return a multidimensional array. The main key is the MediaWiki version (1.12, 1.13...) with the values being arrays of updates.

Returns: array[]

Reimplemented from MediaWiki\Installer\DatabaseUpdater.

Definition at line 29 of file MysqlUpdater.php.

◆ getInitialUpdateKeys()

MediaWiki\Installer\MysqlUpdater::getInitialUpdateKeys ( )

protected

Get an array of update keys to insert into the updatelog table after a new installation.The named operations will then be skipped by a subsequent update.Add keys here to skip updates that are redundant or harmful on a new installation, for example reducing field sizes, adding constraints, etc.

Returns: string[]

Reimplemented from MediaWiki\Installer\DatabaseUpdater.

Definition at line 102 of file MysqlUpdater.php.

◆ getSchemaVars()

MediaWiki\Installer\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 MediaWiki\Installer\DatabaseUpdater.

Definition at line 114 of file MysqlUpdater.php.

References $wgDBTableOptions.

◆ migrateSearchindex()

MediaWiki\Installer\MysqlUpdater::migrateSearchindex ( )

protected

Definition at line 200 of file MysqlUpdater.php.

References MediaWiki\Installer\DatabaseUpdater\applyPatch(), MediaWiki\Installer\DatabaseUpdater\insertUpdateRow(), MediaWiki\Installer\DatabaseUpdater\outputApplied(), MediaWiki\Installer\DatabaseUpdater\tableExists(), and MediaWiki\Installer\DatabaseUpdater\updateRowExists().

◆ setDefault()

MediaWiki\Installer\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 162 of file MysqlUpdater.php.

References MediaWiki\Installer\DatabaseUpdater\output().

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

◆ changeTableOption()

◆ dropDefault()

◆ getCoreUpdateList()

◆ getInitialUpdateKeys()

◆ getSchemaVars()

◆ migrateSearchindex()

◆ setDefault()