PostgREST turns your PostgreSQL database automatically into a RESTful API. Today, PostgREST 9 was released. Let's take a look at some of the new features.
Resource embedding with Inner Joins
PostgREST 9 brings a much-requested feature: the ability to do inner joins when embedding a table.
Here's an example with supabase-js:
const { data, error } = await supabase
.from('messages')
.select('*, users!inner(*)')
.eq('users.username', 'Jane')
With the new !inner keyword, you can now filter rows of the top-level table (messages) based on a filter (eq) of the embedded table (users).
This works across all Supabase client libraries and you can use it with any of the available operators (gt, in, etc.)
Functions with unnamed parameters
You can now make POST requests to functions with a single unnamed parameter. This is particularly useful for webhooks that send JSON payloads.
For example, imagine you were using Postmark as an email provider and you wanted to save email bounces using their bounce webhook. Previously this wouldn't be possible with PostgREST, as every function required a named parameter.
As of PostgREST 9, this is possible. Simply create a function inside your PostgreSQL database to receive the raw JSON:
create function store_bounces(json)
returns json
language sql
as $$
insert into bounces (webhook_id, email)
values (
($1->>'ID')::bigint,
($1->>'Email')::text
);
select '{ "status": 200 }'::json;
$$;
And the webhook can send data directly to your database via an rpc call:
POST https://<PROJECT_REF>.supabase.co/rest/v1/rpc/store_bounces HTTP/1.1
Content-Type: application/json
{
"RecordType": "Bounce",
"MessageStream": "outbound",
"ID": 4323372036854775807,
"Type": "HardBounce",
"MessageID": "883953f4-6105-42a2-a16a-77a8eac79483",
"Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
"Details": "Test bounce details",
"Email": "john@example.com",
"From": "sender@example.com",
"BouncedAt": "2019-11-05T16:33:54.9070259Z"
}
PostgreSQL 14 compatibility
If you've ever done your own custom auth functions using PostgREST HTTP Context,
note that a breaking change was necessary for PostgreSQL 14 Compatibility. You'll need to update them:
From | To |
|---|---|
current_setting('request.jwt.claim.custom-claim', true) | current_setting('request.jwt.claims', true)::json->>'custom-claim' |
current_setting('request.header.custom-header', true) | current_setting('request.headers', true)::json->>'custom-header' |
If you only use Supabase default auth functions(auth.email(), auth.uid(), auth.role()), then no action is required because we have updated the functions to handle these changes transparently.
Release notes
There are a lot more improvements released in PostgREST 9, including support for Partitioned Tables, improved doc, and bug fixes.
You can see the full updates on the PostgREST 9 release notes.