Query Kintone Data through ODBC in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Kintone ODBC Driver

The Kintone ODBC Driver is a powerful tool that allows you to connect with live Kintone applications, directly from any applications that support ODBC connectivity.

Access Kintone applications and databases from virtually anywhere through a standard ODBC Driver interface.



Use node-odbc to execute SQL queries against Kintone data from Node.js.

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData ODBC Driver for Kintone, you can access live Kintone data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live Kintone data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live Kintone data in Node.js. When you issue complex SQL queries from Node.js to Kintone, the driver pushes supported SQL operations, like filters and aggregations, directly to Kintone and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Kintone 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.

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.

Authennticating 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.

Building node-odbc

In order to connect to Kintone through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying Kintone from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live Kintone data from a Node.js app. The sample code below connects to a specific DSN and queries the Comments table.

myscript.js

const odbc = require('odbc');

async function queryKintone() {
    const connection = await odbc.connect(`DSN=CData Kintone Source`);
    const data = await connection.query('SELECT CreatorName, Text FROM Comments');
    console.log(data);
}

queryKintone();

Once you write the app, use node to execute the script:

node myscript.js

Download a free, 30-day trial of the CData ODBC Driver for Kintone and start working with your live Kintone data in Node.js. Reach out to our Support Team if you have any questions.