Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to Airtable Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for Airtable data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for Airtable data. The Cloud Hub provides a MySQL interface for Airtable: After configuring a virtual MySQL database for Airtable, 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.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for Airtable, allowing you to easily query live Airtable data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to Airtable, leveraging server-side processing to quickly return Airtable data.

Create a Virtual MySQL Database for Airtable Data

CData Cloud Hub uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Cloud Hub and click Databases.
  2. Select "Airtable" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Airtable.

    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.
  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Airtable data from any MySQL client.

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 Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedAirtable
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'airtabledb');

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=utf8
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 Cloud Hub using any MySQL client and run SHOW COLUMNS FROM SampleTable_1 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;