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

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

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for GitLab, allowing you to easily query live GitLab 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 GitLab, leveraging server-side processing to quickly return GitLab data.

Configure GitLab Connectivity for NodeJS

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

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

2. Select "GitLab" from the Add Connection panel

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

   To connect to GitLab, use either OAuth or a personal access token:

   Using OAuth

   Register an OAuth application in GitLab under Edit Profile > Applications (or group Settings > Applications). Set the Redirect URI to https://oauth.cdata.com/oauth/. Note the Application ID (OAuth Client Id) and Secret (shown once). Then set:

   • OAuth Client Id: The Application ID from your GitLab OAuth application.
   • OAuth Client Secret: The Secret from your GitLab OAuth application.

   Click Sign In to complete OAuth authentication.

   Using a Personal Access Token

   In GitLab, navigate to Edit Profile > Access Tokens > Add new token. Select the required scopes (such as api, read_api, read_user, read_repository) and set an expiration date. Copy the token immediately (shown only once). Then set:

   • API Key: The personal access token from your GitLab account.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add GitLab 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 GitLab data from Node.js.

Query GitLab from Node.js

The following example shows how to define a connection and execute queries to GitLab 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 GitLab (API1)

Connect to GitLab 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: 'API1'
	}
}

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

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