Integrate SingleStore Data in the Pentaho Report Designer

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

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

     The following connection properties are required in order to connect to data.

     • Server: The host name or IP of the server hosting the SingleStore database.
     • Port: The port of the server hosting the SingleStore database.
     • Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

     Connect Using Standard Authentication

     To authenticate using standard authentication, set the following:

     • User: The user which will be used to authenticate with the SingleStore server.
     • Password: The password which will be used to authenticate with the SingleStore server.

     Connect Using Integrated Security

     As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

     Connect Using SSL Authentication

     You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

     • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
     • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
     • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
     • SSLClientCertType: The certificate type of the client store.
     • SSLServerCert: The certificate to be accepted from the server.

     Connect Using SSH Authentication

     Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

     • SSHClientCert: Set this to the name of the certificate store for the client certificate.
     • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
     • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
     • SSHClientCertType: The certificate type of the client store.
     • SSHPassword: The password that you use to authenticate with the SSH server.
     • SSHPort: The port used for SSH operations.
     • SSHServer: The SSH authentication server you are trying to authenticate against.
     • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
     • SSHUser: Set this to the username that you use to authenticate with the SSH server.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.singlestore.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:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
   • Custom Driver Class Name: Enter cdata.jdbc.singlestore.SingleStoreDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add SingleStore Data to a Report

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

1. Add the SingleStore 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, ShipCity FROM Orders WHERE ShipCountry = 'USA'
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.