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

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

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

Configure Airtable Connectivity for NodeJS

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

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

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

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

   APIKey, BaseId and TableNames parameters are required to connect to Airtable. ViewNames is an optional parameter where views of the tables may be specified.

   • APIKey : API Key of your account. To obtain this value, after logging in go to Account. In API section click Generate API key.
   • BaseId : Id of your base. To obtain this value, it is in the same section as the APIKey. Click on Airtable API, or navigate to https://airtable.com/api and select a base. In the introduction section you can find "The ID of this base is appxxN2ftedc0nEG7."
   • TableNames : A comma separated list of table names for the selected base. These are the same names of tables as found in the UI.
   • ViewNames : A comma separated list of views in the format of (table.view) names. These are the same names of the views as found in the UI.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Airtable 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 Airtable data from Node.js.

Query Airtable from Node.js

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

Connect to Airtable 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: 'Airtable1'
	}
}

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

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