Query Jira Service Management Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Jira Service Management to query Jira Service Management data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Jira Service Management 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 Management 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.

Query Jira Service Management from Node.js

The following example shows how to define a connection and execute queries to Jira Service Management with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to Jira Service Management data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData JiraServiceDesk Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Requests', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();