Learn more
 

Ready to get started?

Download a free trial of the Jira Service Desk Driver to get started:

 Download Now

Learn more:

Jira Service Desk Icon Jira Service Desk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Jira Service Desk.

In this article

Related articles

Use JayDeBeApi to access Jira Service Desk Data in Python


Use standard Python scripting and the development environment of your choice to access live Jira Service Desk data.

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

You can establish a connection to any Jira Service Desk Cloud account or Server instance.

Connecting with a Cloud Account

To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Supply the following to connect to data:

  • User: Set this to the username of the authenticating user.
  • APIToken: Set this to the API token found previously.

Connecting with a Service Account

To authenticate with a service account, you will need to supply the following connection properties:

  • User: Set this to the username of the authenticating user.
  • Password: Set this to the password of the authenticating user.
  • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

Accessing Custom Fields

By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

Built-in Connection String Designer

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

java -jar cdata.jdbc.jiraservicedesk.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:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH"

Access Jira Service Desk 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.jiraservicedesk.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 Jira Service Desk:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;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.jiraservicedesk.jar" conn = jaydebeapi.connect( "cdata.jdbc.jiraservicedesk.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Requests;") 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 Jira Service Desk and start working with your live Jira Service Desk data in Python. Reach out to our Support Team if you have any questions.