Upgrading and unbundling the Qlik Sense Repository Database using the Qlik PostgreSQL Installer

Mario_Petre · ‎2022-05-24

In this article, we walk you through the requirements and process of how to upgrade and unbundle an existing Qlik Sense Repository Database (see supported scenarios) as well as how to install a brand new Repository based on PostgreSQL. We will use the Qlik PostgreSQL Installer (QPI).

For a manual method, see How to manually upgrade the bundled Qlik Sense PostgreSQL version to 12.5 version.

Using the Qlik Postgres Installer not only upgrades PostgreSQL; it also unbundles PostgreSQL from your Qlik Sense Enterprise on Windows install. This allows for direct control of your PostgreSQL instance and facilitates maintenance without a dependency on Qlik Sense. Further Database upgrades can then be performed independently and in accordance with your corporate security policy when needed, as long as you remain within the supported PostgreSQL versions. See How To Upgrade Standalone PostgreSQL.

Index

Supported Scenarios
Upgrades
New installs
Requirements
Installing anew Qlik Sense Repository Database using PostgreSQL
Qlik PostgreSQL Installer - Download Link
Upgrading an existing Qlik Sense Repository Database
The Upgrade
Compatibility with PostgreSQL installers
Troubleshooting and FAQ
Video Walkthrough
Related Content

Supported Scenarios

Upgrades

The following versions have been tested and verified to work with QPI 1.3.0 (QPI May 2023):

Qlik Sense February 2022 to Qlik Sense November 2023.

If you are on any version prior to these, upgrade to at least February 2022 before you begin.

Note that November 2022 and later do not support 9.6, and a warning will be displayed during the Qlik Sense upgrade.

New installs

The Qlik PostgreSQL Installer supports installing a new Qlik Sense Repository Database cluster on a new server, setting up a new environment or migrating an existing Database to a separate host .

Requirements

Review the QPI Release Notes before you continue
Using the Qlik PostgreSQL Installer on a patched Qlik Sense version can lead to unexpected results. If you have a patch installed, either:
- Uninstall all patches before using QPI or
- Upgrade to an IR release of Qlik Sense which supports QPI
This installer will not detect a standalone PostgreSQL database installed by any other means, other than through an official Qlik installer package.
The user who runs the installer must be an administrator.
The backup destination must have sufficient free disk space to dump the existing database 
The backup destination must not be a network path or virtual storage folder. It is recommended the backup is stored on the main drive.
The installer itself does not provide an automatic rollback feature.
There will be downtime during this operation, please plan accordingly

Installing a new Qlik Sense Repository Database using PostgreSQL

Run the Qlik PostgreSQL Installer as an administrator
Click on Install
Accept the Qlik Customer Agreement
Set your Local database settings and click Next. You will use these details to connect other nodes to the same cluster.
Set your Database superuser password and click Next
Set the database installation folder, standard: C:\Program Files\PostgreSQL\14
Set the database data folder, standard: C:\Program Files\PostgreSQL\14\data
Review your settings and click Install, then click Finish
Start installing Qlik Sense Enterprise Client Managed. Choose Join Cluster option.

The Qlik PostgreSQL Installer has already seeded the databases for you and has created the users and permissions. No further configuration is needed.
The tool will display information on the actions being performed. Once installation is finished, you can close the installer. 

If you are migrating your existing databases to a new host, please remember to reconfigure your nodes to connect to the correct host. How to configure Qlik Sense to use a dedicated PostgreSQL database

Qlik PostgreSQL Installer - Download Link

Download the installer here.

Qlik PostgreSQL installer version 1.3.0 Release Notes

Upgrading an existing Qlik Sense Repository Database

The following versions have been tested and verified to work with QPI 1.3.0 (May 2023):

February 2022 to November 2023.

If you are on any version prior to these, upgrade to at least February 2022 before you begin.

Note that November 2022 and later do not support 9.6, and a warning will be displayed during the Qlik Sense upgrade.

The Upgrade

Stop all services on rim nodes
On your Central Node, stop all services except the Qlik Sense Repository Database
Run the Qlik PostgreSQL Installer. An existing Database will be detected.
Highlight the database and click Upgrade
Read and confirm the (a) Installer Instructions as well as the Qlik Customer Agreement, then click (b) Next.
Provide your existing Database superuser password and click Next.
Define your Database backup path and click Next.
Define your Install Location (default is prefilled) and click Next.
Define your database data path (default is prefilled) and click Next.
Review all properties and click Upgrade.

The review screen lists the settings which will be migrated. No manual changes are required post-upgrade.
The upgrade is completed. Click Close.
Open the Windows Services Console and locate the Qlik Sense Enterprise on Windows services.

You will find that the Qlik Sense Repository Database service has been set to manual. Do not change the startup method.

You will also find a new postgresql-x64-12 service. Do not rename this service.
Start all services except the Qlik Sense Repository Database service.
Start all services on your rim nodes.
Validate that all services and nodes are operating as expected. The original database folder in C:\ProgramData\Qlik\Sense\Repository\PostgreSQL\X.X_deprecated
Uninstall the old Qlik Sense Repository Database service.

This step is required. Failing to remove the old service will lead the upgrade or patching issues.
1. Open a Windows File Explorer and browse to C:\ProgramData\Package Cache
2. From there, search for the appropriate msi file.
  
  If you were running 9.6 before the upgrade, search PostgreSQL.msi
  
  If you were running 12.5 before the upgrade, search PostgreSQL125.msi
3. The msi will be revealed.
4. Right-click the msi file and select uninstall from the menu.
Re-install the PostgreSQL binaries. This step is optional if Qlik Sense is immediately upgraded following the use of QPI. The Sense upgrade will install the correct binaries automatically.

Failing to reinstall the binaries will lead to errors when executing any number of service configuration scripts.
1. Open a Windows Command prompt as administrator
2. Navigate to the location of the previously located .msi file
  
  Example:
  
  cd C:\ProgramData\Package Cache\{GUID}
3. Run the following command, replacing PostgreSQL125.msi with the correct .msi depending on your previous version used.
  
  Qlik Sense August 2023 and later: PostgreSQL14.msi
  Qlik Sense February 2022 to May 2023: PostgreSQL125.msi
  
  msiexec.exe /qb /i "PostgreSQL125.msi" SKIPINSTALLDBSERVICE="1" INSTALLDIR="C:\Program Files\Qlik\Sense"
  
  This will re-install the binaries without installing a database.

If the upgrade was unsuccessful and you are missing data in the Qlik Management Console or elsewhere, contact Qlik Support.

Compatibility with PostgreSQL installers

This version of the upgrade tool is fully compatible with the official PostgreSQL installers from https://www.enterprisedb.com/downloads/postgres-postgresql-downloads.

If you have previously used the Qlik Postgres Installer (version 1.2.1 or earlier), you can simply install the latest PostgreSQL version (within your major release).

Example: You have used the old QPI to upgrade to 12.5. You can now easily upgrade to a later version in the same major release, such as 12.15.

Troubleshooting and FAQ

If the installation crashes, the server reboots unexpectedly during this process, or there is a power outage, the new database may not be in a serviceable state. Installation/upgrade logs are available in the location of your temporary files, for example:

C:\Users\Username\AppData\Local\Temp\2

A backup of the original database contents is available in your chosen location, or by default in:

C:\ProgramData\Qlik\Sense\Repository\PostgreSQL\backup\X.X

The original database data folder has been renamed to:

C:\ProgramData\Qlik\Sense\Repository\PostgreSQL\X.X_deprecated
Upgrading Qlik Sense after upgrading PostgreSQL with the QPI tool fails with:

This version of Qlik Sense requires a 'SenseServices' database for multi cloud capabilities. Ensure that you have created a 'SenseService' database in your cluster before upgrading. For more information see Installing and configuring PostgreSQL.

See Qlik Sense Upgrade fails with: This version of Qlik Sense requires a _ database for _.

To resolve this, start the postgresql-x64-XX service.

Video Walkthrough

The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support. The video in this article was recorded in a earlier version of QPI, some screens might differ a little bit.

Related Content

Qlik PostgreSQL installer version 1.3.0 Release Notes
Techspert Talks - Upgrading Qlik Sense Repository Service
Backup and Restore Qlik Sense Enterprise documentation
Migrating Like a Boss
Optimizing Performance for Qlik Sense Enterprise
Qlik Sense Enterprise on Windows: How To Upgrade Standalone PostgreSQL
How-to reset forgotten PostgreSQL password in Qlik Sense
How to configure Qlik Sense to use a dedicated PostgreSQL database
Troubleshooting Qlik Sense Upgrades

pauljohansson · ‎2023-07-24

QPI Bug

During the upgrade - QPI show a screenshot of the default settings of postgresql.conf and pg_hba.conf, signaling that you will need to manually update them after your DB upgrade.

However, your config in postgresl.conf and pg_hba.conf will be kept.

br

Paul

Sonja_Bauernfeind · ‎2023-07-25

Hello @pauljohansson

Can you clarify what you want to report?

Does this regard the review screen which lists the settings to be migrated? I've updated the section in the article to include The review screen lists the settings which will be migrated. No manual changes are required post-upgrade.

All the best,
Sonja

pauljohansson · ‎2023-07-25

Hej @Sonja_Bauernfeind

thanks for the quick reply.

This dialog indicates that IP range will be set to 0.0.0.0 and Max connections to 100.

Also, in the video you are adviced to review these seetings - https://www.youtube.com/watch?v=zXLB8MhtCf8&t=570s

But in fact, the settings for IP range & Max connections showed are the default settings. Not the settings that will be migrated.

br

Paul

Sonja_Bauernfeind · ‎2023-07-25

Hello @pauljohansson

Oh! That's a great point; when I tested this earlier it of course only showed default because I only have the default setting on a quick test. Let me give this another test on a system where I changed the default settings.

EDIT: This was reproduced. A defect is being logged for QPI.

All the best,
Sonja

lkbouman · ‎2023-07-25

In a follow up to my last post about QPI and disk space. Qlik Support tested two scenarios:

- Either you tried to start QPI with not enough disk space available for the installation path.

- Or there was enough disk space available prior to starting the upgrade, but the disk ran full (by some other process) during the upgrade.

In both cases you will receive an error message in the installer.

Somehow in our scenario we didn't received an error message and ended up with a new QSR database without actual content. Last week we tried again. This time with more disk space, everything else staying the same, and the upgrade was successful.

Key takeaway would be to make sure you have enough disk space available before starting the upgrade, even though this is pretty obvious by itself.

Best regards,

Luuk

sri_c003 · ‎2023-08-01

We have too many installations of Qlik in our various environments and manual upgrade for all isn't feasible.

So we are looking to install Qlik PostgreSQL Installer silently as part of our automated deployment process. Could you please help us with the parameters for silent install/upgrade.

Sonja_Bauernfeind · ‎2023-08-02

Hello @sri_c003

Silent installs and upgrades are not yet available as per Release Notes. We are working on including this in a future version.

All the best,
Sonja

steeefan · ‎2023-09-19

Everyone,

Make a 100% sure that you perform this critical last step: Perform the following steps to delete the Qlik Sense Repository Database Service.

If you do not do this, your upgrade to August 2023 (at the latest) will fail, resulting in your sever not coming back online.

Take care
-Stefan

Serkan · ‎2023-09-26

Additional Note: Even a de-installation and upgrade of a QS-Patch will not be run if the "old" service (Repository Database) still exists.

MvHeezik · ‎2023-10-04

Step 16 of the upgrade reads : "Uninstall the old Qlik Sense Repository service."

Shouldn't that be "Uninstall the old Qlik Sense Repository Database service."?

Upgrading and unbundling the Qlik Sense Repository Database using the Qlik PostgreSQL Installer