Load Jira Service Desk Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk JDBC Driver

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



Use CData JDBC Driver for Jira Service Desk with the open source ETL/ELT tool Embulk to load Jira Service Desk data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Jira Service Desk, Embulk easily loads data from Jira Service Desk to any supported destination. In this article, we explain how to use the CData JDBC Driver for Jira Service Desk in Embulk to load Jira Service Desk data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Jira Service Desk data. When you issue complex SQL queries to Jira Service Desk, the driver pushes supported SQL operations, like filters and aggregations, directly to Jira Service Desk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Jira Service Desk Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Jira Service Desk\lib).

Embulk supports JDBC connectivity, so you can easily connect to Jira Service Desk and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Jira Service Desk.

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 typical JDBC connection string for Jira Service Desk:

jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH

Load Jira Service Desk Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Jira Service Desk data into MySQL using Embulk.

Create a Job to Load Jira Service Desk Data

Start by creating a config file in Embulk, using a name like jiraservicedesk-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Jira Service Desk, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (jiraservicedesk-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Jira Service Desk 20xx\lib\cdata.jdbc.jiraservicedesk.jar driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=REFRESH table: "Requests" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Requests" mode: insert

After creating the file, run the Embulk job.

embulk run jiraservicedesk-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Jira Service Desk Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Jira Service Desk 20xx\lib\cdata.jdbc.jiraservicedesk.jar driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=REFRESH query: "SELECT RequestId, ReporterName FROM Requests WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Requests" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Jira Service Desk as a connector, Embulk can integrate Jira Service Desk data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.