Trunk Logo
Join Trunk on SlackSlack Logo

wrappers

Postgres Foreign Data Wrapper development framework in Rust.

Install

Copied to clipboard!

trunk install wrappers

Wrappers

Wrappers is a development framework for Postgres Foreign Data Wrappers (FDW), 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. We currently support the following FDWs, with more under development:

FDWDescriptionReadModify
HelloWorldA demo FDW to show how to develop a basic FDW.
BigQueryA FDW for Google BigQuery
ClickhouseA FDW for ClickHouse
StripeA FDW for Stripe API
FirebaseA FDW for Google Firebase
AirtableA FDW for Airtable API
S3A FDW for AWS S3
LogflareA FDW for Logflare
Auth0A FDW for Auth0
SQL ServerA FDW for Microsoft SQL Server
RedisA FDW for Redis
AWS CognitoA FDW for AWS Cognito
NotionA Wasm FDW for Notion
SnowflakeA Wasm FDW for Snowflake
PaddleA Wasm FDW for Paddle

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, providing higher level interfaces, without hiding lower-level C APIs.
  • WHERE, ORDER BY, LIMIT pushdown are supported.

Documentation

Installation

Wrappers is a pgrx extension, you can follow the pgrx installation steps to install Wrappers.

Basically, run below command to install FDW after pgrx is installed. For example,

cargo pgrx install --pg-config [path_to_pg_config] --features stripe_fdw

Developing a FDW

Visit Wrappers Docs for more details.

License

Apache License Version 2.0

crates.io badge docs.rs badge Test Status MIT/Apache-2 licensed Contributors

Details

About

CategoryConnectors
Version0.4.2
Last updated2 months ago
LicenseApache-2.0
Architecture
x86-64
Information icon
Operating system
Debian/Ubuntu
Information icon