How to Connect DBeaver to Jira Service Management via a JDBC Driver

The CData JDBC Driver for Jira Service Management implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Jira Service Management data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Jira Service Management Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Jira Service Management).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.
   • Set URL Template to jdbc:jiraservicedesk:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.JiraServiceDesk.jar).

Create a Connection to Jira Service Management Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Jira Service Management) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   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 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.

   Below is a typical connection string:

   jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Jira Service Management Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial