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.

Process & Analyze Azure Synapse Data in Azure Databricks



Host the CData JDBC Driver for Azure Synapse in Azure and use Databricks to perform data engineering and data science on live Azure Synapse data.

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live Azure Synapse data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live Azure Synapse data in Databricks.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Azure Synapse data. When you issue complex SQL queries 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). Its built-in dynamic metadata querying allows you to work with and analyze Azure Synapse data using native data types.

Install the CData JDBC Driver in Azure

To work with live Azure Synapse data in Databricks, install the driver on your Azure cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.azuresynapse.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Connect to Azure Synapse from Databricks

With the JAR file installed, we are ready to work with live Azure Synapse data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query Azure Synapse, and create a basic report.

Configure the Connection to Azure Synapse

Connect to Azure Synapse by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

driver = "cdata.jdbc.azuresynapse.AzureSynapseDriver"
url = "jdbc:azuresynapse:RTK=5246...;User=myuser;Password=mypassword;Server=localhost;Database=Northwind;"

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.

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.

Load Azure Synapse Data

Once the connection is configured, you can load Azure Synapse data as a dataframe using the CData JDBC Driver and the connection information.

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Products") \
	.load ()

Display Azure Synapse Data

Check the loaded Azure Synapse data by calling the display function.

display (remote_table.select ("Id"))

Analyze Azure Synapse Data in Azure Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the Azure Synapse data for analysis.

% sql

SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'

The data from Azure Synapse is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData JDBC Driver for Azure Synapse and start working with your live Azure Synapse data in Azure Databricks. Reach out to our Support Team if you have any questions.