Build a Simple VCL Application for Vercel Data

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Vercel, you gain access to live Vercel data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve Vercel data. This article will walk through connecting to Vercel and creating a simple VCL application with the Form Designer.

Create a Connection to Vercel Data

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.

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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Vercel data.

1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Vercel.

Create VCL Applications with Connectivity to Vercel Data

Follow the procedure below to start executing queries to Vercel data from a simple VCL application that displays the results of a query in a grid.

1. Drop a TFDConnection component onto the form and set the following properties:

   • ConnectionDefName: Select the FireDAC connection to Vercel data.
   • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

2. Drop a TFDQuery component onto the form and set the properties below:

   • Connection: Set this property to the TFDConnection component, if this component is not already specified.

   • SQL: Click the button in the SQL property and enter a query. For example:

     SELECT ,  FROM User WHERE  = ''
     

   • Active: Set this property to true.

3. Drop a TDataSource component onto the form and set the following property:

   • DataSet: In the menu for this property, select the name of the TFDQuery component.

4. Drop a TDBGrid control onto the form and set the following property:

   • DataSource: Select the name of the TDataSource.
5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to Vercel Data in C++Builder
• DataBind Controls to Vercel Data in Delphi
• Viewing Vercel Data in RAD Studio Data Explorer