Ready to get started?

Learn more about the CData ODBC Driver for Airtable or download a free trial:

Download Now

Connect to Airtable Data as a Federated Tables in MySQL

Use the SQL Gateway and the ODBC Driver to set up federated tables for Airtable data in MySQL .

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Airtable data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Airtable: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Airtable data just as you would local MySQL tables.

Connect to Airtable Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Airtable data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Airtable Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Airtable. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedAirtable
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Airtable Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (SampleTable_1). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_sampletable_1 (
  ...,
  id  TYPE(LEN),
  column1  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAirtable/sampletable_1';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Airtable FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Airtable. Refer to the following example:

SELECT 
  fed_sampletable_1.id, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_sampletable_1 
ON 
  local_table.foreign_id = fed_sampletable_1.id;