Build Visualizations of SingleStore Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for SingleStore, you can connect to live SingleStore data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to SingleStore using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live SingleStore data operations in Birst. When you issue complex SQL queries from Birst to SingleStore, the driver pushes supported SQL operations, like filters and aggregations, directly to SingleStore and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze SingleStore data using native Birst data types.

Configure a JDBC Connection to SingleStore Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst.
2. Name the connection (e.g. CDataSingleStore).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.
6. Set SQL Type to MSSQL
7. Set 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.

   Below is a typical JDBC connection string for SingleStore:

   jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
8. Set the Driver Name: cdata.jdbc.singlestore.SingleStoreDriver and click Save.

NOTE: Since authentication to SingleStore is managed from the connection string, you can leave Security Credentials blank.

Configure SingleStore Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. SingleStore).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.
2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for SingleStore with the Cloud Agent and Birst, you can easily create robust visualizations and reports on SingleStore data. Download a free, 30-day trial and start building Birst visualizations today.