Skip to main content
Announcements
Qlik Introduces a New Era of Visualization! READ ALL ABOUT IT

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
Mario_Petre
Support
Support

Hi @mikaelsc , it is not recommended to rename the service or change the dependency on the newly installed service. As a result, the dependency for Qlik Services will stop with the Qlik Sense Repository Service, same as on a rim node without the database service installed. 

The instructions as well as supported versions and recommended upgrade paths will be updated to reflect the latest version as soon as it is available.

jurriaanbudde1
Partner - Contributor
Partner - Contributor

For "Upgrading an existing QRD to PostgreSQL 12.5 - Central Node" I see that this is only supported when Qlik is installed here: C:\Program Files\Qlik\Sense.

Any chance this tool will support installation of Qlik on a different drive as well in the (near) future?

 

 

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @jurriaanbudde1 

We've received this feedback prior and it has been sent to our developers. I'll make sure to forward your request as well.

Update: I can confirm that this is an active item on the roadmap. But I do not have an estimated delivery time.

All the best,
Sonja 

Narges
Contributor III
Contributor III

Hi Sonja,

I have tested this tools on May 2021 and it shown that this tools does not support May 2021 but in the video it showed that the Qlik could upgrade DB 9.6 on May 2021 directly to 12.5 via this tools.

 

What can be the reason that this tools did not work for us?

 

Regards

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @Narges 

The Upgrade Tool is only supported for Qlik Sense Enterprise on Windows February 2022 and later. I believe what you are referring to is that we introduced support for PostgreSQL 12.5 in May 2021. Meaning Qlik Sense Enterprise on Windows May 2021 and later can use PostgreSQL 12.5 as their database.

If you want to upgrade using our tool, you would first need to upgrade the Qlik Sense version to February 2022 or later.

All the best,
Sonja 

 

Narges
Contributor III
Contributor III

Hi @Sonja_Bauernfeind 

In the video above https://youtu.be/QQgRGIVAixU showed that the environment was May 2021 and instructor used the postgres installer tools to upgrade only the existing DataBase from 9.6 to 12.5.

I have tried to upgrade my existing databased running on 9.6 with QlikSense May 2021 (same scenario as the video simulated) but I couldn't do the upgrade.

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @Narges 

As mentioned before, the tool is not supported on versions prior to February 2022. See the Supported Scenarios section in this article:

  • Qlik Sense Enterprise on Windows February 2022 and above are supported versions for QPI. Upgrade to a supported version for QPI first and then use QPI to upgrade PostgreSQL.

All the best,
Sonja 

c_grigoriadis
Partner - Contributor
Partner - Contributor

Hi,
This weekend we updated our biggest Qlik Sense farm using the Qlik PostgreSQL Installer.

Everything went smoothly except one standalone QS installation. It turned out that in our case the problem was the postgres' password which contained the character '&'. The tool couldn't recognize it and failed to restore the backup.


We had to uninstall PostgreSQL 12, restore the PostgreSQL 9.6 service and change superuser's password. After that we repeated the installation and finished the migration successfully.

Just keep that in mind to avoid future issues.

piotrek_w
Partner - Contributor III
Partner - Contributor III

Hi,

Could you please confirm what to do with this new service 'postgresql-x64-12' running on the central node? Should I leave it as it is? Maybe I should change the service name to the old one or try to change some service dependencies? Would it work with the QS upgrade - I am going to move from May2022 to August2022?

Thanks in advance for any hints. 

BR

Piotr

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @piotrek_w 

Please do not change the service name and do not modify dependencies. This is the correct name for the service.

All the best,
Sonja 

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