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

Mario_Petre · Jul 12, 2024 4:14:27 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, standard: 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, standard: 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

Sebastian_Linser · ‎2022-12-12

Hello @ifytra ,

it will work, but with a small step in-between.

While the old Database was only supported to be installed into this folder, when using the embedded version C:\programdata\qlik\sense\repository\postgresql\9.6

the postgres binary folder could be in E:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6.

If that is the case you simply copy the folder E:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6 to C:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6 and run the QPI installer. After that you can delete the folder on the C: drive again.

best regards

Sebastian

dwighttrumbower · ‎2022-12-12

My installation has had all of Qlik and Postgres on our 2nd drive, since well before 3.1.

So for the new installer, we need to copy the existing PostgreSQL directory to the c: then run the install/upgrade program?

Though I do have files in C:\ProgramData\Qlik\Sense\Repository\PostgreSQL\9.6
But the repository service is started from here:
D:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6\bin\pg_ctl.exe

Thanks

Sebastian_Linser · ‎2022-12-12

@dwighttrumbower if you installed out of the standard installation path's at the beginning

C:\Program Files\Qlik\Sense\

then you need to copy it, otherwise the tool runs just fine.

So in your case you copy the postgres binaries from d:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6 to c:\Program Files\Qlik\Sense\Repository\PostgreSQL\9.6

and that is a one time action on time action for the conversion.

Lauri · ‎2022-12-12

Just to be clear, when it says this:

"Note: If you are looking to only upgrade your PostgreSQL to 12.5 and do not plan to upgrade Qlik Sense at this point, please wait for the next available release of QPI."

... does it mean this?

"Note: If you are looking to only upgrade your PostgreSQL to 12.5 and do not plan to upgrade Qlik Sense from a version that is older than February 2022 at this point, please wait for the next available release of QPI."

I'm on May 2022 R10. I assume I can use this QPI to upgrade my PostgreSQL to 12.5, and I can choose to upgrade Qlik Sense sometime later. Thank you.

Sebastian_Linser · ‎2022-12-12

@Lauri

Yes if you are on May 2022 then you can use QPI to upgrade the DB. Then whenever you want in the next step you can update Sense as well, but you don't need to do that the same time.

I took the other confusing sentence off the article, it would have ment what you wrote.

mountaindude · ‎2022-12-13

@Mario_Petre @Sebastian_Linser

Last night I did the manual regedit fix needed for those of us who got stuck in the situation from which the 2022-Nov IR installer wouldn't work (i.e. first upgrading Postgres, then trying to run the 2022-Nov installer). I was on 2022-Aug before.

It worked and I got to 2022-Nov.

But when I try to upgrade to 2022-Nov patch1 or patch2 things fail with a message that there's an old patch (2022-Aug patch 1) that must be installed first. But that uninstall fails and thus the whole 2022-Nov-patch1/2 installer fails too.

I honestly don't know if there's a 2022-Aug patch still lurking around somewhere - or if something didn't go as planned during the upgrade to 2022-Nov-IR (well, I guess that's pretty clearly

Not sure if it's related to the Postgres upgrade exercise, but figured I'd report it here.
Any recommendations on how to solve this of course appreciated...
Seems to be similar to - but not identical with - this issue.

More info below.

Running the 2022-Nov patch 1/2 installer...

gives me this:

The control panel tells me I am on 2022-Nov:

...as does the QMC:

Error log from the 2022-Nov-patch 1 installer:

2022-12-13 09:33:40 - No command provided.
2022-12-13 09:33:40 - Launch operation: Ui
2022-12-13 09:33:40 - Start services: False
2022-12-13 09:33:40 - Initialized install runner
2022-12-13 09:33:40 - This will update Qlik Sense from Qlik Sense November 2022 version 14.97.3 to Qlik Sense November 2022 Patch 1 version 14.97.4
2022-12-13 09:33:40 - Files to be removed/updated: 397
2022-12-13 09:33:40 - Launching UI
2022-12-13 09:34:16 - Applying action: Update
2022-12-13 09:34:16 - Entered Install
2022-12-13 09:34:16 - ProgramData:C:\ProgramData
2022-12-13 09:34:16 - CommonFiles:C:\Program Files\Common Files
2022-12-13 09:34:16 - InstallDir:C:\Program Files\Qlik\Sense\
2022-12-13 09:34:16 - Backup folder for Path Installer: C:\ProgramData\Package Cache\65a44636-a294-461e-b8a2-c15726693109
2022-12-13 09:34:16 - Unpack folder: C:\Users\goran\AppData\Local\Temp\7b74716a-9c98-4611-83d6-d17876eb7042
2022-12-13 09:34:16 - Assessing service restore states
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseServiceDispatcher
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseRepositoryService
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseEngineService
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseProxyService
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSensePrintingService
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseSchedulerService
2022-12-13 09:34:16 - Restore state for Service is started: True
2022-12-13 09:34:16 - Assessing service restore state for QlikSenseRepositoryDatabase
2022-12-13 09:34:16 - Restore state for Service is started: False
2022-12-13 09:34:16 - Assessing service restore state for QlikLoggingService
2022-12-13 09:34:16 - Restore state for Service is started: False
2022-12-13 09:34:16 - Process id: 11352, Process name: QlikSenseServiceDispatcher
2022-12-13 09:34:16 - Process id: 10128, Process name: QlikSenseRepositoryService
2022-12-13 09:34:16 - Process id: 11196, Process name: QlikSenseEngineService
2022-12-13 09:34:16 - Process id: 12360, Process name: QlikSenseProxyService
2022-12-13 09:34:16 - Process id: 10876, Process name: QlikSensePrintingService
2022-12-13 09:34:16 - Process id: 448, Process name: QlikSenseSchedulerService
2022-12-13 09:34:16 - Stopping Service: QlikSenseServiceDispatcher.
2022-12-13 09:34:16 - QlikSenseServiceDispatcher was stopped
2022-12-13 09:34:16 - Stopping Service: QlikSenseRepositoryService.
2022-12-13 09:34:30 - QlikSenseRepositoryService was stopped
2022-12-13 09:34:30 - Uninstalling old Patch 'Qlik Sense August 2022 Patch 1' with version '14.78.7'.
2022-12-13 09:34:30 - Uninstalling 'C:\ProgramData\Package Cache\c3321027-c4b1-4c67-ab9b-f58e1bf0da7f\Qlik_Sense_update.exe' with uninstallcommand 'uninstall'.
2022-12-13 09:34:30 - Uninstall process started.
2022-12-13 09:34:30 - Waiting for exit on uninstall process 'Qlik_Sense_update' with PID '5080'.
2022-12-13 09:34:32 - Uninstall process exited with exit code '-1'.
2022-12-13 09:34:32 - Error! Uninstall of old Patch 'Qlik Sense August 2022 Patch 1' with version '14.78.7' failed.
2022-12-13 09:34:32 - Update failed
2022-12-13 09:34:32 - The older patch could not be uninstalled! Please uninstall the patch manually. This installation will exit.

Sebastian_Linser · ‎2022-12-14

@mountaindude can you please open a case with the support so we fix that with you.

saso70 · ‎2022-12-14

Hi @mountaindude please check the following link:https://community.qlik.com/t5/Official-Support-Articles/Unable-to-uninstall-Qlik-Sense-Patches/ta-p/...

I fix the same problem with above article.

Lauri · ‎2022-12-17

I successfully upgraded Qlik Sense to May 2022, then successfully upgraded Postgres from 9.6 to 12.5. I then attempted to upgrade QS to November 2022 but it's stuck on this screenshot below (going on 6 hours now). I did not remove the old Repository Database before starting the upgrade. All QS services were stopped before starting the upgrade, but now the new postgresql-x64-12 service is running. How should I proceed? Should I open a case with support?

Lauri · ‎2022-12-19

I ended up having to completely reinstall Sense May 2022. Now my problem is this: I have a backup of my QSR on postgres 9.6, but I'm now running postgres 12.5. I restored the QSR to the new 12.5 postgres db but things aren't working correctly (the repository service isn't able to connect to the license service).

Is there a way to convert a QSR tar from 9.6 to 12.5?

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