How to connect to Airtable Data with Squirrel SQL client

The CData JDBC Driver for Airtable enables you to execute queries to Airtable data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Airtable data and execute queries.

Add the JDBC Driver for Airtable

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Airtable.
4. In the Example URL box, enter jdbc:airtable:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.airtable.AirtableDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData Airtable Source.
   • Driver: Select the CData JDBC Driver for Airtable.
   • URL: Enter jdbc:airtable:
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   APIKey, BaseId and TableNames parameters are required to connect to Airtable. ViewNames is an optional parameter where views of the tables may be specified.

   • APIKey : API Key of your account. To obtain this value, after logging in go to Account. In API section click Generate API key.
   • BaseId : Id of your base. To obtain this value, it is in the same section as the APIKey. Click on Airtable API, or navigate to https://airtable.com/api and select a base. In the introduction section you can find "The ID of this base is appxxN2ftedc0nEG7."
   • TableNames : A comma separated list of table names for the selected base. These are the same names of tables as found in the UI.
   • ViewNames : A comma separated list of views in the format of (table.view) names. These are the same names of the views as found in the UI.

   Below is a typical connection string:

   jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=Table1,...;ViewNames=Table1.View1,...;
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Airtable Data

After the metadata has loaded, a new tab for the Airtable data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example: