Learn more
 

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.

In this article

Related articles

Use JayDeBeApi to access Azure Synapse Data in Python


Use standard Python scripting and the development environment of your choice to access live Azure Synapse data.

Access Azure Synapse data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Azure Synapse and the JayDeBeApi module to work with remote Azure Synapse data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Azure Synapse and visualize Azure Synapse data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Azure Synapse data in Python using SQL.

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.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;"

Access Azure Synapse data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.azuresynapse.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Azure Synapse:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.azuresynapse.jar" conn = jaydebeapi.connect( "cdata.jdbc.azuresynapse.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Products;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

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