Integrate Kafka Data in the Pentaho Report Designer

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Apache Kafka JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Apache Kafka.



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

The CData JDBC Driver for Kafka data enables access to live data from dashboards and reports. This article shows how to connect to Kafka data as a JDBC data source and publish reports based on Kafka 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 Kafka connection. In the resulting dialog, configure the connection properties as shown below.

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

      Set BootstrapServers and the Topic properties to specify the address of your Apache Kafka server, as well as the topic you would like to interact with.

      Authorization Mechanisms

      • SASL Plain: The User and Password properties should be specified. AuthScheme should be set to 'Plain'.
      • SASL SSL: The User and Password properties should be specified. AuthScheme should be set to 'Scram'. UseSSL should be set to true.
      • SSL: The SSLCert and SSLCertPassword properties should be specified. UseSSL should be set to true.
      • Kerberos: The User and Password properties should be specified. AuthScheme should be set to 'Kerberos'.

      You may be required to trust the server certificate. In such cases, specify the TrustStorePath and the TrustStorePassword if necessary.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.apachekafka.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:apachekafka:User=admin;Password=pass;BootStrapServers=https://localhost:9091;Topic=MyTopic;
    • Custom Driver Class Name: Enter cdata.jdbc.apachekafka.ApacheKafkaDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Kafka Data to a Report

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

  1. Add the Kafka 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 Id, Column1 FROM SampleTable_1 WHERE Column2 = '100'
  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 SampleTable_1 table.
  4. Finally, run the report to see the chart.