Build a PostgreSQL Interface for Vercel Data using the CData JDBC Driver

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access Vercel data as a PostgreSQL database, use the CData JDBC Driver for Vercel and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query Vercel data from PostgreSQL Server.

Connect to Vercel Data as a JDBC Data Source

To connect to Vercel as a JDBC data source, you will need the following:

• Driver JAR path: The JAR is located in the lib subfolder of the installation directory.

• Driver class:

  cdata.jdbc.api.APIDriver
  

• JDBC URL: The URL must start with "jdbc:api:" and can include any of the connection properties in name-value pairs separated with semicolons.

  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.

  

  A typical JDBC URL is below:

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

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:

   ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
   

2. Start the build:

   make install USE_PGXS=1
   

Query Vercel Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to Vercel data:

1. Log into your database.
2. Load the extension for the database:

   CREATE EXTENSION jdbc2_fdw;
   

3. Create a server object for Vercel:

   CREATE SERVER API 
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.api.APIDriver',
   url 'jdbc:api:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar'); 
   

4. Create a user mapping for the username and password of a user known to the MySQL daemon.

   CREATE USER MAPPING for postgres SERVER API OPTIONS (
   username 'admin', 
   password 'test');
   

5. Create a foreign table in your local database:

   postgres=# CREATE FOREIGN TABLE user (
   user_id text,
   user_ text,
   user_ numeric) 
   SERVER API OPTIONS (
   table_name 'user');
   

postgres=# SELECT * FROM user;