⚠️ Airtable will deprecate API tokens by the end of January 2024. They will be replaced by Personal Access Token(PAT). PAT can be used directly in the current version of the plugin as replacement to the old API key. The process to obtain a PAT is described below.
Airtable is a cloud collaboration service that allows users to work on a spreadsheet-database hybrid.
It makes it easy to organize projects, people, and ideas with your team.
This plugin provides a custom connector to import your records from an Airtable table.
Plugin Information
Version | 1.2.0 |
---|---|
Author | Dataiku (Jeremy Greze) |
Released | 2018-01-11 |
Last updated | 2024-10-04 |
License | Apache Software License |
Source code | Github |
Reporting issues | Github |
How to use
Create a Personal Access Token (PAT)
- Go to your Airtable Developers Hub page,
- select Personal Access Token > + Create new token.
- Name the new token,
- In Scopes, add
data.records:read
andschema.bases:read
- In Access, add the bases that you want to access.
- Finally, press Create token, and copy the token
Store the Personal Access Token(s)
Personal Access Tokens can be securely stored in the plugin presets. There are two types of presets available for this:
- Service Accounts presets: each service account is created by the Dataiku administrator who adds the PAT to it and set which groups can use the preset in their projects.
- User Accounts preset: only one is necessary, also created by the Dataiku administrator, but left empty. Once created, each Dataiku user can bring their own PAT which is then linked to their account. To do so, they will have to go to their DSS profile page > Credentials > <<name of the preset>> > Edit button and paste the PAT in the Credential box.
Find the Base ID and Table ID
On Airtable, go to the specific table that you want to import into Dataiku. The URL indicated in the browser is of the following shape:
The first section of the URL (in red in the figure) constitutes the base id, and the second section (in blue) the table id. In this example, the base id is appvGT5h3K8bd4zED and table tblh5Gs53jG6rY63s.
In the Dataiku flow
In your project flow, add the connector by pressing +Dataset > Airtable > Airtable table. In the API key box, paste the token created in the previous steps, then the base id in the Base ID box and table id in the Table name section.
Known Limitations
As of the writing of this plugin, the API lacks of methods to manage the schema of a table. Hence, this plugin does not offer writing/export to Airtable.
Image Copyright Airtable