Using the CData ODBC Driver for Jira Assets in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Jira Assets from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Jira Assets as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Jira Assets

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

Jira Assets supports connecting and authenticating via the APIToken.

To generate an API token:

1. Log in to your Atlassian account.
2. Navigate to Security < Create and manage API Token < Create API Token.

Atlassian generates and then displays the API token.

After you have generated the API token, set these parameters:

• AuthScheme: APIToken.
• User: The login of the authenticating user.
• APIToken: The API token you just generated.

You are now ready to connect and authenticate to Jira Assets.

Below is the syntax for a DSN:

[CData JiraAssets Source]
Driver = CData ODBC Driver for Jira Assets
Description = My Description
User = MyUser
APIToken = myApiToken
Url = https://yoursitename.atlassian.net

Execute SQL to Jira Assets

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for JiraAssets};User = MyUser;APIToken = myApiToken;Url = https://yoursitename.atlassian.net')
cursor = cnxn.cursor()
cursor.execute("SELECT ID, Name FROM Objects WHERE Label = 'SYD-1'")
rows = cursor.fetchall()
for row in rows:
 print(row.ID, row.Name)

After connecting to Jira Assets in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Jira Assets data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].