View source for Help:Upgrade/Upgrade from SMW 2.5 to SMW 3.1

{{Installation
 |Displaytitle=Upgrade from SMW 2.5.x to SMW 3.1.x (MW 1.31.0 to MW 1.33.x)
 |Description=This page describes the upgrade procedure from SMW 2.5.x to SMW 3.1.x (native Composer support). 
 |Installation type=upgrade
 |Installation method=Composer
 |video=
 |mediawikiMinVersion=1.31.0 to 1.33.x
}}
This help page describes the '''upgrade procedure''' from Semantic MediaWiki 2.5.x to Semantic MediaWiki 3.1.x with native [[Help:Using Composer|Composer support]].

{{Callout
 |
* Note that this help page assumes that you use MediaWiki '''1.31.0 to 1.33.x'''. See also the help page on [[Help:Compatibility|compatibility]].
* Since SMW 2.5.x '''is not compatible''' with 1.31.0 to 1.33.x you must either upgrade to SMW 3.0.x to SMW 3.1.x (preferred).
 |info
}}

== Step 1 - Backup database and wiki ==
Backup your wiki database and wiki installation.

== Step 2 - Update setup file ==
Change to the base directory of your wiki[[CiteRef::install:base:dir]] in your server's shell and modify the "composer.local.json" file to look like this[[CiteRef::install:software]]:
<syntaxhighlight lang="json">
{
	"require": {
                  "mediawiki/semantic-media-wiki": "~3.1.0"
        }
}
</syntaxhighlight>

== Step 3 - Update software ==
Run the composer command[[CiteRef::install:composer]][[CiteRef::install:composer:base]] from the base directory of your wiki[[CiteRef::install:base:dir]] in your server's shell to upgrade the source code of Semantic MediaWiki and dependencies:
<syntaxhighlight lang="json">
php composer.phar update --no-dev
</syntaxhighlight>

== Step 4 - Invoke Semantic MediaWiki ==
Add the following line to the end of your "LocalSettings.php" file:

<syntaxhighlight lang="php">
enableSemantics( 'example.org' );
</syntaxhighlight>

Note that "example.org" should be replaced by your wiki's domain.

== Step 5 - Update database ==
Run {{MaintenanceScript|update.php|mwo=1}} from the base directory of your wiki[[CiteRef::install:base:dir]] in your server's shell to apply the schema changes to your wiki's database:
<syntaxhighlight lang="json">
php maintenance/update.php
</syntaxhighlight>
Or alternatively use {{MaintenanceScript|setupStore.php}}:
<syntaxhighlight lang="json">
php extensions/SemanticMediaWiki/maintenance/setupStore.php -v
</syntaxhighlight>

== Step 6 - Update database cont. ==
If you see the [[Help:Upgrade/Incomplete upgrade|upgrade information error message]] on your wiki's pages run {{MaintenanceScript|populateHashField.php}} from the base directory of your wiki[[CiteRef::install:base:dir]] in your server's shell to apply further changes to your wiki's database:
<syntaxhighlight lang="json">
php extensions/SemanticMediaWiki/maintenance/populateHashField.php -v
</syntaxhighlight>
{{Callout
 |If you '''do not''' see the [[Help:Upgrade/Incomplete upgrade|upgrade information error message]] on your wiki's pages you may skip this step and directly do the next one.
 |info
}}

== Step 7 - Rebuild data ==
Run {{MaintenanceScript|rebuildData.php}} from the base directory of your wiki[[CiteRef::install:base:dir]] in your server's shell to rebuild the semantic data in wiki's database:
<syntaxhighlight lang="json">
php extensions/SemanticMediaWiki/maintenance/rebuildData.php -v --with-maintenance-log
</syntaxhighlight>

== Step 8 - Update configuration ==
Go to the [[Help:Special:SemanticMediaWiki/Deprecation_notices|"Deprecation notices" tab]] on {{SpecialPage|SemanticMediaWiki}} and update your wiki's "LocalSettings.php" file according to the information provided on that page.
{{Callout
 |If you '''do not''' see the [[Help:Special:SemanticMediaWiki/Deprecation_notices|"Deprecation notices" tab]] on  on your wiki's {{SpecialPage|SemanticMediaWiki}} you may skip this step and you are done.
 |info
}}
{{Callout
 |Some changes to the settings of configuration parameters may require you to rebuild the wiki's semantic data again. This is documented on each configuration parameters documentation page. In this case go back to [[#Step 6 - Rebuild data|step 6]].
}}

== Done! ==
Semantic MediaWiki and the database use should now be upgraded properly. The wiki may now be used again.

{{Callout
 |'''{{Release|3.0.0}} brought deliberate syntax changes which may affect your wiki. Thus have a look at the [https://github.com/SemanticMediaWiki/SemanticMediaWiki/blob/master/docs/technical/migration-guide-3.0.md#migration-guide migration guide] for further information.'''
 |error
}}

== See also ==
* Help page on [[Help:Upgrade|upgrading]]
* Help page on [[Help:Using Composer|using Composer]]
* Help page on [[Help:Installation/Troubleshooting|troubleshooting]]

{{#set: Docinfo_language =en }}
{{doc.info
 |master page=Help:Upgrade/Upgrade_from_SMW_2.5_to_SMW_3.1
 |status=effective
 |progress=100
 |priority=1
 |minversion=3.1.0
}}
[[Category:Upgrade]]