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

[Mario_Petre]

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
• Video Walkthrough
• Related Content

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

1. Run the Qlik PostgreSQL Installer as an administrator 
   
   
2. Click on Install 
   
   
3. Accept the Qlik Customer Agreement 
   
   
4. Set your Local database settings and click Next. You will use these details to connect other nodes to the same cluster. 
   
   
5. Set your Database superuser password and click Next
   
   
6. 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\.

7. 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\.

8. Review your settings and click Install, then click Finish
   
   
9. 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.
   
   
10. 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

1. Stop all services on rim nodes 
   
   
2. On your Central Node, stop all services except the Qlik Sense Repository Database 
   
   
   
   
3. Run the Qlik PostgreSQL Installer. An existing Database will be detected. 
   
   
   
   
4. Highlight the database and click Upgrade 
   
5. Read and confirm the (a) Installer Instructions as well as the Qlik Customer Agreement, then click (b) Next.
   
   
   
   
6. Provide your existing Database superuser password and click Next.
   
   
7. Define your Database backup path and click Next.
   
   
   
   
8. Define your Install Location (default is prefilled) and click Next.
   
   
   
   
9. Define your database data path (default is prefilled) and click Next.
   
   
    
10. Review all properties and click Upgrade.
    
    The review screen lists the settings which will be migrated. No manual changes are required post-upgrade.
    
    
    
    
11. The upgrade is completed. Click Close.
     
12. 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. 
    
    
    
13. Start all services except the Qlik Sense Repository Database service. 
    
    
14. Start all services on your rim nodes.
    
    
15. Validate that all services and nodes are operating as expected. The original database folder in C:\ProgramData\Qlik\Sense\Repository\PostgreSQL\X.X_deprecated
    

16. 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.
       
       
       
       
    
    
17. 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

1. 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
   
   
2. 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

Video chapters:

• 01:00 - What is PostgreSQL used for?
• 01:19 - Different versions of PostgreSQL
• 02:38 - Prerequisites for upgrading
• 03:21 - QS Feb 2022 threshold
• 04:33 - Downloading the QPI Installer
• 06:00 - Upgrade process
• 09:54 - Verifying a successful upgrade
• 12:08 - Removing the old Database Service
• 14:16 - Resolving common issues
• 17:28 - Q&A: When is best time to upgrade?
• 18:05 - Q&A: Does the QPI Tool use the latest version?
• 18:27 - Q&A: Which versions should you be careful with?
• 18:55 - Q&A: What are the Do's and Don'ts?
• 19:44 - Q&A: What should we upgrade first?
• 20:28 - Q&A: How to we avoid having to restart the upgrade?
• 21:22 - Q&A: Can we upgrade the database only?
• 21:47 - Q&A: Is it possible to lose any custom settings?
• 22:31 - Q&A: How to tell which version QS is using?
• 23:35 - Q&A: What is the command to remove the old service?
• 24:12 - Q&A: What if the database is on the D drive?
• 24:50 - Q&A: Can the back-up be on ANY local drive?
• 25:05 - Q&A: Are old version of QS compatible with new PostgreSQL?

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 

[mountaindude]

@Mario_Petre @Sonja_Bauernfeind 

Looks like others are having troubles too with this upgrade.

Would be good to know if there's a planned update from Qlik on this topic, ideally providing instructions for how to safely upgrade from for example 2022 Aug to 2022 Nov IR, given the problems described in this post over the past week or so.

The current situation involving upgrading to a non-functioning 2022-Nov state and then running the installer and hoping it will repair the Sense installation feels a bit... hacky. Not really something I want to do on multiple enterprise environments.
Not sure what your options would be.. Replace the 2022-Nov IR installer with one that better handles a recently upgraded repo db?

[Sonja_Bauernfeind]

Hello @mountaindude 

I'm in discussion with our experts on this currently and will update the thread today!

All the best,
Sonja 

[Sonja_Bauernfeind]

Hello all,

We're reviewing feedback on this tool with RnD today and will be returning with additional information. Until then:

@agigliotti and @p_verkooijen If possible could one of you log a ticket related to this so we can investigate it in more detail? Send me the number and/or mention Sebastian Linser in the ticket so it goes to the right engineer. Either way, this feedback is being taken to our developers in today's meeting.

@surya_30, @saso70,  @p_verkooijen, @mountaindude The upgrade topic is going to be a, well, hot topic during the call with RnD. I do not have any further information yet to give on this yet though.

 @jpjust This means you had the QLOGS database prior. We do not drop databases when upgrading, so it will be carried over. That way data is kept if necessary.

@larsrosenm This is an issue we've reported and we hope to see it resolved in future updates to the tool. (QB-15164)

All the best,
Sonja 

[jpjust]

Thank you so much Sonja.

Another thing I noticed is from Pgadmin, after the upgrade I am not able to login using qliksenserepository acct. I am able to login only using postgres acct. Do you have any notes on this?

Thanks

[Sonja_Bauernfeind]

Hello again all!

I will be delivering an update tomorrow. We have additional information from RnD but are first making sure it is being communicated clearly (and there are still a few outstanding questions).

@jpjust I am not certain. I will bring this up tomorrow when I reconnect with our experts.

All the best,
Sonja 

[jpjust]

Thank you Sonja, looking forward to it.

[dwighttrumbower]

Will the upgrade work with the following location? Our software is installed on a 2nd drive and not the C:
 D:\Program Files\Qlik\Sense are not supported at the moment.

Thanks

[Sonja_Bauernfeind]

Hello all,

Good news! A new version of the Qlik PostgreSQL Installer (QPI) will be made available in November. This update intends to address the upgrade problems seen by users as they were moving from (for example) August 2022 to November 2022 as well as resolve other outstanding reports.

We hope to be able to provide release notes.

In the meantime, I've updated the article to reflect two crucial requirements:

• If you are upgrading both Qlik Sense and the PostgreSQL DB, start with Qlik Sense and upgrade it to your intended version.
• If you only intend to upgrade PostgreSQL, wait for the new version to be available to prevent potential issues with a later upgrade of Qlik Sense.

For the remaining issues we've been discussing:

• Writing version into .ini file: We need a case to be able to investigate and properly log a defect.
• Special characters cannot be used in passwords: Check the release notes for QB-15164 when the new version is out.
• Using a modified install path such as d:\: Is expected to be delivered in the new version. Stay tuned for the release notes.
• Unable to log in through PGadmin using qliksenserepository: After logging in with the functioning account, can you verify if qliksenserepository is present? You can also change the password for the account from there. Either way, we'd need a case to be able to investigate this one further.

We'll update the article further whenever we have additional information. 

All the best,
Sonja

@jpjust @saso70 @surya_30 @p_verkooijen @mountaindude 

[Sonja_Bauernfeind]

Hello @dwighttrumbower 

Not currently, as the article mentions. This is expected to be possible with the upcoming release meant to be come out later this month.

All the best,
Sonja 

[dwighttrumbower]

@Sonja_Bauernfeind So is there way to do it manually then? Or should I wait for the new release?