Upgrading Engine Configuration for new API Versions

Warn

This article is for general guidance. If you have a working Senzing system with data and insight you do not wish to lose, or are unsure of any steps please contact us for assistance.

 

Overview

When upgrading from one version of the Senzing APIs to another, there are sometimes changes made to the Senzing engine configuration. In these cases, the configuration in the database used by Senzing must be updated accordingly.

Creating the configuration upgrade script with g2configupgrade

The g2configupgrade utility, available in <project_path>/bin, is used to compute full configuration update scripts.

Example usage: 

• g2configupgrade -c <INI file> -o <outputDirectory>

With example parameters: 

• g2configupgrade -c etc/G2Module.ini -o myOutputDir

This command will generate the G2ConfigTool.py script needed to upgrade an entity configuration.  It will create the update script from the data files in the data directory and store the resulting script in the output directory.

The INI file specified in the command is the same as used to run the Senzing engine. It provides the information for the entity repository being used and generates scripts accordingly.

Precautions 

g2configupgrade is capable of performing the database updates itself with the -a argument and omitting the -o argument. However, this action is not recommended in production.  We advise that the engine configuration be modified in a development environment and managed through change control in your devops process.

Moreover, always test any updates and changes in a non-production system before implementing them in production!