Learn more
 

Ready to get started?

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

 Download Now

Learn more:

Azure Data Catalog Icon Azure Data Catalog JDBC Driver

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

In this article

Related articles

Use JayDeBeApi to access Azure Data Catalog Data in Python


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

Access Azure Data Catalog 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 Data Catalog and the JayDeBeApi module to work with remote Azure Data Catalog 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 Data Catalog and visualize Azure Data Catalog 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 Data Catalog data in Python using SQL.

You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

    CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

Connect Using OAuth Authentication

You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

Built-in Connection String Designer

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

java -jar cdata.jdbc.azuredatacatalog.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:azuredatacatalog:InitiateOAuth=GETANDREFRESH"

Access Azure Data Catalog 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.azuredatacatalog.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 Data Catalog:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:azuredatacatalog:InitiateOAuth=GETANDREFRESH" 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.azuredatacatalog.jar" conn = jaydebeapi.connect( "cdata.jdbc.azuredatacatalog.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Tables;") 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 Data Catalog and start working with your live Azure Data Catalog data in Python. Reach out to our Support Team if you have any questions.