Query CircleCI Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for CircleCI to query CircleCI 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 CircleCI 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.

Using API Key Authentication

CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CircleCI personal API token.

Example connection string:

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to CircleCI 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.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query CircleCI from Node.js

The following example shows how to define a connection and execute queries to CircleCI 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 CircleCI data and start executing queries with the code below:

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

connection.end();