How to create Jira Service Desk federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Jira Service Desk data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Jira Service Desk: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Jira Service Desk data just as you would local MySQL tables.

Connect to Jira Service Desk Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Jira Service Desk data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Jira Service Desk Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Jira Service Desk. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedJiraServiceDesk
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData JiraServiceDesk Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Requests). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_requests (
  ...,
  requestid  TYPE(LEN),
  reportername  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedJiraServiceDesk/requests';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Jira Service Desk FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Jira Service Desk. Refer to the following example:

SELECT 
  fed_requests.requestid, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_requests 
ON 
  local_table.foreign_requestid = fed_requests.requestid;