MediaWiki\Installer\SqliteUpdater Class Reference
Inherits MediaWiki\Installer\DatabaseUpdater.
Collaboration diagram for MediaWiki\Installer\SqliteUpdater:
Protected Member Functions | |
| 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.
| |
| 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.
| |
 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 () | |
| migratePagelinks () | |
| migrateTemplatelinks () | |
| 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 | |
| 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 () | |
| getSchemaVars () | |
| Get appropriate schema variables in the current database connection. | |
| 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. | |
| 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. | |
| 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 | |
| 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 29 of file SqliteUpdater.php.
Member Function Documentation
◆ 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 32 of file SqliteUpdater.php.
◆ 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 107 of file SqliteUpdater.php.
The documentation for this class was generated from the following file:
- includes/Installer/SqliteUpdater.php
