Skip to main content

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

100% helpful (4/4)
cancel
Showing results for 
Search instead for 
Did you mean: 
Mario_Petre
Support
Support

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

Last Update:

Mar 7, 2024 5:53:56 AM

Updated By:

Sonja_Bauernfeind

Created date:

May 24, 2022 2:40:49 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

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:

  • 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.png

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 

    qlik sense repository database service running.png

  3. Run the Qlik PostgreSQL Installer. An existing Database will be detected. 

    Upgrade PostgreSQL with QPI.png

  4. Highlight the database and click Upgrade 
  5. Read and confirm the (a) Installer Instructions as well as the Qlik Customer Agreement, then click (bNext.

    QPI Customer Agreement.png

  6. Provide your existingDatabase superuser password and click Next.

  7. Define your Database backup path and click Next.

    Location of database backup folder.png

  8. Define your Install Location (default is prefilled) and click Next.

    Location of database installation folder.png

  9. Define your database data path (default is prefilled) and click Next.

    Location of database data folder.png
     
  10. Review all properties and click Upgrade.

    The review screen lists the settings which will be migrated. No manual changes are required post-upgrade.

    Finalise PostgreSQL upgrade with QPI.png

  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. 

    old service set to manual.png

    You will also find a new postgresql-x64-14 service. Do not rename this service. 

    postgresql-x64-14.png

     

  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.

      find the mis package.png

      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.

      uninstall postgresql.png


  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

      find the mis package.png

      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

      open the file location.png

    5. Highlight the file path, right-click on the path, and click Copy

      highlight the file path and copy.png

    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 

Labels (1)
Comments
Sebastian_Linser

@shaan007 we have tried that with another customer with the same issue as you and there it worked. So it is highly possible.

 

regards

Sebastian

acardella
Partner - Creator
Partner - Creator

HI @Sonja_Bauernfeind .

Have some good new about the possibility that this tool will support installation of Qlik on a different path/drive?

as you mentioned in reply "2022-09-29 10:57 AM" it is already in roadmap but what we have to do with our customer setup if we can't use this migrating tool?

thanks

 

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @acardella We do not have an estimate on when this will be supported in the tool. 

If you cannot use the Qlik PostgreSQL Installation tool, you can carry out a manual upgrade: How to manually upgrade the bundled Qlik Sense PostgreSQL version to 12.5 version 

All the best,
Sonja 

aadil_madarveet
Partner - Creator II
Partner - Creator II

Hi,

As part of upgrading Qlik from Feb 2022 to Feb 2023. I am getting a prompt to upgrade PostgreSQL. 

Is there a possibility of executing this PostgreSQL Upgrade MSI as a silent install. 

This is required for automated upgrade of Qlik Sense. 

Thanks,
Aadil

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @aadil_madarveet 

Rather than using the QPI, you would need to do a manual (silent) uninstall and a manual (silent) install as per How to manually upgrade the bundled Qlik Sense PostgreSQL version to 12.5 version.

All the best,
Sonja 

john_oll
Partner - Creator
Partner - Creator

When trying to upgrade a 9.6 with the updater (version 1.2.1) , it did not work, since it claimed there was a problem with the backup path.
(error message was in OS language).
error in the Log:
  "Exception when dumping database: Der Verzeichnisname ist ungültig." 
(~   Exception when dumping database. Invalid path / path name is invalid)
- reproducable
- changing the path does not avoid the error
- updater was run as administration
- the path is created (if not already exisisting)
- serviceuser and user executing the updater have full rights to the path (both the default or when changing it to another, shorter path)
(Feedback: looking through 15 pages of (only) 10 comments each under this post, when looking for this error, is pretty tedious. Is there an option to display all comments on one page?).

Sebastian_Linser

@john_oll open a case with Qlik Support, so we can have a look into the installation logs.

 

Unfortunately there is no option yet with all comments in one page, but we will raise it with the backend team.

 

best regards

Sebastian

steeefan
Luminary
Luminary

I finally upgraded our Test system yesterday following the procedure detailed above. In the end, everything worked fine and I now have Feb 2023 Patch 2 running on one our servers.

@Sonja_Bauernfeind, I find it preposterous that the Qlik PostgreSQL installer does not recognize a Qlik Sense installation on a different drive than C:, even more so given that the QS installer specifically allows the software to be installed somewhere else. This issue was already brought up in August last year and to me seems to be a kind of an urgent matter. How is that not a functionality built in from the very beginning? The workaround copying the PostgreSQL folder to C: obviously did work as expected but with this being a kind of crucial step in the upgrade process, I find it very strange having to rely on this kind of "hack".

After performing the PostgreSQL installation, I ran the installer of Nov 2022, only to have it sit at "Upgrading Repository Database" for a long time. I then finally killed the process, rebooted the machine and was only then able to perform the upgrade. The same happened when then upgrading to Feb 2023.

Everything seems to be working fine now but I figure I'd share my thoughts on how things went last evening.

mountaindude
Partner Ambassador
Partner Ambassador

@steeefan Agreed, the Postgres upgrade tool should support non c: installation locations. Hopefully we'll sooner rather than later see a new version of that upgrade tool ( @Sonja_Bauernfeind , @Sebastian_Linser any news?).

Meanwhile, you mentioned "...The workaround copying the PostgreSQL folder to C: obviously did work as expected...". Is that workaround described somewhere? 
Did you simply place a copy of the Postgres 9.6 directory in the default location on c: and then ran the update program (version 1.2.1 is currently the latest version, I believe)?
Or did you first have to make a separate, standalone 9.6 installation in c:\program files\qlik\.... ?

 

Sebastian_Linser

@mountaindude it is on the roadmap already.

The workaround was just to copy the postgresql binary folder from e.g. 

D:\program files\qlik\sense\repository\postsgresql\

to 

C:\program files\qlik\sense\repository\postsgresql\

it will use once the pg_ctrl to start the old db, which is always in the data folder c:\programdata\qlik\sense\repository\postgresql

after the migrate process you can delete the folder created on the c drive again.

the latest version supported alternative installation path for postgres so you an install it on the d drive. But it does not support non standard folders for the Qlik Sense installation. But stay tuned for the new release which should come out soon.

Version history
Last update:
‎2024-03-07 05:53 AM
Updated by: