Skip to Content

Airtable Connection Guide

Overview

This guide describes the system requirements and instructions for connecting Vinyl to an Airtable database server.

To connect your servers, you must have Vinyl 3.3+ installed.

System Requirements

Database Server

Airtable Database Server

Client Web Browser

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84

Connection Instructions

Adding a Data Server

  1. Navigate to the Vinyl IDE

  2. Click on Data Servers from the Connect menu

  3. Click the + Server button on the top left of the Data Servers panel. This will bring up the Server page. Provide the following information:

    • Server Name: Identifiable name for server connection. For example: Airtable

    • Type: Airtable

    • Api Key: Api Key value issued by Airtable, required to access all data in Airtable bases

    • Base ID: Base ID value provided by Airtable. For example: appguzlYdgseoEGMM

    • Table Names: Table Names defined in Airtable

    • View Names: View Names defined in Airtable

    attachment

  4. Click Save to complete server connection

  5. From Testing, click Test Connection to ensure connection works properly

Import the Database

  1. Navigate to the Vinyl IDE

  2. Click on Data Servers from the Connect menu

  3. Locate the Airtable data source and click the Details button from the right-hand panel

  4. Click the Import button

  5. Click to expand the Import Capabilities

    1. Import Pattern: This allows users to import only certain tables by listing them in the box. Prefixes can be used to only import a subset of tables (for example, MyApp_* will only import tables that start with "MyApp_"). If the space is left blank, it will import all tables

    2. Click Save to update any changed settings

    3. Click the Import button to import the data

      attachment

    4. Click Proceed when prompted. Vinyl will schedule the import to run as a background task.