Query Linear Data as a SQL Server Database in Node.js

You can use CData Connect AI to query Linear data through a SQL Server interface. Follow the procedure below to create a virtual database for Linear in Connect AI and start querying using Node.js.

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for Linear, allowing you to easily query live Linear data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to Linear, leveraging server-side processing to quickly return Linear data.

Configure Linear Connectivity for NodeJS

Connectivity to Linear from NodeJS is made possible through CData Connect AI. To work with Linear data from NodeJS, we start by creating and configuring a Linear connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Linear" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Linear.

   You can authenticate to Linear with a personal API key or with OAuth 2.0. The API key is the simplest option for connecting with your own Linear account.

   Authenticating with an API Key

   Set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: A Linear personal API key.

   To create a personal API key, log in to Linear, open Settings > Security & access > Personal API keys, select New API key, and create it. Copy the key immediately, because Linear shows it only once.

   Authenticating with OAuth

   OAuth requires a custom OAuth application registered in Linear (Settings > API > OAuth applications), which provides the OAuthClientId and OAuthClientSecret. Two flows are supported:

   • Authorization code: Set AuthScheme to OAuth, InitiateOAuth to GETANDREFRESH, and provide OAuthClientId, OAuthClientSecret, and the CallbackURL defined in your application (e.g., http://localhost:33333). The driver opens Linear in your browser so you can grant access.
   • Client credentials: Set AuthScheme to OAuthClient and provide OAuthClientId and OAuthClientSecret. This authenticates the application itself, with no browser interaction, and suits machine-to-machine integrations.

   By default, the driver requests the read,write scopes. The driver refreshes the access token automatically when it expires.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Linear Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Linear data from Node.js.

Query Linear from Node.js

The following example shows how to define a connection and execute queries to Linear with the SQL Server module. You will need the following information:

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for Linear (Linear1)

Connect to Linear data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'Linear1'
	}
}

sql.connect(config, err => { 
    if(err){
        throw err ;
    }
    new sql.Request().query('SELECT * FROM Team', (err, result) => {
        console.dir(result)
    })
        
});

sql.on('error', err => {
    console.log("SQL Error: " ,err);
})