Help:Upgrade key

File:setup-check-error-schema-invalid-key.png

Error output when the setup check found an invalid upgrade key and blocks access to the wiki instance

The upgrade key is an internally generated key1 (stored as upgrade_key in the setup information file ".smw.json") to make a setup (or installation) comparable with a previous instance of the software. It provides the means to detect changes in Semantic MediaWiki that requires a system administrator to take appropriate actions before the setup check can release the block and before users start to interact with the software to ensure the integrity of the installed Semantic MediaWiki.

The key is generated from multiple sources that shape the database setup in terms of what sort of tables or fields (and indices) are required and currently include:

• $smwgUpgradeKeySets the current database schema version
• $smwgDefaultStoreSets the storage backend to be used for the semantic data
• $smwgPageSpecialPropertiesSets the page related special properties to be used
• $smwgFixedPropertiesSets user defined properties to have a dedicated database table for them
• $smwgEnabledFulltextSearchSets whether full-text search support for properties may be used
• $smwgFieldTypeFeaturesSets relational database specific field type features
• $smwgEntityCollationNo description was provided.2
• Setup::MINIMUM_DB_VERSION3

Technical notes

Software developers may modify the upgrade key directly to indicate that something has changed in regards to the internal database structure hereby ensures a new key is generated hereby forces the next install (or upgrade) to run either maintenance script "update.php" (MediaWiki.org) or maintenance script "setupStore.php"No description was provided..

A release manager may also modify the upgrade key setting in the "DefaultSettings.php" file to ensure that installs (or upgrades) with a new release do run either maintenance script "update.php" (MediaWiki.org) or maintenance script "setupStore.php"No description was provided..

See also

• Help page on the setup information file
• Help page on configuration parameter $smwgConfigFileDirSets the directory for storing the setup information file ensuring database consistency – Defines the location to which the setup information file is written
• Help page on configuration parameter $smwgUpgradeKeySets the current database schema version – An internal key that allows developers to indicate that a change of the database has occurred/is required
• File:Octocat.png "SetupFile.php" file. – Contains details on how the upgrade key is generated

#scite could not render a citation text for reference "gh:smw:4461" because type "pullrequest" was not assigned to a template.

#scite could not render a citation text for reference "gh:smw:4713" because type "pullrequest" was not assigned to a template.