MySource Matrix Resources

Content Tools

Main Content

Upgrading MySource Matrix from v3.8.2 to v3.8.3

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.8.2 installation to version 3.8.3.

This upgrade requires you to have access to:

  • update the MySource Matrix source code
  • run database queries on the MySource Matrix database
  • upgrade MySource Matrix configuration files

This guide assumes that your MySource Matrix installation is located at /home/websites/mysource_matrix. Please change any commands to the appropriate location if your installation is located elsewhere.

If your system contains the commercial or premium modules, please contact Squiz for updated versions of the modules before proceeding with the upgrade.

The modules must be upgraded at the same time as the core system.

Who Needs To Use This Guide?

The upgrade from version 3.8.2 to 3.8.3 include upgrades to the database triggers used when rollback is enabled. They also include a performance-related upgrade to a stored procedure for PostgreSQL databases only.

Therefore this upgrade is applicable to:

  • those systems running on a PostgreSQL database, and
  • those systems using the rollback feature.

If your MySource Matrix system does not fall under either of the above categories (eg. an Oracle system that is not using rollback), you can use the general minor version upgrade guide instead. Otherwise, read on.

Stop Editing

Due to the need for database schema changes in this version, no editing should be taking place during this version upgrade. Before starting the upgrade, first ensure that all editors are logged out of the system.

Backup

Before starting any upgrade, always backup your MySource Matrix installation. See the MySource Matrix backup management guide for information on how to backup your MySource Matrix system.

Getting the New Source Code

The first thing you need to do is update the MySource Matrix source code. You can find out how to download the latest stable version of MySource Matrix on the installation page.

Once you have downloaded the source code, you need replace the existing code with the newer version. This will not reset any configuration options or remove any content from your system.

These steps assume MySource Matrix is installed at /home/websites/mysource_matrix and that a tar.gz archive with the new source code exists within /home/websites 
$ cd /home/websites
$ mv mysource_matrix mysource_matrix_3-8-2
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-8-2/data .

Disable Rollback

At this point, you need to ensure that rollback is disabled before continuing. For help with disabling rollback, see the MySource Matrix rollback management guide.

Update Database Stored Procedures

One of the database stored procedures created by MySource Matrix has changed between versions 3.8.2 and 3.8.3, for users using PostgreSQL as a database only, as a result of performance improvements. The stored procedure must be manually dropped at the database level before it can be re-created by the step_02.php installation script.

Run the following database query to remove the old stored procedure:

DROP FUNCTION sq_get_parent_treeids(varchar, int, timestamp);

Then run the step_02.php installation script to install the new version of the stored procedure:

$ php install/step_02.php /home/websites/mysource_matrix

Re-Enable Rollback

If rollback was turned on before this upgrade, it can now be re-enabled. This will also install new versions of the rollback triggers, which have been upgraded in version 3.8.3. Rollback data does not need to be reset.

For help with re-enabling rollback, see the MySource Matrix rollback management guide.

Full System Upgrade

To complete the upgrade, the system's installation scripts should be run to ensure the asset types and language translations are up to date. If you ran step_02.php while re-enabling rollback in the previous step, it does not need to be run again here.

$ php install/step_02.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix

Upgrade Complete

Your upgrade to MySource Matrix version 3.8.3 should now be complete.