Post-update steps

The tasks you must perform after you update SonarQube Server.

Post-update checklist

Here’s a list of steps to perform after the update:

• Verify the SonarScanner version (see below).

• For an Oracle database: clean up the database (see below).

• For a PostgreSQL database: clean up the database (see below).

• For a Microsoft SQL database with Windows authentication: verify the JDBC driver version (see below).

• If using an external configuration to control SonarQube Server (through a script or running as a service): update the service to point to the new installation directory (see below).

• If SonarQube Server is running as a service on Linux with SystemD, then you must configure SonarQube Server to run as a service by updating the sonarqube.service file.

• If you use the Web API, check at some point the usage of deprecated Web API endpoints and parameters: see Monitoring API deprecation.

See the sections below for more details on each step.

If some projects fail to reindex after the update, see Reindexing a single project in Reindexing.

Verifying the installed SonarScanner version

When updating SonarQube Server, you should also make sure you’re using the latest versions of the SonarScanners to take advantage of features and fixes on the scanner side. Please check the documentation pages of the scanners you use for the most recent version compatible with SonarQube Server and your build tools:

• SonarScanner for Maven: SonarScanner for Maven

• SonarScanner for Gradle: SonarScanner for Gradle

• SonarScanner for .NET: Installing the scanner

• SonarScanner for NPM: Installing the scanner

• SonarScanner for Python: SonarScanner for Python

Cleaning up the Oracle database

On Oracle, the database columns to be dropped are marked as UNUSED and are not physically dropped. To reclaim disk space, Oracle administrators must drop these unused columns manually. The SQL request is:

ALTER TABLE foo DROP UNUSED COLUMNS

The relevant tables are listed in the system table all_unused_col_tabs.

Cleaning up the PostgreSQL database

You can fix the table and index bloating by performing vacuuming in order to reclaim unused disk space. In some specific cases, a reindex is required afterward.

Verifying the Microsoft SQL JDBC driver version

If you use Microsoft SQL Server with Windows Authentication, make sure that you’re using a supported version of the Microsoft SQL JDBC Driver package. The minimum supported version is the one mentioned on the Installing database page.

Updating a service to point to the new installation directory

If you use an external configuration, such as a script or Windows Service to control your server, you’ll need to update it to point to the new value of installation directory (<newSonarQubeHome>).

For Linux it depends how you implemented the service.

For Windows, update your service by running the following commands:

sc delete SonarQube
<newSonarQubeHome>\bin\windows-x86-64\SonarService.bat install