Query Jira Service Management Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Jira Service Management, DataGrip can work with live Jira Service Management data. This article shows how to establish a connection to Jira Service Management data in DataGrip and use the table editor to load Jira Service Management data.

Create a New Driver Definition for Jira Service Management

The steps below describe how to create a new Data Source in DataGrip for Jira Service Management.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Jira Service Management Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.jiraservicedesk.jar).
   • Set Class to cdata.jdbc.jiraservicedesk.JiraServiceDesk.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Jira Service Management

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Jira Service Management Driver" to create a new Jira Service Management Data Source.
2. In the new window, configure the connection to Jira Service Management with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Jira Service Management 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.

   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.

3. Set URL to the connection string, e.g., jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Jira Service Management

To browse through the Jira Service Management entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'

Download a free, 30-day trial of the CData JDBC Driver for Jira Service Management and start working with your live Jira Service Management data in DataGrip. Reach out to our Support Team if you have any questions.