Analyze Vercel Data in R via ODBC
Access Vercel data with pure R script and standard SQL. You can use the CData ODBC Driver for Vercel and the RODBC package to work with remote Vercel data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Vercel data and visualize Vercel data in R.
Install R
You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).
Connect to Vercel as an ODBC Data Source
Information for connecting to Vercel follows, along with different instructions for configuring a DSN in Windows and Linux environments.
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:
- Log into your Vercel account at https://vercel.com/
- Navigate to Account Settings > Tokens.
- Click Create Token, enter a name and expiration, and click Create.
- 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.
When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Windows
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
Linux
If you are installing the CData ODBC Driver for Vercel in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.
/etc/odbc.ini
[CData API Source] Driver = CData ODBC Driver for Vercel Description = My Description Profile = C:\profiles\Vercel.apip AuthScheme = APIKey APIKey = your_access_token
For specific information on using these configuration files, please refer to the help documentation (installed and found online).
Load the RODBC Package
To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.
After installing the RODBC package, the following line loads the package:
library(RODBC)
Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.
library(checkpoint)
checkpoint("2016-01-01")
Connect to Vercel Data as an ODBC Data Source
You can connect to a DSN in R with the following line:
conn <- odbcConnect("CData API Source")
Schema Discovery
The driver models Vercel APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:
sqlTables(conn)
Execute SQL Queries
Use the sqlQuery function to execute any SQL query supported by the Vercel API.
user <- sqlQuery(conn, "SELECT , FROM User WHERE = ''", believeNRows=FALSE, rows_at_time=1)
You can view the results in a data viewer window with the following command:
View(user)
Plot Vercel Data
You can now analyze Vercel data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:
par(las=2,ps=10,mar=c(5,15,4,2)) barplot(user$, main="Vercel User", names.arg = user$, horiz=TRUE)