Design BIRT Reports on SingleStore Data

The CData JDBC Driver for SingleStore integrates connectivity to SingleStore APIs into your data-driven Java applications. You can use the CData JDBC Driver for SingleStore with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   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.

   A typical JDBC URL is below:

   jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
7. Right-click the Data Sets folder and select the JDBC data source for SingleStore.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'
9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to SingleStore data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.