Guides → Install MySQL Driver
Starting with the 2024.1.3 On-Premises release, Incorta no longer ships the MySQL driver JAR file. After a fresh installation, you must download the required MySQL driver and add it to your environment by running the patch-mysql.sh script. Starting with the v8.0.0 - 2026.8 release, Incorta requires MySQL driver version 9.4.0.
Here are the high-level steps to install the MySQL driver:
- Identify the MySQL driver version that your Incorta release requires.
- Download the MySQL driver JAR file from the Maven repository.
- Run the
patch-mysql.shscript to add the JAR file to your installation. - Restart the Cluster Management Console (CMC) and the running Incorta services.
- Repeat the procedure on every CMC and Incorta node.
MySQL driver version requirements
| Incorta release | Required MySQL driver version | JAR file |
|---|---|---|
| 2024.1.3 and later releases prior to v8.0.0 - 2026.8 | 5.1.48 | mysql-connector-java-5.1.48.jar |
| v8.0.0 - 2026.8 and later | 9.4.0 | mysql-connector-j-9.4.0.jar |
Prerequisites
Before installing the MySQL driver, ensure that you have the following:
- Access to every node that hosts the CMC or an Incorta service, with permission to run scripts in the Incorta installation directory.
- Access to the Maven repository to download the JAR file, or a copy of the JAR file already available on each node.
- The
patch-mysql.shscript, which is included in the Incorta installation package.
Steps to install the MySQL driver on a new installation
Complete the following steps after installing Incorta:
Download the MySQL driver JAR file that matches your release from the Maven repository. For the required version, refer to MySQL driver version requirements.
Run the
patch-mysql.shscript from the installation package, passing the installation path and the JAR file path:
./patch-mysql.sh <INSTALLATION_PATH> <JAR_FILE_PATH>
For example, for the v8.0.0 - 2026.8 release:
./patch-mysql.sh /incorta/IncortaAnalytics /incorta/IncortaAnalytics/mysql-connector-j-9.4.0.jar
For releases prior to v8.0.0 - 2026.8:
./patch-mysql.sh /incorta/IncortaAnalytics /incorta/IncortaAnalytics/mysql-connector-java-5.1.48.jar
Restart the CMC and any running Incorta services. A restart is required for the following:
- CMC
- Loader Services
- Analytics Services
- SparkX
- SQLi
Repeat steps 1 through 3 on each CMC or Incorta node in the cluster.
Typically, no Incorta services are running at this stage if MySQL is the metadata database.
Steps to update the MySQL driver when upgrading to v8.0.0 - 2026.8
The v8.0.0 - 2026.8 release requires MySQL driver 9.4.0. Unlike earlier upgrades, where the existing MySQL JAR files are preserved, upgrading to v8.0.0 - 2026.8 requires you to provide the new driver version.
- Before starting the upgrade, choose one of the following options:
- Ensure that each node has internet connectivity so that the upgrade can retrieve MySQL driver 9.4.0.
- Manually download
mysql-connector-j-9.4.0.jarfrom the Maven repository and place it on each node.
- Start the upgrade. When prompted, run the
patch-mysql.shscript and pass the path to the MySQL driver 9.4.0 JAR file. - After the upgrade completes, run the
patch-mysql.shscript again to ensure that Advanced SQLi queries run successfully. - Restart the CMC and the Incorta services listed in Steps to install the MySQL driver on a new installation.
- Repeat steps 1 through 4 on each CMC or Incorta node in the cluster.
If you skip re-running patch-mysql.sh after the upgrade, Advanced SQLi queries fail.
Verify the MySQL driver installation
To confirm that the driver is installed correctly, verify the following:
- The CMC and all Incorta services start without driver-related errors in the service logs.
- If your cluster uses the Advanced SQL Interface, Advanced SQL queries run successfully.
Additional considerations
- The MySQL driver is required even if Oracle is your metadata database. The Advanced SQLi metastore depends on the driver for the Advanced SQL option to work.
- When you add a new node to the cluster, install the MySQL driver on that node by following the new installation steps.
- For upgrades to releases prior to v8.0.0 - 2026.8, no action is required, because the upgrade process preserves the existing MySQL JAR files.