Ready to get started?

Download a free trial of the Azure Synapse Driver to get started:

 Download Now

Learn more:

Azure Synapse Icon Azure Synapse JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure Synapse.

Build Visualizations of Azure Synapse Data in Birst



Use the CData JDBC Driver for Azure Synapse and the Birst Cloud Agent to build real-time visualizations of Azure Synapse 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 Azure Synapse, you can connect to live Azure Synapse 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 Azure Synapse using the Cloud Agent and create dynamic reports in Birst.

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

Configure a JDBC Connection to Azure Synapse 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. CDataAzureSynapse).
  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.

    Connecting to Azure Synapse

    In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

    • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
    • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

    Authenticating to Azure Synapse

    Connect to Azure Synapse using the following properties:

    • User: The username provided for authentication with Azure.
    • Password: The password associated with the authenticating user.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.azuresynapse.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 Azure Synapse:

    jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;
  8. Set the Driver Name: cdata.jdbc.azuresynapse.AzureSynapseDriver and click Save.

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

Configure Azure Synapse 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. AzureSynapse).
  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 Azure Synapse with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Azure Synapse data. Download a free, 30-day trial and start building Birst visualizations today.