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

Mario_Petre · Aug 1, 2024 7:31:00 AM

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
Known limitations
Installing anew Qlik Sense Repository Database using PostgreSQL
Qlik PostgreSQL Installer - Download Link
Upgrading an existing Qlik Sense Repository Database
The Upgrade
Next Steps and Compatibility with PostgreSQL installers
How do I upgrade PostgreSQL from here on?
Troubleshooting and FAQ
Related Content

Video Walkthrough

Video chapters:

01:02 - Intro to PostgreSQL Repository
02:51 – Prerequisites
03:24 - What is the QPI tool?
05:09 - Using the QPI tool
09:27 - Removing the old Database Service
11:27 - Upgrading a stand-alone to the latest release
13:39 - How to roll-back to the previous version
14:46 - Troubleshooting upgrading a patched version
18:25 - Troubleshooting upgrade security error
21:15 - Additional config file settings

Supported Scenarios

Upgrades

The following versions have been tested and verified to work with QPI (1.4.0):

Qlik Sense February 2022 to Qlik Sense November 2023.

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

Qlik Sense November 2022 and later do not support 9.6, and a warning will be displayed during the upgrade. From Qlik Sense August 2023 a upgrade with a 9.6 database is blocked.

New installs

The Qlik PostgreSQL Installer supports installing a new standalone PostgreSQL database with the configurations required for connecting to a Qlik Sense server. This allows 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 (see Installing and Uninstalling Qlik Sense Patches) or
- Upgrade to an IR release of Qlik Sense which supports QPI
The PostgreSQL Installer can only upgrade bundled PostgreSQL database listening on the default port 4432.
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.
There will be downtime during this operation, please plan accordingly
If upgrading to PostgreSQL 14 and later, the Windows OS must be at least Server 2016

Known limitations

Cannot migrate a 14.8 embedded database to a standalone
Using QPI to upgrade a standalone database or a database previously unbundled with QPI is not supported.
The installer itself does not provide an automatic rollback feature.

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, default: C:\Program Files\PostgreSQL\14
Do not use the standard Qlik Sense folders, such as C:\Program Files\Qlik\Sense\Repository\PostgreSQL\ and C:\Programdata\Qlik\Sense\Repository\PostgreSQL\.
Set the database data folder, default: C:\Program Files\PostgreSQL\14\data
Do not use the standard Qlik Sense folders, such as C:\Program Files\Qlik\Sense\Repository\PostgreSQL\ and C:\Programdata\Qlik\Sense\Repository\PostgreSQL\.
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 Release Notes

Upgrading an existing Qlik Sense Repository Database

The following versions have been tested and verified to work with QPI (1.4.0):

February 2022 to November 2023.

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

Qlik Sense November 2022 and later do not support 9.6, and a warning will be displayed during the upgrade. From Qlik Sense August 2023 a 9.6 update is blocked.

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-14 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.
If you do not immediately upgrade:
1. Open a Windows File Explorer and browse to C:\ProgramData\Package Cache
2. From there, search for the .msi file appropriate for your currently installed Qlik Sense version
  
  For Qlik Sense August 2023 and later: PostgreSQL14.msi
  Qlik Sense February 2022 to May 2023: PostgreSQL125.msi
3. Right-click the file
4. Click Open file location
5. Highlight the file path, right-click on the path, and click Copy
6. Open a Windows Command prompt as administrator
7. Navigate to the location of the folder you copied
  
  Example command line:
  
  cd C:\ProgramData\Package Cache\{GUID}
  
  Where GUID is the value of the folder name.
8. Run the following command depending on the version you have installed:
  
  Qlik Sense August 2023 and later
  
  msiexec.exe /qb /i "PostgreSQL14.msi" SKIPINSTALLDBSERVICE="1" INSTALLDIR="C:\Program Files\Qlik\Sense"
  
  Qlik Sense February 2022 to May 2023
  
  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 you installed with a custom directory adjust the INSTALLDIR parameter accordingly. E.g. you installed in D:\Qlik\Sense then the parameter would be INSTALLDIR="D:\Qlik\Sense".

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

Next Steps and Compatibility with PostgreSQL installers

Now that your PostgreSQL instance is no longer connected to the Qlik Sense Enterprise on Windows services, all future updates of PostgreSQL are performed independently of Qlik Sense. This allows you to act in accordance with your corporate security policy when needed, as long as you remain within the supported PostgreSQL versions.

Your PostgreSQL database is fully compatible with the official PostgreSQL installers from https://www.enterprisedb.com/downloads/postgres-postgresql-downloads.

How do I upgrade PostgreSQL from here on?

See How To Upgrade Standalone PostgreSQL, which documents the upgrade procedure for either a minor version upgrade (example: 14.5 to 14.8) or a major version upgrade (example: 12 to 14). Further information on PostgreSQL upgrades or updates can be obtained from Postgre directly.

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.

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 PostgreSQL Repository Troubleshooting
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

BoB_Qlik_Support · ‎2022-10-17

Hey thanks a lot Ilias , it worked for me too 🙂 .

piotrek_w · ‎2022-10-17

Hi,

I would like to share some info that I got from Qlik.

The new posgresql db service postgresql-x64-12 needs to be running during the QS upgrade.

That fixed my problem.

BR,

Piotr

Prasasiv · ‎2022-10-26

Hi @Mario_Petre ,

After upgrading from 9.6 to 12.5 the older 9.6_depcreated and backup folders can be deleted right?

Regards,

Siva Prasad

BoB_Qlik_Support · ‎2022-10-27

Hi ,

Has anybody tried to rollback to 9.6 .

As per the rollback instructions, only running the qliksense database repository service will be perform rollback. however , qliksense database repository service is not starting .

Is'nt it required to rename the folder '9.6_depcreated' back to 9.6 at location -> %ProgramData%\Qlik\Sense\Repository\PostgreSQL\9.6 .

Regards,

Jyoti

Zbebus · ‎2022-10-28

Hi everyone.

I have another problem after upgrade postgresql 9.6 >> 12.5
After upgrade Postgre to version 12.5 - release May 2022, all worked fine.
But yesterday i upgraded Qlik to release August 2022.
The postgresql-x64-12 service failed to start 😞

I had to restore Qlik from backup to release from May 2022.
Does anybody have an idea?
Regards

p_verkooijen · ‎2022-11-10

Upgraded the server to Nov2022 today (upgraded from Aug2022)

Installer mentioned the depricated version of Postgresql so I followed the instructions to upgrade it to 12.5. Tested Aug2022 after upgrade, all worked fine.

Upgraded without removing the old Qlik Sense Repository Database service. Forgot to read the instructions regarding this. Upgrade was fine no alerts, only the environment wouldn't startup after the upgrade. Starting services mentiones the Qlik Sense Repository Database service is marked for removeal.

So I restarted the server, the Qlik Sense Repository Database service was removed. However the other services were not starting. postgresql-x64-12 - PostgreSQL Server 12 service was running fine.

First though, well I'll just restore the snapshot. Only to see that I snapshotted the wrong server so no easy recovery is possible.

Then decided to do a repair installation using the installer, this fixed all my issues. Qlik Sense is running fine again.

However... the Qlik Sense Repository Database service has been installed again and now I got it all running with this service. But the old postgresql-x64-12 - PostgreSQL Server 12 is still there. Decided to set it to manual because it wouldn't start anyway now.

What to do? Could or should I remove the postgresql-x64-12 - PostgreSQL Server 12 service because the Qlik Sense Repository Database is working fine?

mountaindude · ‎2022-11-11

I also tried an upgrade to 2022 Nov with limited success due to Postgres 9.6/12.5 issues.

Previous OSEoW version was 2022 Aug patch 1 (13.78.7).

When trying to upgrade to 2022-Nov I got this message from the installer:

Fine, I'll upgrade Postgres then. So I followed the instructions in this forum topic, verified that everything worked after the installation of PG 12.5.
Then removed the old 9.6 PG version.

All went according to the instructions above.
Postgres 9.6 doesn't exist anymore on this server.

At this point 2022-Aug is still installed, but using Postgres 12.5.
All is working nicely.

So let's try starting the installer for 2022-Nov IR again.
That gives me this, which is not IMHO very informative:

Ok... My conclusion is that the standalone Qlik Postgres installer installed Postgres in the wrong location - or that the 2022-Nov installer doesn't realise that it has a working Postgres 12.5 database already installed.

Anyone else seeing this?

Any ideas from support? @Mario_Petre

p_verkooijen · ‎2022-11-11

@mountaindude did not got these screenshots from my end but I got the exact same messages here.

Also upgraded Aug 2022 Patch... to Nov 2022 IR

The installer first gets you to upgrade the Postgres (at least the advice to do so)

After the upgrade Aug 2022 works with the new Postgres instance and the upgrade to Nov2022 does not recognise the upgraded Postgres as Qlik's own.

mountaindude · ‎2022-11-11

@p_verkooijen So did you dare press the "Next" button, and what happened then?

I cancelled the upgrade to 2022-Nov for now, don't want to ruin a working setup just to be on the bleeding edge.

p_verkooijen · ‎2022-11-11

@mountaindude

Because I snapshotted the machine I just upgraded the machine to Nov2022

I forgot to read carefully and did not remove the service in the Final step described "Once the upgrade and all validation are complete, the old Qlik Sense Repository Database service should be removed from the server. "

After the upgrade to Nov2022 the services did not startup because Qlik Sense Repository Database service could not start. Although the new service was up and running. Extra reboot of the server did not help.

At the end I did a Repair using the Nov2022 installer. This pointed the "Qlik Sense Repository Database service" to the new Postgres executable and all seems to work fine now

Because I thought I had a snapshot I just went on with the upgrade, only to find out to be have a snapshot of the wrong machine 🙈 and having no change to revert I had to find a fix.
Now I'm stuck with a postgresql-x64-12 - PostgreSQL Server 12 service that I cannot use. And probably cannot delete either.

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