Con­figu­ration para­meter "$smwg­Upgrade­Key"

From semantic-mediawiki.org
Configuration parameter details:
Name $smwgUpgradeKey
Description Sets the current database schema version
Default setting See below
Software Semantic MediaWiki
Since version
Until version still available
Configuration Internal
Keyword data store · setup · upgrade · update · internal


$smwgUpgradeKey is an internal configuration parameter that sets the current database schema version for Semantic MediaWiki. The configuration parameter was introduced in Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x.123 and adapted in Semantic MediaWiki 3.0.1Released on 25 January 2019 and compatible with MW 1.27.0 - 1.31.x.4.

The setting to this configuration parameter allows to verify that a complete setup, update or upgrade using maintenance script "setupStore.php"Allows to set up the data backend/store or maintenance script "update.php" (MediaWiki.org) was done and hereby ensures a consistent database setup.

The page shown if "update.php" was not run after upgrading Semantic MediaWiki. (en)

If the maintenance script was not run an "Update Error Screen" will be shown. Once the maintenance script was run, the ".smw.json" file will be updated and no longer causes the exception described.

See the help page on upgrading and on the setup information file for detailed information.

It is possible to configure the location where the ".smw.json" file is located via configuration parameter $smwgConfigFileDirSets the directory for storing the setup information file ensuring database consistency which defaults to Semantic MediaWiki's root directory.

Default setting[edit]

$smwgUpgradeKey => 'smw:2018-09-01';
// Key at the time of the release of SMW 3.0.1

This means that wiki instances with a different upgrade key will be noted prominently about a required database update.

Changing the default setting[edit]

This configuration parameter must not be modified manually by wiki system administrators or administrators.

Whenever a database table change occurs, the setting to this configuration parameter (smw:YYYY-MM-DD) is changed by the programmers of extension "Semantic MediaWiki"Allows to store and query data annotated to pages only to reflect the requirement for the wiki administrator to follow the processes as outlined in the installation, update and upgrade manual.

See also[edit]