Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase/wrappers
Postgres Foreign Data Wrapper development framework in Rust.
https://github.com/supabase/wrappers
database foreign-data-wrapper postgres postgresql postgresql-extension rust
Last synced: 27 days ago
JSON representation
Postgres Foreign Data Wrapper development framework in Rust.
- Host: GitHub
- URL: https://github.com/supabase/wrappers
- Owner: supabase
- License: apache-2.0
- Created: 2022-10-27T05:17:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T12:56:05.000Z (7 months ago)
- Last Synced: 2024-04-13T21:54:17.400Z (7 months ago)
- Topics: database, foreign-data-wrapper, postgres, postgresql, postgresql-extension, rust
- Language: Rust
- Homepage: https://supabase.github.io/wrappers/
- Size: 2.13 MB
- Stars: 428
- Watchers: 21
- Forks: 40
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Wrappers
`Wrappers` is a development framework for Postgres Foreign Data Wrappers ([FDW](https://wiki.postgresql.org/wiki/Foreign_data_wrappers)), written in Rust. Its goal is to make Postgres FDW development easier while keeping Rust language's modern capabilities, such as high performance, strong types, and safety.
`Wrappers` is also a collection of FDWs built by [Supabase](https://www.supabase.com). We currently support the following FDWs, with more under development:
| FDW | Description | Read | Modify |
| ----------------------------------------------- | ----------------------------------------------------------------------------- | ---- | ------ |
| [HelloWorld](./wrappers/src/fdw/helloworld_fdw) | A demo FDW to show how to develop a basic FDW. | | |
| [BigQuery](./wrappers/src/fdw/bigquery_fdw) | A FDW for Google [BigQuery](https://cloud.google.com/bigquery) | ✅ | ✅ |
| [Clickhouse](./wrappers/src/fdw/clickhouse_fdw) | A FDW for [ClickHouse](https://clickhouse.com/) | ✅ | ✅ |
| [Stripe](./wrappers/src/fdw/stripe_fdw) | A FDW for [Stripe](https://stripe.com/) API | ✅ | ✅ |
| [Firebase](./wrappers/src/fdw/firebase_fdw) | A FDW for Google [Firebase](https://firebase.google.com/) | ✅ | ❌ |
| [Airtable](./wrappers/src/fdw/airtable_fdw) | A FDW for [Airtable](https://airtable.com/) API | ✅ | ❌ |
| [S3](./wrappers/src/fdw/s3_fdw) | A FDW for [AWS S3](https://aws.amazon.com/s3/) | ✅ | ❌ |
| [Logflare](./wrappers/src/fdw/logflare_fdw) | A FDW for [Logflare](https://logflare.app/) | ✅ | ❌ |
| [Auth0](./wrappers/src/fdw/auth0_fdw) | A FDW for [Auth0](https://auth0.com/) | ✅ | ❌ |
| [SQL Server](./wrappers/src/fdw/mssql_fdw) | A FDW for [Microsoft SQL Server](https://www.microsoft.com/en-au/sql-server/) | ✅ | ❌ |
| [Redis](./wrappers/src/fdw/redis_fdw) | A FDW for [Redis](https://redis.io/) | ✅ | ❌ |
| [AWS Cognito](./wrappers/src/fdw/cognito_fdw) | A FDW for [AWS Cognito](https://aws.amazon.com/cognito/) | ✅ | ❌ |
| [Notion](./wasm-wrappers/fdw/notion_fdw) | A Wasm FDW for [Notion](https://www.notion.so/) | ✅ | ❌ |
| [Snowflake](./wasm-wrappers/fdw/snowflake_fdw) | A Wasm FDW for [Snowflake](https://www.snowflake.com/) | ✅ | ✅ |
| [Paddle](./wasm-wrappers/fdw/paddle_fdw) | A Wasm FDW for [Paddle](https://www.paddle.com/) | ✅ | ✅ |
### Warning
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.
## Features
- Minimum interface and easy to implement.
- Support for rich data types.
- Support both sync and async backends, such as RDBMS, RESTful APIs, flat files and etc.
- Built on top of [pgrx](https://github.com/tcdi/pgrx), providing higher level interfaces, without hiding lower-level C APIs.
- `WHERE`, `ORDER BY`, `LIMIT` pushdown are supported.
## Documentation
- [Usage Docs](https://fdw.dev/)
- [Developer Docs (docs.rs)](https://docs.rs/supabase-wrappers/latest/supabase_wrappers/)
## Installation
`Wrappers` is a pgrx extension, you can follow the [pgrx installation steps](https://github.com/tcdi/pgrx#system-requirements) to install Wrappers.
Basically, run below command to install FDW after `pgrx` is installed. For example,
```bash
cargo pgrx install --pg-config [path_to_pg_config] --features stripe_fdw
```
## Developing a FDW
Visit [Wrappers Docs](https://fdw.dev/) for more details.
## License
[Apache License Version 2.0](./LICENSE)
[](https://crates.io/crates/supabase-wrappers)
[](https://docs.rs/supabase-wrappers)
[](https://github.com/supabase/wrappers/actions/workflows/test_wrappers.yml)
[](./LICENSE)
[](https://github.com/supabase/wrappers/graphs/contributors)