Airtable Reader/Writer (FME Form Package)
Integrating this Format with FME Form
|
Download from FME Hub |
|
|
Other Package Components |
|
Overview
Airtable is a platform that enables user-friendly workflows and collaboration across teams. Workspaces can be set up and shared with others. Each workspace can contain multiple bases, each of which can contain multiple tables. On the Airtable website, each table can be configured with views, such as spreadsheets, forms, or galleries to display the underlying data.
Each Airtable Reader/Writer instance corresponds to a single base. The reader reads data from tables in that base. Each reader feature type will correspond to a table (or a view of that table) in the base. The writer allows the creation of new records in an existing table as well as updating, replacing, or deleting existing records. Each writer feature type corresponds to an Airtable table.
Airtable Product and System Requirements
|
Format |
FME Platform |
Operating System |
||||
|---|---|---|---|---|---|---|
|
Reader/Writer |
FME Form |
FME Flow |
FME Flow Hosted |
Windows 64-bit |
Linux |
Mac |
|
Reader |
All FME Editions |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Writer |
All FME Editions |
Yes |
Yes |
Yes |
Yes |
Yes |
Terminology Notes
| Airtable Table | Definition or FME Representation |
|---|---|
|
rows stored in tables: records |
features |
|
columns or fields |
attributes |
Reader Overview
The Airtable reader supports reading from Airtable tables within a base. Each Airtable reader feature type corresponds to one of the tables or views within an Airtable base.
A feature type corresponding to a view will have the view name enclosed in parentheses and appended to the table name (for example, Table Name (View Name)). If a feature type corresponds to a view, the records returned will honor any filters or sort preferences set by that view. If a table field is not visible in a view, it will not be visible as an attribute on the reader. If a table field is not visible in a view, it will not be visible as an attribute on the reader.
Writer Overview
The Airtable writer can be used to insert, replace, update or delete records in an existing Airtable table. To modify existing records, the ID of the Airtable record must be provided. This can be retrieved using the airtable_record_id format attribute present on Airtable reader features.
Since Airtable views only represent data stored in an underlying table, attempting to write to a view of a table will write to the underlying table. If a writer feature type was generated from an Airtable reader feature type and contains a view name (for example, Table Name (View Name)), the Airtable Writer will perform writes to the table Table Name.