Package: airtable-pg-sync
Airtable Postgres SyncThe goal of this library is to provide an out-of-the-box solution for replicating
an entire Airtable base in a Postgres schema. There are two modes of operation:One-off-sync: This mode will replicate the Airtable base in the specified Postgres schema
and then exit. This is useful for creating snapshots of the base for analysis or for storage as a backup.Perpetual sync: This mode will replicate the Airtable base in the specified Postgres schema
and then continue to watch for changes in the base. When a change is detected, the
change will be applied to the Postgres schema. This is useful for creating a
replica of the base that can be used for analysis in real time.This library will produce a Postgres table and view for each of the tables in the specified Airtable base.
The table will take the Airtable table id for its name and the field ids for its column names. The view will have the
same name as the Airtable table and the column names will be the same as the Airtable column names.
For most analysis use cases it makes sense to use the view as it is more readable, but for applications requiring
robustness with respect to column name changes the table should be used.InstallationTo install the library, run the following command:pipinstallairtable-postgres-syncPermissionsTo use this library, you will need to create a personal access token in Airtable. This
token will need to have the following scopes:data.records:readschema.bases:readwebhook:manageYou will also need to give the Postgres user that you are using read and write access to the schema
you are syncing to.UsageTo use the library, you will need to create a config file. The config file defines
all the parameters that are needed to connect to Airtable and Postgres, as well as how
your program will listen for changes. The file must be in YAML format and must contain
the following fields:AIRTABLE_PG_SYNC:DB_INFO:HOST:# Postgres hostPORT:# Postgres portUSER:# Postgres userPASSWORD:# Postgres passwordDB_NAME:# Postgres database nameSCHEMA_NAME:# Postgres schema nameAIRTABLE_INFO:BASE_ID:# Airtable base id to syncPAT:# Airtable personal access tokenLISTENER_INFO:WEBHOOK_URL:# The url that Airtable will send change notifications toPORT:# The port to listen for change notifications onThe library can be used in two ways:As a command line toolTo trigger a one-time sync, run the following command:airtable-pg-syncone-time-sync--config/path/to/config.ymlTo trigger a perpetual sync, run the following command:airtable-pg-syncperpetual-sync--config/path/to/config.ymlAs a python libraryTo trigger a sync from within a python program, run the following code:fromairtable_pg_syncimportSyncSync(config_path="/path/to/config.yml",perpetual=True/False).run()Testing and DeploymentWhen testing this library for your use case thengrokservice is very useful. It allows you to listen
for requests sent over the internet to your PC (ie the webhook POST requests).For deployment it is recommended that you run the library in an AWS EC2 type service. A t2.micro instance should suffice.Bugs, Feature Requests, and ContributionsIf you find a bug or have a feature request, please open an issue
onGitHub.
Any contributions are welcome and appreciated. If you would like to
contribute, please open a pull request onGitHub.Ideas for contributions:Add support for other databasesAdd support for Postgres -> Airtable syncLicenseThis library is licensed under the MIT License. See theLICENSEfile