Query Vercel Data through ODBC in Node.js

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData API Driver for ODBC, you can access live Vercel 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 Vercel data.

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

Connecting to Vercel 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

Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

To obtain a personal access token:

1. Log into your Vercel account at https://vercel.com/
2. Navigate to Account Settings > Tokens.
3. Click Create Token, enter a name and expiration, and click Create.
4. Copy the generated token (it will only be shown once).

After obtaining your token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Vercel personal access token or OAuth access token.

Example Connection String

Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;

Working with Teams

Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

Connecting to Vercel

Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

Building node-odbc

In order to connect to Vercel 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 Vercel from Node.js

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

myscript.js

const odbc = require('odbc');

async function queryAPI() {
    const connection = await odbc.connect(`DSN=CData API Source`);
    const data = await connection.query('SELECT ,  FROM User');
    console.log(data);
}

queryAPI();

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

node myscript.js

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