Manual:DatabaseUpdater.php

---

MediaWiki file: DatabaseUpdater.php
Location:	includes/installer/
Source code:	master • 1.25.2 • 1.24.3
Classes:	DatabaseUpdater

DatabaseUpdater is the class for handling database updates (e.g. adding, modifying, and dropping database tables, fields, and indexes). MysqlUpdater.phpManual:MysqlUpdater.php, PostgresUpdater.phpManual:PostgresUpdater.php, SqliteUpdater.phpManual:SqliteUpdater.php, MssqlUpdater.phpManual:MssqlUpdater.php, and OracleUpdater.phpManual:OracleUpdater.php extend this class, and all five of those files (as well as the tables.sqlManual:tables.sql files for the various database types) potentially need to be revised when a core schema change is made. Extensions usually change the schema by means of LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates hook functions. Either way, SQL patch file(s) need to be created.

Functions

• addExtensionField ($tableName, $columnName, $sqlPath)
• addExtensionIndex ($tableName, $indexName, $sqlPath)
• addExtensionTable ($tableName, $sqlPath)
• addExtensionUpdate (array $update)
• addPostDatabaseUpdateMaintenance ($class)
• dropExtensionField ($tableName, $columnName, $sqlPath)
• dropExtensionIndex ($tableName, $indexName, $sqlPath)
• dropExtensionTable ($tableName, $sqlPath)
• dropTable ($table, $patch=false, $fullpath=false)
• getDB ()
• modifyExtensionField ($tableName, $fieldName, $sqlPath)
• modifyField ($table, $field, $patch, $fullpath=false)

DatabasesManual:Database layout

Engines: MySQLManual:MySQL – OracleManual:Oracle – PostgreSQLManual:PostgreSQL – SQLiteManual:SQLite Technical documentation: SchemaManual:Database layout (tablesCategory:MediaWiki database tables) – API property associationsAPI:Database field and API property associations – Field prefixesDatabase field prefixes – Primary key storage in other fieldsManual:Primary key storage in other fields – Wikimedia extension tablesCategory:Wikimedia extension database tables Configuration: SettingsManual:Configuration_settings#Database_settings – SharingManual:Shared database Development: AccessManual:Database access – OptimizationDatabase optimization – PolicyDevelopment policy#Database_patches – UpdaterManual:DatabaseUpdater.php – Extension schema updatesManual:Hooks/LoadExtensionSchemaUpdates – Patch fileManual:SQL patch file Core tables: archive – category – categorylinks – change_tag – config – externallinks – filearchive – hitcounter – image – imagelinks – interwiki – iwlinks – ipblocks – job – l10n_cache – langlinks – logging – log_search – msg_resource – msg_resource_links – module_deps – objectcache – oldimage – page – pagelinks – page_props – page_restrictions – protected_titles – querycache – querycachetwo – querycache_info – recentchanges – redirect – revision – searchindex – sites – site_stats – tag_summary – templatelinks – text – transcache – updatelog – uploadstash – user – user_former_groups – user_groups – user_newtalk – user_properties – valid_tag – watchlist