Connect to Vercel Data in Aqua Data Studio

The CData JDBC Driver for Vercel integrates Vercel data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Vercel data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Vercel data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Vercel.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     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 the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Vercel Data

You can now query the tables exposed.