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

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

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

Configure Kintone Connectivity for NodeJS

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

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

2. Select "Kintone" from the Add Connection panel
👁 Selecting a data source

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

   In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

   • Url: The URL of your account.
   • GuestSpaceId: Optional. Set this when using a guest space.

   Authenticating with Kintone

   Kintone supports the following authentication methods.

   Using Password Authentication

   You must set the following to authenticate:

   • User: The username of your account.
   • Password: The password of your account.

   Using Basic Authentication

   If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

   Using Client SSL

   Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Kintone Connection page and update the User-based permissions. 👁 Updating 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. 👁 Creating a new PAT
   
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 Kintone data from Node.js.

Query Kintone from Node.js

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

Connect to Kintone 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: 'Kintone1'
	}
}

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

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