MediaWiki  1.29.1
PostgresUpdater Class Reference

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

Inheritance diagram for PostgresUpdater:
Collaboration diagram for PostgresUpdater:

Public Member Functions

 addPgExtIndex ( $table, $index, $type)
 
 addPgIndex ( $table, $index, $type)
 
 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) More...
 
 addExtensionUpdate (array $update)
 Add a new update coming from an extension. More...
 
 addPostDatabaseUpdateMaintenance ( $class)
 Add a maintenance script to be run after the database updates are complete. More...
 
 appendLine ( $line)
 Append a line to the open filehandle. More...
 
 copyFile ( $filename)
 Append an SQL fragment to the open file handle. More...
 
 doUpdates (array $what=[ 'core', 'extensions', 'stats'])
 Do all the updates. More...
 
 dropExtensionField ( $tableName, $columnName, $sqlPath)
 
 dropExtensionIndex ( $tableName, $indexName, $sqlPath)
 Drop an index from an extension table. More...
 
 dropExtensionTable ( $tableName, $sqlPath)
 
 dropTable ( $table, $patch=false, $fullpath=false)
 If the specified table exists, drop it, or execute the patch if one is provided. More...
 
 getDB ()
 Get a database connection to run updates. More...
 
 getPostDatabaseUpdateMaintenance ()
 
 getSchemaVars ()
 Get appropriate schema variables in the current database connection. More...
 
 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! More...
 
 modifyExtensionField ( $tableName, $fieldName, $sqlPath)
 
 modifyField ( $table, $field, $patch, $fullpath=false)
 Modify an existing field. More...
 
 output ( $str)
 Output some text. More...
 
 patchPath (IDatabase $db, $patch)
 Get the full path of a patch file. More...
 
 purgeCache ()
 Purge the objectcache table. More...
 
 renameExtensionIndex ( $tableName, $oldIndexName, $newIndexName, $sqlPath, $skipBothIndexExistWarning=false)
 Rename an index on an extension table. More...
 
 setFileAccess ()
 Set any .htaccess files or equivilent for storage repos. More...
 
 tableExists ( $tableName)
 
 updateRowExists ( $key)
 Helper function: check if the given key is present in the updatelog table. More...
 

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)
 
 checkIndex ( $index, $should_be, $good_def)
 
 checkIwlPrefix ()
 
 checkOiDeleted ()
 
 checkOiNameConstraint ()
 
 checkPageDeletedTrigger ()
 
 checkRevUserFkey ()
 
 convertArchive2 ()
 
 describeTable ( $table)
 
 dropFkey ( $table, $field)
 
 dropIndex ( $table, $index, $patch='', $fullpath=false)
 Drop an index from an existing table. More...
 
 getCoreUpdateList ()
 
 getOldGlobalUpdates ()
 Before 1.17, we used to handle updates via stuff like $wgExtNewTables/Fields/Indexes. More...
 
 rebuildTextSearch ()
 
 renameIndex ( $table, $old, $new, $skipBothIndexExistWarning=false, $a=false, $b=false)
 Rename an index from an existing table. More...
 
 renameSequence ( $old, $new)
 
 renameTable ( $old, $new, $patch=false)
 
 setDefault ( $table, $field, $default)
 
 tsearchFixes ()
 
- Protected Member Functions inherited from DatabaseUpdater
 __construct (Database &$db, $shared, Maintenance $maintenance=null)
 Constructor. More...
 
 addField ( $table, $field, $patch, $fullpath=false)
 Add a new field to an existing table. More...
 
 addIndex ( $table, $index, $patch, $fullpath=false)
 Add a new index to an existing table. More...
 
 addTable ( $name, $patch, $fullpath=false)
 Add a new table to the database. More...
 
 applyPatch ( $path, $isFullPath=false, $msg=null)
 Applies a SQL patch. More...
 
 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). More...
 
 checkStats ()
 Check the site_stats table is not properly populated. More...
 
 disableContentHandlerUseDB ()
 Turns off content handler fields during parts of the upgrade where they aren't available. More...
 
 doActiveUsersInit ()
 Sets the number of active users in the site_stats table. More...
 
 doCollationUpdate ()
 Update CategoryLinks collation. More...
 
 doEnableProfiling ()
 Enable profiling table when it's turned on. More...
 
 doLogSearchPopulation ()
 Migrate log params to new table and index for searching. More...
 
 doLogUsertextPopulation ()
 Populates the log_user_text field in the logging table. More...
 
 doMigrateUserOptions ()
 Migrates user options from the user table blob to user_properties. More...
 
 doTable ( $name)
 Returns whether updates should be executed on the database table $name. More...
 
 doUpdateTranscacheField ()
 Updates the timestamps in the transcache table. More...
 
 dropField ( $table, $field, $patch, $fullpath=false)
 Drop a field from an existing table. More...
 
 enableContentHandlerUseDB ()
 Turns content handler fields back on. More...
 
 getExtensionUpdates ()
 Get the list of extension-defined updates. More...
 
 rebuildLocalisationCache ()
 Rebuilds the localisation cache. More...
 

Protected Attributes

DatabasePostgres $db
 
- Protected Attributes inherited from DatabaseUpdater
Database $db
 Handle to the database subclass. More...
 
array $extensionUpdates = []
 List of extension-provided database updates. More...
 
resource $fileHandle = null
 File handle for SQL output. More...
 
 $holdContentHandlerUseDB = true
 Hold the value of $wgContentHandlerUseDB during the upgrade. More...
 
Maintenance $maintenance
 
string[] $postDatabaseUpdateMaintenance
 Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance. More...
 
 $shared = false
 
bool $skipSchema = false
 Flag specifying whether or not to skip schema (e.g. More...
 
array $updates = []
 Array of updates to perform on the database. More...
 
array $updatesSkipped = []
 Array of updates that were skipped. More...
 

Additional Inherited Members

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

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 967 of file PostgresUpdater.php.

References DatabaseUpdater\applyPatch().

◆ addPgExtIndex()

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

◆ addPgField()

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

Definition at line 687 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ addPgIndex()

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

Definition at line 787 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ addSequence()

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

Definition at line 619 of file PostgresUpdater.php.

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

◆ changeField()

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

Definition at line 699 of file PostgresUpdater.php.

References $res, and DatabaseUpdater\output().

◆ changeFieldPurgeTable()

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

Definition at line 724 of file PostgresUpdater.php.

References $res, and DatabaseUpdater\output().

◆ changeFkeyDeferrable()

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

Definition at line 827 of file PostgresUpdater.php.

References $command, and DatabaseUpdater\output().

◆ changeNullableField()

PostgresUpdater::changeNullableField (   $table,
  $field,
  $null 
)
protected

Definition at line 762 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkIndex()

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

Definition at line 927 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkIwlPrefix()

PostgresUpdater::checkIwlPrefix ( )
protected

Definition at line 957 of file PostgresUpdater.php.

References DatabaseUpdater\applyPatch().

◆ checkOiDeleted()

PostgresUpdater::checkOiDeleted ( )
protected

Definition at line 875 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkOiNameConstraint()

PostgresUpdater::checkOiNameConstraint ( )
protected

Definition at line 887 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ checkPageDeletedTrigger()

PostgresUpdater::checkPageDeletedTrigger ( )
protected

Definition at line 908 of file PostgresUpdater.php.

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

◆ checkRevUserFkey()

PostgresUpdater::checkRevUserFkey ( )
protected

◆ convertArchive2()

PostgresUpdater::convertArchive2 ( )
protected

Definition at line 855 of file PostgresUpdater.php.

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

◆ describeIndex()

PostgresUpdater::describeIndex (   $idx)

Definition at line 522 of file PostgresUpdater.php.

References $query, $res, as, and FROM.

◆ describeTable()

PostgresUpdater::describeTable (   $table)
protected

Definition at line 497 of file PostgresUpdater.php.

References $res, as, and FROM.

◆ dropFkey()

PostgresUpdater::dropFkey (   $table,
  $field 
)
protected

Definition at line 809 of file PostgresUpdater.php.

References $command, and DatabaseUpdater\output().

◆ dropIndex()

PostgresUpdater::dropIndex (   $table,
  $index,
  $patch = '',
  $fullpath = false 
)
protected

Drop an index from an existing table.

Parameters
string$tableName of the table to modify
string$indexName of the index
string$patchPath to the patch file
bool$fullpathWhether 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 920 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ fkeyDeltype()

PostgresUpdater::fkeyDeltype (   $fkey)

Definition at line 573 of file PostgresUpdater.php.

References FROM.

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.

◆ 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 458 of file PostgresUpdater.php.

References DatabaseUpdater\$updates, as, global, and true.

◆ rebuildTextSearch()

PostgresUpdater::rebuildTextSearch ( )
protected

◆ renameIndex()

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

Rename an index from an existing table.

Parameters
string$tableName of the table to modify
string$oldIndexOld name of the index
string$newIndexNew name of the index
bool$skipBothIndexExistWarningWhether to warn if both the old and the new indexes exist.
string$patchPath to the patch file
bool$fullpathWhether 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 653 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ renameSequence()

PostgresUpdater::renameSequence (   $old,
  $new 
)
protected

Definition at line 629 of file PostgresUpdater.php.

References DatabaseUpdater\output().

◆ renameTable()

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

Definition at line 641 of file PostgresUpdater.php.

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

◆ ruleDef()

PostgresUpdater::ruleDef (   $table,
  $rule 
)

Definition at line 595 of file PostgresUpdater.php.

References definition, and FROM.

◆ setDefault()

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

Definition at line 753 of file PostgresUpdater.php.

References DatabaseUpdater\output().

Referenced by addSequence().

◆ tsearchFixes()

PostgresUpdater::tsearchFixes ( )
protected

Definition at line 971 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: