Ready to get started?

Learn more about the CData JDBC Driver for Airtable or download a free trial:

Download Now

Connect to Airtable Data from a Connection Pool in JBoss

Integrate Airtable data into Java servlets: Use the Management Console in JBoss to install the Airtable JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Airtable data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Airtable. You will then access Airtable data from a connection pool.

Create a JDBC Data Source for Airtable from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/Airtable
  5. Select the driver that you added above.
  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:airtable: followed by a semicolon-separated list of connection properties.

    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.

    A typical connection string is below:

    jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=TableA,...;ViewNames=TableA.ViewA,...;
  7. Test the connection and finish the wizard. Select the Airtable data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.