Skip to content

Commit

Permalink
docs: move limitations sections to bottom of firebase and logflare docs
Browse files Browse the repository at this point in the history
  • Loading branch information
1 parent a792372 commit a453d2e
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 50 deletions.
48 changes: 24 additions & 24 deletions docs/catalog/firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,30 +184,6 @@ create foreign table firebase.docs (

This FDW doesn't support query pushdown.

## Limitations

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

- **Performance Limitations**:
- Page size is limited to 1000 items per request
- Query performance may be impacted when dealing with large collections due to pagination requirements
- No query pushdown support means all filtering happens locally after data retrieval

- **Feature Limitations**:
- Read-only access to Authentication Users and Firestore Database Documents
- Write operations (Insert, Update, Delete, Truncate) are not supported
- Limited to basic collection queries; complex Firestore queries are not supported

- **Resource Usage**:
- Default maximum row count limit is 10,000 records
- Each paginated request requires additional network and memory resources
- Full result sets are loaded into memory, which can impact PostgreSQL performance with large datasets

- **Known Issues**:
- Authentication tokens need periodic renewal
- Materialized views using these foreign tables may fail during logical backups (use physical backups instead)
- Collection paths must be exact and complete; partial or wildcard paths are not supported

## Examples

Some examples on how to use Firebase foreign tables.
Expand Down Expand Up @@ -247,3 +223,27 @@ create foreign table firebase.users (
object 'auth/users'
);
```

## Limitations

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

- **Performance Limitations**:
- Page size is limited to 1000 items per request
- Query performance may be impacted when dealing with large collections due to pagination requirements
- No query pushdown support means all filtering happens locally after data retrieval

- **Feature Limitations**:
- Read-only access to Authentication Users and Firestore Database Documents
- Write operations (Insert, Update, Delete, Truncate) are not supported
- Limited to basic collection queries; complex Firestore queries are not supported

- **Resource Usage**:
- Default maximum row count limit is 10,000 records
- Each paginated request requires additional network and memory resources
- Full result sets are loaded into memory, which can impact PostgreSQL performance with large datasets

- **Known Issues**:
- Authentication tokens need periodic renewal
- Materialized views using these foreign tables may fail during logical backups (use physical backups instead)
- Collection paths must be exact and complete; partial or wildcard paths are not supported
52 changes: 26 additions & 26 deletions docs/catalog/logflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,32 +135,6 @@ create foreign table logflare.my_logflare_table (

This FDW doesn't support query pushdown.

## Limitations

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

- **Performance Limitations**:
- API requests are retried up to 3 times with exponential backoff on transient failures
- No query pushdown support means all filtering happens locally after data retrieval
- Response data must be fully loaded into memory before processing

- **Feature Limitations**:
- Read-only access to Logflare endpoints (no Insert, Update, Delete, or Truncate operations)
- Query parameters only support the '=' operator (no >, <, LIKE, etc.)
- Array values are not supported in query parameters
- Limited data type support for column mappings

- **Resource Usage**:
- Full result sets are loaded into memory, which can impact PostgreSQL performance with large datasets
- Each query requires a complete API request-response cycle
- Failed requests may consume additional resources due to retry attempts

- **Known Issues**:
- 404 responses are treated as empty results rather than errors
- Materialized views using these foreign tables may fail during logical backups (use physical backups instead)
- Column type mismatches in the response data will result in null values
- Parameter names must be prefixed with '_param_' and match the expected endpoint parameters exactly

## Examples

### Basic Example
Expand Down Expand Up @@ -240,3 +214,29 @@ where _param_org_id = 123
and _param_iso_timestamp_start = '2023-07-01 02:03:04'
and _param_iso_timestamp_end = '2023-07-02';
```

## Limitations

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

- **Performance Limitations**:
- API requests are retried up to 3 times with exponential backoff on transient failures
- No query pushdown support means all filtering happens locally after data retrieval
- Response data must be fully loaded into memory before processing

- **Feature Limitations**:
- Read-only access to Logflare endpoints (no Insert, Update, Delete, or Truncate operations)
- Query parameters only support the '=' operator (no >, <, LIKE, etc.)
- Array values are not supported in query parameters
- Limited data type support for column mappings

- **Resource Usage**:
- Full result sets are loaded into memory, which can impact PostgreSQL performance with large datasets
- Each query requires a complete API request-response cycle
- Failed requests may consume additional resources due to retry attempts

- **Known Issues**:
- 404 responses are treated as empty results rather than errors
- Materialized views using these foreign tables may fail during logical backups (use physical backups instead)
- Column type mismatches in the response data will result in null values
- Parameter names must be prefixed with '_param_' and match the expected endpoint parameters exactly

0 comments on commit a453d2e

Please sign in to comment.