Integrate MySQL Data in the Pentaho Report Designer

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

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

     The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

     SSH Connectivity for MySQL

     You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

     SSH Connections to MySQL in Password Auth Mode

     To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

     • User: MySQL User name
     • Password: MySQL Password
     • Database: MySQL database name
     • Server: MySQL Server name
     • Port: MySQL port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Password"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHPassword: SSH Password

     SSH Connections to MySQL in Public Key Auth Mode

     To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

     • User: MySQL User name
     • Password: MySQL Password
     • Database: MySQL database name
     • Server: MySQL Server name
     • Port: MySQL port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Public_Key"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHClientCret: the path for the public key certificate file

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.mysql.jar
     

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

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     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:mysql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

   • Custom Driver Class Name: Enter cdata.jdbc.mysql.MySQLDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   👁 Required connection properties defined in the JDBC URL. (Salesforce is shown.)
   

Add MySQL Data to a Report

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

1. Add the MySQL 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 ShipName, Freight FROM Orders

   👁 The query to retrieve data, specified in the JDBC data source configuration wizard. (Salesforce is shown.)
   
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 Orders table.
4. Finally, run the report to see the chart.