Integrate with SingleStore Data in JReport Designer

The CData JDBC Driver for SingleStore data enables access to live data from dashboards and reports as if SingleStore were a relational database, allowing you to query SingleStore data using familiar SQL queries. This article shows how to connect to SingleStore data as a JDBC data source and create reports based on SingleStore data in JReport Designer.

Connect to SingleStore Data

1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for SingleStore 2016\lib\cdata.jdbc.singlestore.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for SingleStore), select JDBC, and click OK.
4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
   • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver: cdata.jdbc.singlestore.SingleStoreDriver
   • URL: 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;
   • User: The username to authenticate with; typically left blank.
   • Password: The password to authenticate with; typically left blank.

5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

   Click Done once the dialog has completed loading the tables.

6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for SingleStore), right-click on Queries, and select Add Query.
7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:

   SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'
   

   With the query built, click OK to close the Query Editor dialog. At this point you are ready to add SingleStore data to a new or existing report.

   NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add SingleStore Data to a Report

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

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).
3. Assign a Category and Value for the chart from the columns in your Query and click Finish.
4. Click the View tab for your report to see the chart.