Supabase Raises $30m Series A... Read More
View more posts
2021-07-3012 minute read

Updates for Supabase Functions

Paul CopplestoneCEO and Co-Founder

The question on everyone's mind - are we launching Supabase Functions? Well, it's complicated.

Today we're announcing part of Functions - Supabase Hooks - in Alpha, for all new projects.

We're also releasing support for Postgres Functions and Triggers in our Dashboard, and some timelines for the rest of Supabase Functions. Let's cover the features we're launching today before the item that everyone is waiting for: Supabase Functions.

PostgreSQL Functions

(Not to be confused with Supabase Functions!)

Postgres has built-in support for SQL functions. Today we're making it even easier for developers to build PostgreSQL Functions by releasing a native Functions editor. Soon we'll release some handy templates!

Postgres Functions

You can call PostgreSQL Functions with supabase-js using your project API [Docs]:

1const { data, error } = await supabase
2  .rpc('best_star_wars_series', { 
3     name: 'The Prequels' 
4  })
5

PostgreSQL Triggers

Triggers are another amazing feature of Postgres, which allow you to execute any SQL code after inserting, updating, or deleting data.

While triggers are a staple of Database Administrators, they can be a bit complex and hard to use. We plan to change that with a simple interface for building and managing PostgreSQL triggers.

Postgres Triggers

Supabase Functions

They say building a startup is like jumping off a cliff and assembling the plane on the way down. At Supabase it's more like assembling a 747 since, although we're still in Beta, thousands of companies depend on us to power their apps and websites.

For the past few months we've been designing Supabase Functions based on our customer feedback.

BYO Functions, zero lock-in

A recurring request from our customers is the ability to trigger their existing Functions. This is especially true for our Enterprise customers, but also Jamstack developers who develop API Functions directly within their stack (like Next.js API routes, or Redwood Serverless Functions).

Timeline

To meet these goals, we're releasing Supabase Functions in stages:

  • Stage 1: Give developers the ability to trigger external HTTP functions - today, using Function Hooks.
  • Stage 2: Give developers the ability to trigger their own Serverless functions on AWS and GCP - Q4 2021.
  • Stage 3: Release our own Serverless Functions (Supabase Functions) - Q4 for Early Preview customers.

Supabase Functions timeline

Function Hooks (Alpha)

Today we're releasing Functions Hooks in ALPHA. The ALPHA tag means that it is NOT stable, but it's available for testing and feedback. The API will change, so do not use it for anything critical. You have been warned.

Hooks? Triggers? Firestore has the concept of Function Triggers, which are very cool. Supabase Hooks are the same concept, just with a different name. Postgres already has the concept of Triggers, and we thought this would be less confusing1.

Hook Events

Function Hooks allow you to "listen" to any change in your tables to trigger an asynchronous Function. You can hook into a few different events:INSERT, UPDATE, and DELETE. All events are fired after a database row is changed. Keen eyes will be able to spot the similarity to Postgres triggers, and that's because Function Hooks are just a convenience wrapper around triggers.

Hook Events

Hook Targets

Supabase will support several different targets.

  • HTTP/Webhooks: Send HTTP requests directly from your Postgres Database.
  • AWS Lambda/Google Cloud Run: Provide Supabase with a restricted IAM role to trigger Serverless functions natively.
  • Supabase Functions: We'll develop an end-to-end experience.

Supabase Function Hooks

Hook Payload

If the target is a Serverless function or an HTTP POST request, the payload is automatically generated from the underlying table data. The format matches Supabase Realtime, except in this case you don't a client to "listen" to the changes. This provides yet another mechanism for responding to database changes.

1type InsertPayload = {
2    type: 'INSERT'
3    table: string
4    schema: string
5    record: TableRecord<T>
6    old_record: null
7}
8type UpdatePayload = {
9    type: 'UPDATE'
10    table: string 
11    schema: string
12    record: TableRecord<T>
13    old_record: TableRecord<T>
14}
15type DeletePayload = {
16    type: 'DELETE'
17    table: string
18    schema: string
19    record: null
20    old_record: TableRecord<T>
21}
22

Hooks technical design: pg_net v0.1

As with most of the Supabase platform, we leverage PostgreSQL's native functionality to implement Function Hooks.

To build hooks, we've released a new PostgreSQL Extension, pg_net, an asynchronous networking extension with an emphasis on scalability/throughput. In its initial (unstable) release we expose:

  • asynchronous HTTP GET requests.
  • asynchronous HTTP POST requests with a JSON payload.

The extension is (currently) capable of >300 requests per second and is the networking layer underpinning Function Hooks. For a complete view of capabilities, check out the docs.

Usage

pg_net allows you to make asynchronous HTTP requests directly within your SQL queries.

1-- Make a request
2select
3    net.http_post(
4        url:='https://httpbin.org/post',
5        body:='{"hello": "world"}'::jsonb
6    );
7
8-- Immediately returns a response ID
9http_post
10---------
11        1
12

After making a request, the extension will return an ID. You can use this ID to collect a response.

1-- Collect the response from a request
2select 
3  * 
4from 
5  net.http_collect_response(1);
6  
7-- Results (1 row)
8status  | message | response
9--------+---------+----------
10SUCCESS        ok     (
11                        status_code := 200,
12                        headers     := '{"date": ...}',
13                        body        := '{"args": ...}'
14                      )::net.http_response_result
15

You can cast the response to JSON within PostgreSQL:

1-- Collect the response json payload from a request
2select
3    (response).body::json 
4from 
5    net.http_collect_response(request_id:=1);                               
6

Result:

1 {
2   "args": {},
3   "data": "{\"hello\": \"world\"}",
4   "files": {},
5   "form": {},
6   "headers": {
7     "Accept": "*/*",
8     "Content-Length": "18",
9     "Content-Type": "application/json",
10     "Host": "httpbin.org",
11     "User-Agent": "pg_net/0.1",
12     "X-Amzn-Trace-Id": "Root=1-61031a5c-7e1afeae69bffa8614d8e48e"
13   },
14   "json": {
15     "hello": "world"
16   },
17   "origin": "135.63.38.488",
18   "url": "https://httpbin.org/post"
19 }
20(1 row)
21

Implementation

To build asynchronous behavior, we use a PostgreSQL background worker with a queue. This, coupled with the libcurl multi interface, enables us to do multiple simultaneous requests in the same background worker process.

Shout out to Paul Ramsey, who gave us the implementation idea in pgsql-http. While we originally hoped to add background workers to his extension, the implementation became too cumbersome and we decided to start with a clean slate. The advantage of being async can be seen by making some requests with both extensions:

1\timing on
2
3-- using pgsql-http to fetch from "supabase.io" 10 times
4select 
5    * 
6from 
7   http_get('https://supabase.io') 
8cross join 
9   generate_series(1, 10) _;
10
11-- Returns in 3.5 seconds
12Time: 3501.935 ms
13
14-- using pg_net to fetch from "supabase.io" 10 times
15select 
16    net.http_get('https://supabase.io') 
17from 
18    generate_series (1,10) _;
19
20-- Returns in 1.5 milliseconds
21Time: 1.562 ms
22

Of course, the sync version waits until each request is completed to return the result, taking around 3.5 seconds for 10 requests; while the async version returns almost immediately in 1.5 milliseconds. This is really important for Supabase hooks, which run requests for every event fired from a SQL trigger - potentially thousands of requests per second.

Future/Roadmap

This is only the beginning! First we'll thoroughly test it and make a stable release, then we expect to add support for

  • the remaining HTTP methods (PUT / PATCH)
  • synchronous HTTP
  • additional protocols e.g. SMTP, FTP
  • more throughput (using epoll)

Get started today

Function Hooks is enabled today on all new projects. Find it under Database > Alpha Preview > Function Hooks.

Enable hooks


  1. Postgres also has the concept of Hooks, but they're more of an internal concept.
Related articles
Supabase Swag Store
Updates for Supabase Functions
The Supabase Hackathon
Supabase Reports and Metrics
Supabase Auth v2: Phone Auth now available
View all posts
Last post

Supabase Swag Store

July 30, 2021
launch-weekswag
Next post

The Supabase Hackathon

July 30, 2021
launch-weekhackathon

Build in a weekend, scale to millions