MySource Matrix Resources

MySource Matrix has been superseded by Squiz Matrix. This site will remain available for archival purposes only; it is not intended as a current source of Matrix information. For all the latest on Matrix, including documentation and release information, visit the Squiz Matrix site.

Content Tools

Main Content

Upgrading MySource Matrix from v3.18.2 to v3.18.3

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.18.2 installation to version 3.18.3.

This upgrade requires you to have access to:

  • update the MySource Matrix source code
  • 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 Squiz Supported Version (SSV) 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.

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.

Run "Prevent Cascade" Upgrade Queries

Important Information

Additional queries are required as part of the above "Prevent Cascade" development. Please note that this step must be performed before updating the code.

Upgrade Steps

Disable rollback on your system. If you need help with this, please consult the Rollback Management Guide.

Please note that for the queries below, the dropping of views is required since views cannot be modified to change the number of columns they contain, at least in PostgreSQL. They will be regenerated later. 

DROP VIEW sq_rb_vw_ast_lnk_major;
DROP VIEW sq_rb_vw_ast_perm;
DROP VIEW sq_rb_vw_ast_role;
DROP VIEW sq_vw_ast_lnk_major;
DROP VIEW sq_vw_ast_perm;
DROP VIEW sq_vw_ast_role;
DROP VIEW sq_rb_vw_ast_lnk_minor;
DROP VIEW sq_vw_ast_lnk_minor;

ALTER TABLE sq_ast_perm ADD cascades CHAR(1) DEFAULT '1' NOT NULL;
ALTER TABLE sq_ast_mdata ADD cascades CHAR(1) DEFAULT '1' NOT NULL;
ALTER TABLE sq_ast_wflow ADD cascades CHAR(1) DEFAULT '1' NOT NULL;
ALTER TABLE sq_rb_ast_perm ADD cascades CHAR(1) DEFAULT '1' NOT NULL;
ALTER TABLE sq_rb_ast_mdata ADD cascades CHAR(1) DEFAULT '1' NOT NULL;
ALTER TABLE sq_rb_ast_wflow ADD cascades CHAR(1) DEFAULT '1' NOT NULL;

Enable rollback. Again, consult the Rollback Management Guide if you don't know how to do this.

Continue with your normal upgrade procedure.

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-18-3
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-18-3/data .
$ cp -r /home/websites/mysource_matrix_3-18-3/core/lib/DAL/Oven core/lib/DAL
$ cp -r /home/websites/mysource_matrix_3-18-3/core/lib/DAL/QueryStore core/lib/DAL

Full System Upgrade

Now, the system's installation scripts should be run to ensure the asset types and language translations are up to date.

When running step_02, the dropped views will be re-created, and also the new triggers for these tables so they reflect the new column - as configured in Run "Prevent Cascade" Upgrade Queries above. 

$ 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

Add "dbsearch" System Configuration parameter to db.inc configuration file

A new parameter "dbsearch" has been added to the db.inc configuration file to enable offloading of search index requests to a secondary replicated database. The "dbsearch" parameter must be added to the $db_conf array either with a default value (ie; no index replication used) or configured as appropriate to your requirements.

The following is a default representation of the "dbsearch" value, which will be applicable to most installations:

$db_conf = array (
               // existing db settings here ...
               'dbsearch' => NULL,
           );

If search index replication is to be used, the "dbsearch" value should contain the replicated database details. For example:

$db_conf = array (
               // existing db settings here ...
               'dbsearch' => array (
                  'DSN' => 'pgsql:dbname=mysource_matrix;host=replicated_hostname',
                  'user' => 'matrix',
                  'password' => '',
                  'type' => 'pgsql',
               ),
           );

Upgrade Complete

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