Query Vercel Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Vercel data. This article shows how to establish a connection to Vercel data in DataGrip.

Create a New Driver Definition for Vercel

The steps below describe how to create a new Data Source in DataGrip for Vercel.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Vercel Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Vercel

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Vercel Driver" to create a new Vercel Data Source.
2. In the new window, configure the connection to Vercel with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Vercel JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

         java -jar cdata.jdbc.api.jar
       

   Fill in the connection properties and copy the connection string to the clipboard.

   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.

   
3. Set URL to the connection string, e.g.,

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

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Vercel

To browse through the Vercel entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT ,  FROM User WHERE  = ''

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