VOOZH about

URL: https://www.cdata.com/kb/tech/mysql-jdbc-birst.rst

⇱ Build Visualizations of MySQL Data in Birst


Build Visualizations of MySQL Data in Birst

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData drivers and the Birst Cloud Agent to build real-time visualizations of MySQL 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 MySQL, you can connect to live MySQL 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 MySQL using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live MySQL data operations in Birst. When you issue complex SQL queries from Birst to MySQL, the driver pushes supported SQL operations, like filters and aggregations, directly to MySQL 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 MySQL data using native Birst data types.

Configure a JDBC Connection to MySQL 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. πŸ‘ Create a new Project in Birst
  2. Name the connection (e.g. CDataMySQL).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. πŸ‘ Configure the Connection (part 1)
  7. Set SQL Type to MSSQL
  8. Set the Connection string.

    The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

    SSH Connectivity for MySQL

    You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

    SSH Connections to MySQL in Password Auth Mode

    To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

    • User: MySQL User name
    • Password: MySQL Password
    • Database: MySQL database name
    • Server: MySQL Server name
    • Port: MySQL port number like 3306
    • UserSSH: "true"
    • SSHAuthMode: "Password"
    • SSHPort: SSH Port number
    • SSHServer: SSH Server name
    • SSHUser: SSH User name
    • SSHPassword: SSH Password

    SSH Connections to MySQL in Public Key Auth Mode

    To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

    • User: MySQL User name
    • Password: MySQL Password
    • Database: MySQL database name
    • Server: MySQL Server name
    • Port: MySQL port number like 3306
    • UserSSH: "true"
    • SSHAuthMode: "Public_Key"
    • SSHPort: SSH Port number
    • SSHServer: SSH Server name
    • SSHUser: SSH User name
    • SSHClientCret: the path for the public key certificate file

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.mysql.jar
    

    Fill in the connection properties and copy the connection string to the clipboard.

    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    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 MySQL:

    jdbc:mysql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
    
    
  9. Set the Driver Name: cdata.jdbc.mysql.MySQLDriver and click Save.
πŸ‘ Configure the Connection (part 2)

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

Configure MySQL 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. MySQL).
  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.
πŸ‘ Editing the objects

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 the Visualizer
  3. Select Measures & Categories from your objects
  4. Select and configure the appropriate visualization for the Measure(s) you selected.
πŸ‘ Live MySQL data in a Birst visualization

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

Ready to get started?

Download a free trial of the MySQL Driver to get started:

 Download Now

Learn more:

πŸ‘ MySQL Icon
MySQL JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with MySQL-compatible database engines.