wrappers

Overview

manual updated pgrx by Vonng

Version

Build

You can build the RPM / DEB packages for wrappers using pig build:

pig build pkg wrappers         # build RPM / DEB packages

Install

You can install wrappers directly. First, make sure the PGDG and PIGSTY repositories are added and enabled:

pig repo add pgsql -u          # Add repo and update cache

Install the extension using pig or apt/yum/dnf:

• Install
• pig
• dnf
• apt

pig install wrappers;          # Install for current active PG version

pig ext install -y wrappers -v 18  # PG 18
pig ext install -y wrappers -v 17  # PG 17
pig ext install -y wrappers -v 16  # PG 16
pig ext install -y wrappers -v 15  # PG 15
pig ext install -y wrappers -v 14  # PG 14

dnf install -y wrappers_18       # PG 18
dnf install -y wrappers_17       # PG 17
dnf install -y wrappers_16       # PG 16
dnf install -y wrappers_15       # PG 15
dnf install -y wrappers_14       # PG 14

apt install -y postgresql-18-wrappers   # PG 18
apt install -y postgresql-17-wrappers   # PG 17
apt install -y postgresql-16-wrappers   # PG 16
apt install -y postgresql-15-wrappers   # PG 15
apt install -y postgresql-14-wrappers   # PG 14

Create Extension:

CREATE EXTENSION wrappers;

Usage

wrappers: Foreign data wrappers developed by Supabase

Supabase Wrappers is a framework for building PostgreSQL Foreign Data Wrappers (FDW), with 30+ pre-built connectors for cloud services, databases, and APIs. It supports WHERE, ORDER BY, and LIMIT pushdown, with some wrappers also supporting data modification (INSERT/UPDATE/DELETE).

Available Wrappers

Example (Stripe)

CREATE EXTENSION wrappers;

CREATE SERVER stripe_server
  FOREIGN DATA WRAPPER stripe_wrapper
  OPTIONS (
    api_key_id '<key_ID>',
    api_url 'https://api.stripe.com/v1/',
    api_version '2024-06-20'
  );

CREATE FOREIGN TABLE stripe_customers (
  id text,
  email text,
  name text,
  description text,
  created timestamp,
  attrs jsonb
)
  SERVER stripe_server
  OPTIONS (
    object 'customers',
    rowid_column 'id'
  );

SELECT id, email, name FROM stripe_customers WHERE email LIKE '%@example.com';

The rowid_column option is required for INSERT/UPDATE/DELETE support. The attrs column provides access to additional metadata as JSON.

Each wrapper uses its own FOREIGN DATA WRAPPER name (e.g., stripe_wrapper, firebase_wrapper, clickhouse_wrapper), but they are all installed via the single wrappers extension. Refer to the documentation for wrapper-specific options and supported objects.