Class for handling updates to Postgres databases. More...

Inheritance diagram for PostgresUpdater:

Collaboration diagram for PostgresUpdater:

[legend]

Public Member Functions
	addPgEnumValue ( $type, $value)
	Add a value to an existing PostgreSQL enum type.

	addPgExtIndex ( $table, $index, $type)

	addPgIndex ( $table, $index, $type, $unique=false)

	describeIndex ( $idx)

	fkeyDeltype ( $fkey)

	ruleDef ( $table, $rule)

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.

Protected Member Functions
	addInterwikiType ()

	addPgField ( $table, $field, $type)

	addSequence ( $table, $pkey, $ns)

	changeField ( $table, $field, $newtype, $default)

	changeFieldPurgeTable ( $table, $field, $newtype, $default)

	changeFkeyDeferrable ( $table, $field, $clause)

	changeNullableField ( $table, $field, $null, $update=false)

	checkIndex ( $index, $should_be, $good_def)

	checkIwlPrefix ()

	checkOiDeleted ()

	checkOiNameConstraint ()

	checkPageDeletedTrigger ()

	checkRevUserFkey ()

	convertArchive2 ()

	describeTable ( $table)

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

	dropFkey ( $table, $field)

	dropPgField ( $table, $field)

	dropPgIndex ( $table, $index)

	dropSequence ( $table, $ns)

	getCoreUpdateList ()

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

	rebuildTextSearch ()

	renameIndex ( $table, $old, $new, $skipBothIndexExistWarning=false, $a=false, $b=false)
	Rename an index from an existing table.

	renameSequence ( $old, $new)

	renameTable ( $old, $new, $patch=false)

	setDefault ( $table, $field, $default)

	setSequenceOwner ( $table, $pkey, $seq)

	tsearchFixes ()

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.

	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.

	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.

	ifNoActorTable ( $func,... $params)
	Only run a function if the `actor` 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.

	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.

Protected Attributes
DatabasePostgres	$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
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 handling updates to Postgres databases.

Since: 1.17

Definition at line 32 of file PostgresUpdater.php.

Member Function Documentation

◆ addInterwikiType()

PostgresUpdater::addInterwikiType ( )

protected

Definition at line 1258 of file PostgresUpdater.php.

References DatabaseUpdater\applyPatch().

◆ addPgEnumValue()

PostgresUpdater::addPgEnumValue	(	$type,
		$value
	)

Add a value to an existing PostgreSQL enum type.

Since: 1.31

Parameters

string	$type	Type name. Must be in the core schema.
string	$value	Value to add.

Definition at line 1066 of file PostgresUpdater.php.

References $type, and DatabaseUpdater\output().

◆ addPgExtIndex()

PostgresUpdater::addPgExtIndex	(	$table,
		$index,
		$type
	)

Definition at line 1049 of file PostgresUpdater.php.

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

◆ addPgField()

PostgresUpdater::addPgField	(	$table,
		$field,
		$type
	)

protected

Definition at line 923 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ addPgIndex()

PostgresUpdater::addPgIndex	(	$table,
		$index,
		$type,
		$unique = `false`
	)

Definition at line 1039 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ addSequence()

PostgresUpdater::addSequence	(	$table,
		$pkey,
		$ns
	)

protected

Definition at line 826 of file PostgresUpdater.php.

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

◆ changeField()

PostgresUpdater::changeField	(	$table,
		$field,
		$newtype,
		$default
	)

protected

Definition at line 935 of file PostgresUpdater.php.

References $res, and DatabaseUpdater\output().

◆ changeFieldPurgeTable()

PostgresUpdater::changeFieldPurgeTable	(	$table,
		$field,
		$newtype,
		$default
	)

protected

Definition at line 960 of file PostgresUpdater.php.

References $res, and DatabaseUpdater\output().

◆ changeFkeyDeferrable()

PostgresUpdater::changeFkeyDeferrable	(	$table,
		$field,
		$clause
	)

protected

Definition at line 1118 of file PostgresUpdater.php.

References $command, and DatabaseUpdater\output().

◆ changeNullableField()

PostgresUpdater::changeNullableField	(	$table,
		$field,
		$null,
		$update = `false`
	)

protected

Definition at line 1012 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkIndex()

PostgresUpdater::checkIndex	(	$index,
		$should_be,
		$good_def
	)

protected

Definition at line 1218 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkIwlPrefix()

PostgresUpdater::checkIwlPrefix ( )

protected

Definition at line 1248 of file PostgresUpdater.php.

References DatabaseUpdater\applyPatch().

◆ checkOiDeleted()

PostgresUpdater::checkOiDeleted ( )

protected

Definition at line 1166 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkOiNameConstraint()

PostgresUpdater::checkOiNameConstraint ( )

protected

Definition at line 1178 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkPageDeletedTrigger()

PostgresUpdater::checkPageDeletedTrigger ( )

protected

Definition at line 1199 of file PostgresUpdater.php.

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

◆ checkRevUserFkey()

PostgresUpdater::checkRevUserFkey ( )

protected

Definition at line 1236 of file PostgresUpdater.php.

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

◆ convertArchive2()

PostgresUpdater::convertArchive2 ( )

protected

Definition at line 1146 of file PostgresUpdater.php.

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

◆ describeIndex()

PostgresUpdater::describeIndex ( $idx )

Definition at line 729 of file PostgresUpdater.php.

References $res.

◆ describeTable()

PostgresUpdater::describeTable ( $table )

protected

Definition at line 704 of file PostgresUpdater.php.

References $res.

◆ dropDefault()

PostgresUpdater::dropDefault	(	$table,
		$field
	)

protected

Drop a default value from a field.

Since: 1.32

Parameters

string	$table
string	$field

Definition at line 1004 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ dropFkey()

PostgresUpdater::dropFkey	(	$table,
		$field
	)

protected

Definition at line 1100 of file PostgresUpdater.php.

References $command, and DatabaseUpdater\output().

◆ dropPgField()

PostgresUpdater::dropPgField	(	$table,
		$field
	)

protected

Definition at line 911 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ dropPgIndex()

PostgresUpdater::dropPgIndex	(	$table,
		$index
	)

protected

Definition at line 1211 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ dropSequence()

PostgresUpdater::dropSequence	(	$table,
		$ns
	)

protected

Definition at line 838 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ fkeyDeltype()

PostgresUpdater::fkeyDeltype ( $fkey )

Definition at line 780 of file PostgresUpdater.php.

Referenced by checkRevUserFkey().

◆ getCoreUpdateList()

PostgresUpdater::getCoreUpdateList ( )

protected

Todo:: FIXME: Postgres should use sequential updates like Mysql, Sqlite and everybody else. It never got refactored like it should've.

Returns: array

Reimplemented from DatabaseUpdater.

Definition at line 44 of file PostgresUpdater.php.

References true.

◆ getOldGlobalUpdates()

PostgresUpdater::getOldGlobalUpdates ( )

protected

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

This is nasty :) We refactored a lot of this in 1.17 but we want to remain back-compatible for a while. So load up these old global-based things into our update list.

Returns: array

Reimplemented from DatabaseUpdater.

Definition at line 665 of file PostgresUpdater.php.

References DatabaseUpdater\$updates, and true.

◆ rebuildTextSearch()

PostgresUpdater::rebuildTextSearch ( )

protected

Definition at line 1275 of file PostgresUpdater.php.

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

◆ renameIndex()

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

protected

Rename an index from an existing table.

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

Definition at line 876 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ renameSequence()

PostgresUpdater::renameSequence	(	$old,
		$new
	)

protected

Definition at line 845 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ renameTable()

PostgresUpdater::renameTable	(	$old,
		$new,
		$patch = `false`
	)

protected

Definition at line 864 of file PostgresUpdater.php.

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

◆ ruleDef()

PostgresUpdater::ruleDef	(	$table,
		$rule
	)

Definition at line 802 of file PostgresUpdater.php.

◆ setDefault()

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

protected

Definition at line 989 of file PostgresUpdater.php.

References DatabaseUpdater\output().

Referenced by addSequence().

◆ setSequenceOwner()

PostgresUpdater::setSequenceOwner	(	$table,
		$pkey,
		$seq
	)

protected

Definition at line 857 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ tsearchFixes()

PostgresUpdater::tsearchFixes ( )

protected

Definition at line 1262 of file PostgresUpdater.php.

References DatabaseUpdater\applyPatch().

Member Data Documentation

◆ $db

DatabasePostgres PostgresUpdater::$db

protected

Definition at line 37 of file PostgresUpdater.php.

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

includes/installer/PostgresUpdater.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addInterwikiType()

◆ addPgEnumValue()

◆ addPgExtIndex()

◆ addPgField()

◆ addPgIndex()

◆ addSequence()

◆ changeField()

◆ changeFieldPurgeTable()

◆ changeFkeyDeferrable()

◆ changeNullableField()

◆ checkIndex()

◆ checkIwlPrefix()

◆ checkOiDeleted()

◆ checkOiNameConstraint()

◆ checkPageDeletedTrigger()

◆ checkRevUserFkey()

◆ convertArchive2()

◆ describeIndex()

◆ describeTable()

◆ dropDefault()

◆ dropFkey()

◆ dropPgField()

◆ dropPgIndex()

◆ dropSequence()

◆ fkeyDeltype()

◆ getCoreUpdateList()

◆ getOldGlobalUpdates()

◆ rebuildTextSearch()

◆ renameIndex()

◆ renameSequence()

◆ renameTable()

◆ ruleDef()

◆ setDefault()

◆ setSequenceOwner()

◆ tsearchFixes()

Member Data Documentation

◆ $db