Skip to main content
Announcements
Qlik Connect 2024! Seize endless possibilities! LEARN MORE

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:

Feb 27, 2024 2:47:22 AM

Updated By:

Troy_Raney

Created date:

May 23, 2022 11:40:49 PM

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

  7. Set the database data folder, standard: C:\Program Files\PostgreSQL\14\data

  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.

      search 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. 
    1. Open a Windows Command prompt as administrator

    2. Navigate to the location of the previously located .msi file

      Example: 

      cd C:\ProgramData\Package Cache\{GUID}

    3. Run the following command, replacing PostgreSQL125.msi with the correct .msi depending on your previous version used.

      Qlik Sense August 2023 and later: PostgreSQL14.msi
      Qlik Sense February 2022 to May 2023: PostgreSQL125.msi

      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.  

Compatibility with PostgreSQL installers

This version of the upgrade tool is fully compatible with the official PostgreSQL installers from https://www.enterprisedb.com/downloads/postgres-postgresql-downloads.

If you have previously used the Qlik Postgres Installer (version 1.2.1 or earlier), you can simply install the latest PostgreSQL version (within your major release).

Example: You have used the old QPI to upgrade to 12.5. You can now easily upgrade to a later version in the same major release, such as 12.15.

 

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
Sonja_Bauernfeind
Digital Support
Digital Support

Hello @MvHeezik Thank you for catching this! I corrected it immediately in my edit pass.

p_verkooijen
Partner - Specialist
Partner - Specialist

@Sonja_Bauernfeind please add a step between

c. The folder containing the msi will be revealed.
d. Right-click on the msi file and select uninstall from the menu.

You will have to open an File Explorer window first to be able to Right-click the file.

Or change the search explanation to just using File Explorer and the Search bar using postgresql*

See GIF below

delete_postgresql_msi.gif

 

sri_c003
Partner - Creator II
Partner - Creator II

@Sonja_Bauernfeind @Mario_Petre 

Can you please provide a definite ETA on when this would be included into Qlik and what version/patch. And also how we can automate this via silent install so we could piece it all together into a single script.

This is an important ask considering we have over 400 deployments of Qlik and doing this process manually in each of these is a no go. This has become critical for us considering we are in the process of upgrading all our older environments to Feb 2023 Qlik Sense and our silent upgrades are failing.

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @sri_c003 

I will be taking a portion of your request (silent install) to my experts. However, I do not know what you mean by "included into Qlik".

Can you please clarify?

What do you anticipate to be included in (I assume) Qlik Sense Enterprise on Windows?

All the best,
Sonja 

 

 

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @p_verkooijen 

I will review the instructions again as soon as possible.

All the best,
Sonja 

sri_c003
Partner - Creator II
Partner - Creator II

@Sonja_Bauernfeind 

I mean as in included into Qlik installer without needing a separate process to upgrade the PG db.

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @sri_c003 

The purpose of the Qlik PostgreSQL Installer is to provide you with the tool to unbundle (and simultaneously upgrade) the PostgreSQL instance used by Qlik Sense. The intention behind this is to give you control over what version of PostgreSQL you wish to run without waiting for the bundled version to be updated by Qlik or having to do an in-place upgrade (which is a lot more work-intensive than upgrading a standalone PostgreSQL database).

The tool and process will not be included in the installer, as the installer still installs a bundled PostgreSQL instance.

If you want to provide us with feedback on the same and request a different feature/method for managing PostgreSQL, I want to recommend heading over to our ideas section and logging an idea. 

(Still getting you an answer to the silent install question! I believe we are working on this right now.)

@p_verkooijen Thank you for the suggestion! Changes made.

All the best,
Sonja 

 

 

sri_c003
Partner - Creator II
Partner - Creator II

@Sonja_Bauernfeind 

We have always been using the bundled Postgres for all our Qlik deployments.

The problem is that the Qlik installer is not upgrading the bundled PG leaving it still at 9.6 when upgrading to 2023 from an older version like Feb 2021 or Feb 2022.

Any ETA on Qlik installer updating PG to needed version without us doing anything manually would be greatly appreciated.

Our findings during Qlik upgrade are as below

sri_c003_1-1696520347891.png

 

Benoit_C
Support
Support

Hi @sri_c003,

The purpose of QPI (Qlik Postgres Installer) is to unbundle Postgres.
So people using it are now having a standalone Postgres Database, meaning you can upgrade Postgres yourself.

We have an article which explain how to upgrade a Standalone DB:
https://community.qlik.com/t5/Official-Support-Articles/Qlik-Sense-Enterprise-on-Windows-How-To-Upgr...

If you prefer to have a bundled Postgres DB, then you can use the below method and you'll have again a bundled Database:
https://community.qlik.com/t5/Official-Support-Articles/How-to-manually-upgrade-the-bundled-Qlik-Sen...


Regards,
Benoit

sri_c003
Partner - Creator II
Partner - Creator II

@Benoit_C 
Thank you for coming back so quickly. I looked into the document at https://community.qlik.com/t5/Official-Support-Articles/How-to-manually-upgrade-the-bundled-Qlik-Sen...

But the issue is the number of manual steps needed. We have a few hundred deployments of Qlik and doing this manually on all these is simply not a viable option.

We are looking a simpler process where the steps to upgrade Postgres can be automated via a script.

I shall post this conversation on that thread to keep this thread to standalone PG only.

Version history
Last update:
12 hours ago
Updated by: