Skip to content

Commit

Permalink
updated airtable docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Brennglass authored and Brian Brennglass committed Dec 18, 2024
1 parent 18983c6 commit 5dbd5f0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
Binary file added docs/assets/airtable_credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion docs/catalog/airtable.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5dbd5f0

Please sign in to comment.