Using the CData ODBC Driver for Vercel in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Vercel from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Vercel as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Vercel

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Vercel
Description = My Description
Profile = C:\profiles\Vercel.apip
AuthScheme = APIKey
APIKey = your_access_token

Execute SQL to Vercel

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Vercel.apip;AuthScheme = APIKey;APIKey = your_access_token;')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM User WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to Vercel in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Vercel data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].