small re-ordering

supabase · Dec 14, 2024 · ae63058 · ae63058
1 parent 05a96a9
commit ae63058
Show file tree

Hide file tree

Showing 15 changed files with 276 additions and 269 deletions.
diff --git a/docs/catalog/airtable.md b/docs/catalog/airtable.md
@@ -61,7 +61,7 @@ We recommend creating a schema to hold all the foreign tables:
 create schema airtable;
 ```
 
-## Creating Foreign Tables
+## Entities
 
 The Airtable Wrapper supports data reads from the Airtable API.
 
@@ -73,7 +73,7 @@ The Airtable Wrapper supports data reads from Airtable's [Records](https://airta
 
 | Object  | Select | Insert | Update | Delete | Truncate |
 | ------- | :----: | :----: | :----: | :----: | :------: |
-| Records |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Records |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -108,7 +108,7 @@ This will create a "foreign table" inside your Postgres database called `airtabl
 
 | Object | Select | Insert | Update | Delete | Truncate |
 | ------ | :----: | :----: | :----: | :----: | :------: |
-| Tables |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Tables |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 

diff --git a/docs/catalog/auth0.md b/docs/catalog/auth0.md
@@ -61,7 +61,7 @@ We recommend creating a schema to hold all the foreign tables:
 create schema auth0;
 ```
 
-## Creating Foreign Tables
+## Entities
 
 The Auth0 Wrapper supports data reads from Auth0's [Management API List users endpoint](https://auth0.com/docs/api/management/v2/users/get-users) endpoint (_read only_).
 
@@ -73,7 +73,7 @@ The Auth0 Wrapper supports data reads from Auth0's [Management API List users en
 
 | Object | Select | Insert | Update | Delete | Truncate |
 | ------ | :----: | :----: | :----: | :----: | :------: |
-| Users  |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Users  |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -106,7 +106,7 @@ This example demonstrates querying Auth0 users data.
 
 | Object | Select | Insert | Update | Delete | Truncate |
 | ------ | :----: | :----: | :----: | :----: | :------: |
-| Users  |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Users  |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 

diff --git a/docs/catalog/bigquery.md b/docs/catalog/bigquery.md
@@ -84,7 +84,24 @@ We recommend creating a schema to hold all the foreign tables:
 create schema bigquery;
 ```
 
-## Creating Foreign Tables
+## Options
+
+The following options are available when creating BigQuery foreign tables:
+
+- `table` - Source table or view name in BigQuery, required
+- `location` - Source table location (default: 'US')
+- `timeout` - Query request timeout in milliseconds (default: 30000)
+- `rowid_column` - Primary key column name (required for data modification)
+
+You can also use a subquery as the table option:
+
+```sql
+table '(select * except(props), to_json_string(props) as props from `my_project.my_dataset.my_table`)'
+```
+
+Note: When using subquery, full qualified table name must be used.
+
+## Entites
 
 ### Tables
 
@@ -94,7 +111,7 @@ The BigQuery Wrapper supports data reads and writes from BigQuery tables and vie
 
 | Object | Select | Insert | Update | Delete | Truncate |
 | ------ | :----: | :----: | :----: | :----: | :------: |
-| Tables |   ✅   |   ✅   |   ✅   |   ✅   |    ❌    |
+| Tables |   ✅    |   ✅    |   ✅    |   ✅    |    ❌     |
 
 #### Usage
 
@@ -117,23 +134,6 @@ create foreign table my_bigquery_table (
 - When using `rowid_column`, it must be specified for data modification operations
 - Data in the streaming buffer cannot be updated or deleted until the buffer is flushed (up to 90 minutes)
 
-### Foreign Table Options
-
-The following options are available when creating BigQuery foreign tables:
-
-- `table` - Source table or view name in BigQuery, required
-- `location` - Source table location (default: 'US')
-- `timeout` - Query request timeout in milliseconds (default: 30000)
-- `rowid_column` - Primary key column name (required for data modification)
-
-You can also use a subquery as the table option:
-
-```sql
-table '(select * except(props), to_json_string(props) as props from `my_project.my_dataset.my_table`)'
-```
-
-Note: When using subquery, full qualified table name must be used.
-
 ## Query Pushdown Support
 
 This FDW supports `where`, `order by` and `limit` clause pushdown.

diff --git a/docs/catalog/cal.md b/docs/catalog/cal.md
@@ -19,13 +19,13 @@ The Cal Wrapper is a WebAssembly(Wasm) foreign data wrapper which allows you to
 
 ## Supported Data Types
 
-| Postgres Data Type | Cal.com Data Type  |
-| ------------------ | ------------------ |
-| boolean            | Boolean            |
-| bigint             | Number             |
-| double precision   | Number             |
-| text               | String             |
-| jsonb              | Json               |
+| Postgres Data Type | Cal.com Data Type |
+| ------------------ | ----------------- |
+| boolean            | Boolean           |
+| bigint             | Number            |
+| double precision   | Number            |
+| text               | String            |
+| jsonb              | Json              |
 
 The Cal.com API uses JSON formatted data, please refer to [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction) for more details.
 
@@ -35,9 +35,9 @@ The Cal.com API uses JSON formatted data, please refer to [Cal.com API docs](htt
 
 ## Available Versions
 
-| Version | Wasm Package URL                                                                                | Checksum                                                           |
-| ------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| 0.1.0   | `https://github.com/supabase/wrappers/releases/download/wasm_cal_fdw_v0.1.0/cal_fdw.wasm` | `tbd` |
+| Version | Wasm Package URL                                                                          | Checksum |
+| ------- | ----------------------------------------------------------------------------------------- | -------- |
+| 0.1.0   | `https://github.com/supabase/wrappers/releases/download/wasm_cal_fdw_v0.1.0/cal_fdw.wasm` | `tbd`    |
 
 ## Preparation
 
@@ -83,19 +83,36 @@ We recommend creating a schema to hold all the foreign tables:
 create schema if not exists cal;
 ```
 
+## Options
+
+The full list of foreign table options are below:
+
+- `object` - Object name in Cal.com, required.
+
+Supported objects are listed below:
+
+| Object name  |
+| ------------ |
+| my_profile   |
+| event-types  |
+| bookings     |
+| calendars    |
+| schedules    |
+| conferencing |
+
 ## Entities
 
-### My Profile
+### Profile
 
 This is an object representing your Cal.com user profile.
 
 Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction)
 
 #### Operations
 
-| Object     | Select | Insert | Update | Delete | Truncate |
-| ---------- | :----: | :----: | :----: | :----: | :------: |
-| My Profile |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Object  | Select | Insert | Update | Delete | Truncate |
+| ------- | :----: | :----: | :----: | :----: | :------: |
+| Profile |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -127,7 +144,7 @@ Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction)
 
 | Object      | Select | Insert | Update | Delete | Truncate |
 | ----------- | :----: | :----: | :----: | :----: | :------: |
-| Event Types |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Event Types |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -166,7 +183,7 @@ Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/bookings/create-a-
 
 | Object   | Select | Insert | Update | Delete | Truncate |
 | -------- | :----: | :----: | :----: | :----: | :------: |
-| Bookings |   ✅   |   ✅   |   ❌   |   ❌   |    ❌    |
+| Bookings |   ✅    |   ✅    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -213,7 +230,7 @@ Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction)
 
 | Object    | Select | Insert | Update | Delete | Truncate |
 | --------- | :----: | :----: | :----: | :----: | :------: |
-| Calendars |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Calendars |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -241,7 +258,7 @@ Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction)
 
 | Object    | Select | Insert | Update | Delete | Truncate |
 | --------- | :----: | :----: | :----: | :----: | :------: |
-| Schedules |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Schedules |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -271,7 +288,7 @@ Ref: [Cal.com API docs](https://cal.com/docs/api-reference/v2/introduction)
 
 | Object       | Select | Insert | Update | Delete | Truncate |
 | ------------ | :----: | :----: | :----: | :----: | :------: |
-| Conferencing |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Conferencing |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -290,23 +307,6 @@ create foreign table cal.conferencing (
 
 - The `attrs` column contains all conferencing attributes in JSON format
 
-## Foreign Table Options
-
-The full list of foreign table options are below:
-
-- `object` - Object name in Cal.com, required.
-
-  Supported objects are listed below:
-
-  | Object name              |
-  | ------------------------ |
-  | my_profile               |
-  | event-types              |
-  | bookings                 |
-  | calendars                |
-  | schedules                |
-  | conferencing             |
-
 ## Query Pushdown Support
 
 This FDW doesn't support query pushdown.

diff --git a/docs/catalog/calendly.md b/docs/catalog/calendly.md
@@ -33,8 +33,8 @@ The Calendly API uses JSON formatted data, please refer to [Calendly API docs](h
 
 ## Available Versions
 
-| Version | Wasm Package URL                                                                                | Checksum                                                           |
-| ------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| Version | Wasm Package URL                                                                                    | Checksum                                                           |
+| ------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
 | 0.1.0   | `https://github.com/supabase/wrappers/releases/download/wasm_calendly_fdw_v0.1.0/calendly_fdw.wasm` | `51a19fa4b8c40afb5dcf6dc2e009189aceeba65f30eec75d56a951d78fc8893f` |
 
 ## Preparation
@@ -80,6 +80,21 @@ We recommend creating a schema to hold all the foreign tables:
 ```sql
 create schema if not exists calendly;
 ```
+## Options
+
+The full list of foreign table options are below:
+
+- `object` - Object name in Calendly, required.
+
+Supported objects are listed below:
+
+| Object name              |
+| ------------------------ |
+| current_user             |
+| event_types              |
+| groups                   |
+| organization_memberships |
+| scheduled_events         |
 
 ## Entities
 
@@ -93,7 +108,7 @@ Ref: [Calendly API docs](https://developer.calendly.com/api-docs)
 
 | Object       | Select | Insert | Update | Delete | Truncate |
 | ------------ | :----: | :----: | :----: | :----: | :------: |
-| Current User |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Current User |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -131,7 +146,7 @@ Ref: [Calendly API docs](https://developer.calendly.com/api-docs)
 
 | Object      | Select | Insert | Update | Delete | Truncate |
 | ----------- | :----: | :----: | :----: | :----: | :------: |
-| Event Types |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Event Types |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -168,7 +183,7 @@ Ref: [Calendly API docs](https://developer.calendly.com/api-docs)
 
 | Object | Select | Insert | Update | Delete | Truncate |
 | ------ | :----: | :----: | :----: | :----: | :------: |
-| Groups |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Groups |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -199,7 +214,7 @@ Ref: [Calendly API docs](https://developer.calendly.com/api-docs)
 
 | Object                  | Select | Insert | Update | Delete | Truncate |
 | ----------------------- | :----: | :----: | :----: | :----: | :------: |
-| Organization Membership |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Organization Membership |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -230,7 +245,7 @@ Ref: [Calendly API docs](https://developer.calendly.com/api-docs)
 
 | Object           | Select | Insert | Update | Delete | Truncate |
 | ---------------- | :----: | :----: | :----: | :----: | :------: |
-| Scheduled Events |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+| Scheduled Events |   ✅    |   ❌    |   ❌    |   ❌    |    ❌     |
 
 #### Usage
 
@@ -251,22 +266,6 @@ create foreign table calendly.scheduled_events (
 
 - The `attrs` column contains all event attributes in JSON format
 
-## Foreign Table Options
-
-The full list of foreign table options are below:
-
-- `object` - Object name in Calendly, required.
-
-  Supported objects are listed below:
-
-  | Object name              |
-  | ------------------------ |
-  | current_user             |
-  | event_types              |
-  | groups                   |
-  | organization_memberships |
-  | scheduled_events         |
-
 ## Query Pushdown Support
 
 This FDW doesn't support query pushdown.