Supabase

This connector materializes Flow collections into tables in a Supabase PostgreSQL database.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/materialize-supabase-postgres:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

Prerequisites

To use this connector, you'll need:

• A Postgres database in Supabase to materialize into, with user credentials. The connector will create new tables in the database per your specification. Tables created manually in advance are not supported.
• A Supabase direct connection hostname which bypasses the Supabase connection pooler. See Setup for details.
• At least one Flow collection

Setup

You must configure your database to allow connections from Estuary.

By default, Supabase guides users into connecting to their database through a Connection Pooler. Connection poolers are helpful for many applications, but unfortunately the pooler does not work well with temporary tables and prepared statements that this connector relies on.

This materialization connector requires a direct connection address for your database. The address can be found by clicking on the Connect button in your Supabase dashboard. Under the Direct connection option, copy the host and port for your database.

For example, if the provided connection string is postgresql://postgres:[YOUR-PASSWORD]@db.abcdef.supabase.co:5432/postgres, then the address is db.abcdef.supabase.co:5432.

Configuration

To use this connector, begin with data in one or more Flow collections. Use the below properties to configure a Supabase materialization, which will direct one or more of your Flow collections to your desired tables, or views, in the database.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/address	Address	Host and port of the database. If only the host is specified, port will default to 5432.	string	Required
/user	User	Database user to connect as.	string	Required
/password	Password	Password for the specified database user.	string	Required
/database	Database	Name of the logical database to materialize to.	string
/schema	Database Schema	Database schema to use for materialized tables (unless overridden within the binding resource configuration) as well as associated materialization metadata tables	string	"public"
/advanced	Advanced Options	Options for advanced users. You should not typically need to modify these.	object
/advanced/sslmode	SSL Mode	Overrides SSL connection behavior by setting the 'sslmode' parameter.	string

Bindings

Property	Title	Description	Type	Required/Default
/additional_table_create_sql	Additional Table Create SQL	Additional SQL statement(s) to be run in the same transaction that creates the table.	string
/delta_updates	Delta Update	Should updates to this table be done via delta updates.	boolean	false
/schema	Alternative Schema	Alternative schema for this table (optional). Overrides schema set in endpoint configuration.	string
/table	Table	Table name to materialize to. It will be created by the connector, unless the connector has previously created it.	string	Required

Sample

materializations:
  ${PREFIX}/${mat_name}:
    endpoint:
      connector:
        image: ghcr.io/estuary/materialize-supabase-postgres:dev
        config:
          database: flow
          address: db.abcdef.supabase.co:5432
          password: your-secure-password
          user: flow
    bindings:
      - resource:
          table: ${TABLE_NAME}
        source: ${PREFIX}/${COLLECTION_NAME}

Delta updates

This connector supports both standard (merge) and delta updates. The default is to use standard updates.

Reserved words

PostgreSQL has a list of reserved words that must be quoted in order to be used as an identifier. Flow considers all the reserved words that are marked as "reserved" in any of the columns in the official PostgreSQL documentation.

Flow automatically quotes fields that are in this reserved words list.