Connect to SingleStore in SpagoBI

The CData JDBC Driver for SingleStore enables you to connect to live SingleStore data from business intelligence and data mining tools that support the JDBC standard. This article shows how to integrate SingleStore data into a report in SpagoBI Studio and host it on SpagoBI Server.

• Deploy the Driver in SpagoBI Server
• Create a Report in SpagoBI Studio
• Host SingleStore Reports on SpagoBI Server

Deploy the JDBC Driver in SpagoBI Server

Follow the steps to create a JDBC data source for SingleStore in SpagoBI Server.

1. Copy the driver JAR into %CATALINA_BASE%/lib. These files are located in the lib subfolder of the installation directory.

2. Add a SingleStore driver resource to the context. The following resource definition can be added to the GlobalNamingResources element in server.xml: <Resource name="jdbc/singlestore" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.singlestore.SingleStoreDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. Add the following resource link to give access to Web applications. For this article, add the following line to META-INF\context.xml for SpagoBI. <ResourceLink global="jdbc/singlestore" name="jdbc/singlestore" type="javax.sql.DataSource"/>
4. Restart the server.

After adding the driver to the resources for the SpagoBI server, add the data source: In SpagoBI, click Resources -> Data Source -> Add and enter the following information:

• Label: Enter a unique identifier for the driver.
• Description: Enter a description for the driver.
• Dialect: Select Default Dialect.
• Read Only: Select the read-only option. This option determines whether the data source is the default database to save datasets created by the end user.
• Type: Select JDBC.
• URL: Enter the JDBC URL using the required connection string 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.

  A typical JDBC URL is below:

  jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
• Driver: Enter the class name for the driver: cdata.jdbc.singlestore.SingleStoreDriver

Create Reports in SpagoBI Studio

Follow the steps below to populate reports based on SingleStore data in SpagoBI Studio. You will create a dataset that populates a chart with the results of an SQL query. In the next section, you will host this report on SpagoBI Server.

First, you will need to connect to SingleStore data from a report in SpagoBI Studio:

1. In SpagoBI Studio, click File -> New -> Project and select Report Project in the Business Intelligence and Reporting Tools folder.
2. Click File -> New -> Report and select Blank Report.
3. In the Data Explorer view, right-click Data Sources and click New Data Source.
4. Select JDBC Data Source and enter a name for the data source.
5. Click Manage Drivers and click Add to add the driver JAR, cdata.jdbc.singlestore.jar. The driver JAR is located in the lib subfolder of the installation directory.
6. In the Driver Class menu, select the driver class, cdata.jdbc.singlestore.SingleStoreDriver.
7. In the Database URL box, enter the JDBC URL. A typical JDBC URL is below: jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306; See the "Getting Started" chapter of the driver help for a guide to obtaining the required connection properties.

After you have connected to SingleStore data, create a dataset that contains the results of an SQL query:

1. Right-click the DataSet folder and click New Data Set. Select the JDBC data source for SingleStore and enter a name for the dataset.
2. Build the SQL query. In this example, this query will be used to add a chart to the dashboard. For example: SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

You can use the dataset to populate report objects. Follow the steps below to create a chart.

1. In the Palette view, drag a chart onto the canvas.
2. In the Select Chart Type tab, select a bar chart.
3. In the Select Data tab, click the Use Data From option and select the SingleStore data set from the menu.
4. Drag ShipName from the table to the series for the x-axis.
5. Drag ShipCity from the table to the series for the y-axis.

Host SingleStore Reports on SpagoBI Server

Follow the steps below to host documents based on live SingleStore data on SpagoBI Server. You will use the report you created in the previous section as a template. To enable report users to access the live data, create placeholder parameters to be replaced by the SingleStore JDBC data source on the server:

1. If you have not already done so, open the Report Design perspective in SpagoBI Studio.
2. In the Data Explorer view, right-click the Report Parameters folder and click New Parameter. Add the url parameter and assign an empty value to it. This parameter is a placeholder for the JDBC data source on the SpagoBI Server.
3. Right-click the SingleStore data source and click Edit.

4. In the Property Binding node, set the JDBC Driver URL binding property to the url parameter: Click the box for the property. In the Category section, select Report Parameters. Select All in the Subcategory section and double-click the parameter.

   You can also enter the following in the JavaScript syntax:

   params["url"].value

Next, create a new document for the report on SpagoBI Server.

1. In SpagoBI Server, click Documents Development -> Create Document -> Generic Document. The Document Details page is displayed.
2. To create the document, enter the following:
   • Label: Enter a unique identifier for the document.
   • Name: Enter a user-friendly name for the document.
   • Type: Select Report from the menu.
   • Engine: Select BIRT Report Engine.
   • Data Source: Select the SingleStore Data Source you created in Create a JDBC Data Source for SingleStore in SpagoBI Server.
3. In the Show Document Templates section, select the folder where you want the document to be stored.

4. In the Template section, click Choose File. Navigate to the folder containing your report project. Select the .rptdesign file.

   Note: You can find the path to the project in the project properties.

5. Click the Save button.

When you run the report on the server, the placeholder url parameter is replaced with the JDBC URL defined on the server.