Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation

Adding a new driver


Pentaho connects to Hadoop clusters using a compatibility layer called a driver. These drivers are Apache Karaf archive files (.kar format) that connect Pentaho services to Hadoop clusters. You must use a driver to connect each vendor and version of your Hadoop clusters for the following Pentaho products:

  • PDI client
  • Pentaho Server
  • Analyzer
  • Interactive Reports
  • Pentaho Report Designer (PRD)
  • Pentaho Metadata Editor (PME)

Pentaho ships with an Apache Hadoop driver. For specific vendor drivers, visit the Support Portal to download the drivers. Install the drivers on the PDI client or Pentaho Server before using them. When drivers for new Hadoop versions are released, you can add them to Pentaho, then install them to connect to the new Hadoop distributions.

CautionWhen you add a driver, it is loaded into the runtime cache. There are several best practices for adding drivers to the runtime cache.
  • If you add multiple drivers, you need to allocate 8 to 10 GB of disk space for each driver to your runtime cache.
  • If you are running an environment that manages multiple instances (executions) of the PDI engine, then allocate enough space for each runtime cache. For example, environments running 50+ concurrent instances require 75GB or more of cache space during peak processing times.

Add a new driver

To add a new driver, first download the required file from the Support Portal then add it to Pentaho using the PDI client. If you are connected to a repository, the driver is copied to the Pentaho Server driver directory. Otherwise, it is copied locally to the PDI client driver directory.

Perform the following steps to add a new driver.


  1. Download the new driver from the Support Portal.

    1. Log in to the Support Portal using the Pentaho Support user name and password provided to you in your Pentaho Welcome Packet.

    2. Click Downloads, then click Pentaho 10.0 GA Release in the 9.x list.

    3. On the bottom of the Pentaho 10.0 GA Release page, browse the folders in the Box widget to find the new driver file and download it.

  2. In the PDI client, select the View tab of your transformation or job.

  3. Right-click the Hadoop clusters folder and click Add driver.

    The Add driver dialog box appears.
  4. Click Browse and navigate to where you saved the .kar file you downloaded from the Support Portal.

  5. Select the new driver file, click Open, then click Next.

    The Congratulations dialog box appears, notifying you that you must restart the PDI client and the Pentaho Server.
    • If you are connected to a repository, the driver is copied to the Pentaho Server driver directory.
    • If you are not connected to a repository, the driver is copied to the PDI client driver directory.