Use JayDeBeApi to access Suadeo Data in Python

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

The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

Set the following connection properties:

• URL: The base URL of your Suadeo instance.
• User: Your Suadeo username.
• Password: Your Suadeo password.
• AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

Built-in Connection String Designer

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

java -jar cdata.jdbc.suadeo.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:suadeo:URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;"

Access Suadeo 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.suadeo.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 Suadeo:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:suadeo:URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;"

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.suadeo.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.suadeo.SuadeoDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Customers;")


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 Suadeo and start working with your live Suadeo data in Python. Reach out to our Support Team if you have any questions.