Load Airtable Data to a Database Using Embulk

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Airtable, Embulk easily loads data from Airtable to any supported destination. In this article, we explain how to use the CData JDBC Driver for Airtable in Embulk to load Airtable data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Airtable data. When you issue complex SQL queries to Airtable, the driver pushes supported SQL operations, like filters and aggregations, directly to Airtable and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Airtable Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Airtable\lib).

Embulk supports JDBC connectivity, so you can easily connect to Airtable and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with 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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Airtable JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.airtable.jar

Fill in the connection properties and copy the connection string to the clipboard.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a typical JDBC connection string for Airtable:

jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=Table1,...;ViewNames=Table1.View1,...;

Load Airtable Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

1. Install the JDBC Input Plugin in Embulk.
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

With the input and output plugins installed, we are ready to load Airtable data into MySQL using Embulk.

Create a Job to Load Airtable Data

Start by creating a config file in Embulk, using a name like airtable-mysql.yml.

1. For the input plugin options, use the CData JDBC Driver for Airtable, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.airtable.AirtableDriver), and the JDBC URL from above
2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (airtable-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.airtable.jar
	driver_class: cdata.jdbc.airtable.AirtableDriver
	url: jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=Table1,...;ViewNames=Table1.View1,...;
	table: "SampleTable_1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SampleTable_1"
	mode: insert

After creating the file, run the Embulk job.

embulk run airtable-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Airtable Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.airtable.jar
	driver_class: cdata.jdbc.airtable.AirtableDriver
	url: jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=Table1,...;ViewNames=Table1.View1,...;
	query: "SELECT Id, Column1 FROM SampleTable_1 WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SampleTable_1"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for Airtable as a connector, Embulk can integrate Airtable data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.