Ready to get started?

Learn more about the CData JDBC Driver for IBM Cloud SQL Query or download a free trial:

Download Now

Integrate IBM Cloud SQL Query Data in the Pentaho Report Designer

Publish reports based on IBM Cloud SQL Query data in the Pentaho BI tool.

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

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

      IBM Cloud SQL uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.ibmcloudsqlquery.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:ibmcloudsqlquery:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.ibmcloudsqlquery.IBMCloudSQLQueryDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add IBM Cloud SQL Query Data to a Report

You are now ready to create a report with IBM Cloud SQL Query data.

  1. Add the IBM Cloud SQL Query 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, Status FROM Jobs WHERE UserId = user@domain.com
  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 Jobs table.
  4. Finally, run the report to see the chart.