Skip to content

Commit

Permalink
docs: move limitations and supported data types sections in calendly doc
Browse files Browse the repository at this point in the history
  • Loading branch information
1 parent 52d5bcc commit 1118b42
Showing 1 changed file with 50 additions and 50 deletions.
100 changes: 50 additions & 50 deletions docs/catalog/calendly.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,56 +17,6 @@ The Calendly Wrapper is a WebAssembly(Wasm) foreign data wrapper which allows yo

Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.

## Limitations

This section describes important limitations and considerations when using this FDW:

- **Performance Limitations**:
- No query pushdown support, all filtering happens locally
- Full result sets must be transferred from Calendly API
- Network latency impacts query response times
- API rate limits may affect query performance
- WebAssembly execution overhead for data processing
- Sequential scanning of all records for filtering

- **Feature Limitations**:
- Read-only operations supported (no INSERT, UPDATE, DELETE, or TRUNCATE)
- Limited data type mappings (see Supported Data Types section)
- Complex Calendly event data must be handled through JSONB
- No support for Calendly's webhook functionality
- Authentication requires Calendly API token
- WebAssembly runtime environment required

- **Resource Usage**:
- API quota consumption scales with query frequency
- Memory usage increases with result set size
- Network bandwidth consumption based on response size
- No connection pooling or result caching
- WebAssembly memory limitations may affect large datasets
- Each query requires fresh API authentication

- **Known Issues**:
- Materialized views using foreign tables may fail during logical backups
- JSON attribute extraction requires explicit path navigation
- API version changes may affect data structure compatibility
- Time zone handling may require explicit conversion
- Error messages may not preserve full Calendly API context
- Organization URI must be manually configured after initial setup

## Supported Data Types

| Postgres Data Type | Calendly Data Type |
| ------------------ | ------------------ |
| boolean | Boolean |
| bigint | Number |
| double precision | Number |
| text | String |
| timestamp | Time |
| timestamptz | Time |
| jsonb | Json |

The Calendly API uses JSON formatted data, please refer to [Calendly API docs](https://developer.calendly.com/api-docs) for more details.

## Available Versions

| Version | Wasm Package URL | Checksum |
Expand Down Expand Up @@ -306,6 +256,56 @@ create foreign table calendly.scheduled_events (

This FDW doesn't support query pushdown.

## Limitations

This section describes important limitations and considerations when using this FDW:

- **Performance Limitations**:
- No query pushdown support, all filtering happens locally
- Full result sets must be transferred from Calendly API
- Network latency impacts query response times
- API rate limits may affect query performance
- WebAssembly execution overhead for data processing
- Sequential scanning of all records for filtering

- **Feature Limitations**:
- Read-only operations supported (no INSERT, UPDATE, DELETE, or TRUNCATE)
- Limited data type mappings (see Supported Data Types section)
- Complex Calendly event data must be handled through JSONB
- No support for Calendly's webhook functionality
- Authentication requires Calendly API token
- WebAssembly runtime environment required

- **Resource Usage**:
- API quota consumption scales with query frequency
- Memory usage increases with result set size
- Network bandwidth consumption based on response size
- No connection pooling or result caching
- WebAssembly memory limitations may affect large datasets
- Each query requires fresh API authentication

- **Known Issues**:
- Materialized views using foreign tables may fail during logical backups
- JSON attribute extraction requires explicit path navigation
- API version changes may affect data structure compatibility
- Time zone handling may require explicit conversion
- Error messages may not preserve full Calendly API context
- Organization URI must be manually configured after initial setup

## Supported Data Types

| Postgres Data Type | Calendly Data Type |
| ------------------ | ------------------ |
| boolean | Boolean |
| bigint | Number |
| double precision | Number |
| text | String |
| timestamp | Time |
| timestamptz | Time |
| jsonb | Json |

The Calendly API uses JSON formatted data, please refer to [Calendly API docs](https://developer.calendly.com/api-docs) for more details.

## Examples

Below are some examples on how to use Calendly foreign tables.
Expand Down

0 comments on commit 1118b42

Please sign in to comment.