🦊 Welcome to Kyuubi’s online documentation ✨, v1.9.0



The JayDeBeApi module allows you to connect from Python code to databases using Java JDBC. It provides a Python DB-API v2.0 to that database.


To install Python-JayDeBeApi, you can use pip, the Python package manager. Open your command-line interface or terminal and run the following command:

pip install jaydebeapi

If you want to install JayDeBeApi in Jython, you’ll need to ensure that you have either pip or EasyInstall available for Jython. These tools are used to install Python packages, including JayDeBeApi. Or you can get a copy of the source by cloning from the JayDeBeApi GitHub project and install it.

python setup.py install

or if you are using Jython use

jython setup.py install


Using the Python-JayDeBeApi package to connect to Kyuubi, you need to install the library and configure the relevant JDBC driver. You can download JDBC driver from maven repository and specify its path in Python. Choose the matching driver kyuubi-hive-jdbc-*.jar package based on the Kyuubi server version. The driver class name is org.apache.kyuubi.jdbc.KyuubiHiveDriver.

Package Repo
kyuubi jdbc driver kyuubi-hive-jdbc-*.jar


Below is a simple example demonstrating how to use Python-JayDeBeApi to connect to Kyuubi database and execute a query:

import jaydebeapi

# Set JDBC driver path and connection URL
driver = "org.apache.kyuubi.jdbc.KyuubiHiveDriver"
url = "jdbc:kyuubi://host:port/default"
jdbc_driver_path = ["/path/to/kyuubi-hive-jdbc-*.jar"]

# Connect to the database using JayDeBeApi
conn = jaydebeapi.connect(driver, url, ["user", "password"], jdbc_driver_path)

# Create a cursor object
cursor = conn.cursor()

# Execute the SQL query
cursor.execute("SELECT * FROM example_table LIMIT 10")

# Retrieve query results
result_set = cursor.fetchall()

# Process the results
for row in result_set:

# Close the cursor and the connection

Make sure to replace the placeholders (host, port, user, password) with your actual Kyuubi configuration. With the above code, you can connect to Kyuubi and execute SQL queries in Python. Please handle exceptions and errors appropriately in real-world applications.