Ready to get started?

Learn more about the CData JDBC Driver for Redis or download a free trial:

Download Now

Integrate Redis Data in the Pentaho Report Designer

Publish reports based on Redis data in the Pentaho BI tool.

The CData JDBC Driver for Redis data enables access to live data from dashboards and reports. This article shows how to connect to Redis data as a JDBC data source and publish reports based on Redis data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Redis connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:redis: and is followed by a semicolon-separated list of connection properties.

      Set the following connection properties to connect to a Redis instance:

      • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
      • Password: Set this to the password used to authenticate with a password-protected Redis instance , using the Redis AUTH command.

      Set UseSSL to negotiate SSL/TLS encryption when you connect.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Redis JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.redis.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      Below is a typical JDBC URL:

      jdbc:redis:Server=127.0.0.1;Port=6379;Password=myPassword;
    • Custom Driver Class Name: Enter cdata.jdbc.redis.RedisDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Redis Data to a Report

You are now ready to create a report with Redis data.

  1. Add the Redis source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT City, CompanyName FROM Customers
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Customers table.
  4. Finally, run the report to see the chart.