diff --git a/docs/assets/airtable_credentials.png b/docs/assets/airtable_credentials.png new file mode 100644 index 00000000..944d7bfc Binary files /dev/null and b/docs/assets/airtable_credentials.png differ diff --git a/docs/catalog/airtable.md b/docs/catalog/airtable.md index 093df8ff..789affba 100644 --- a/docs/catalog/airtable.md +++ b/docs/catalog/airtable.md @@ -43,6 +43,9 @@ create foreign data wrapper airtable_wrapper By default, Postgres stores FDW credentials inside `pg_catalog.pg_foreign_server` in plain text. Anyone with access to this table will be able to view these credentials. Wrappers is designed to work with [Vault](https://supabase.com/docs/guides/database/vault), which provides an additional level of security for storing credentials. We recommend using Vault to store your credentials. + +Get your token from [Airtable's developer portal](https://airtable.com/create/tokens). + ```sql -- Save your Airtable API key in Vault and retrieve the `key_id` insert into vault.secrets (name, secret) @@ -102,9 +105,17 @@ The Airtable Wrapper supports data reads from Airtable's [Records](https://airta #### Usage +Get your base ID and table ID from your table's URL. + +![airtable_credentials](../assets/airtable_credentials.png) + +!!! note + + Foreign tables must be lowercase, regardless of capitalization in Airtable. + ```sql create foreign table airtable.my_foreign_table ( - name text + message text -- other fields ) server airtable_server