Skip to content
pgflow (Workflow Engine for Supabase)

Install Edge Worker

Let’s set up a few things before working with Edge Worker. This setup needs to be done only once per project.

  1. Install migration

    Run this command to download the migration file to your project (replace supabase/migrations with your migrations folder):

    wget -P supabase/migrations \
        https://raw.githubusercontent.com/pgflow-dev/pgflow/refs/heads/main/pkgs/core/supabase/migrations/000_edge_worker_initial.sql

    Then apply the migration:

    npx supabase migration up

  2. Prepare connection string

    Your worker needs to connect to your Supabase project’s database.

    Edge Worker looks for the connection string in the EDGE_WORKER_DB_URL environment variable.

    For local development, put this in supabase/functions/.env:

    EDGE_WORKER_DB_URL="postgresql://postgres.pooler-dev:postgres@pooler:6543/postgres"

  3. Setup Connection Pool

    Modify the db.pooler section in your supabase/config.toml file to enable pooler and make sure that db.pool_mode is set to "transaction".

    [db.pooler]
    enabled = false
    enabled = true
    # Port to use for the local connection pooler.
    port = 54329
    # Specifies when a server connection can be reused by other clients.
    # Configure one of the supported pooler modes: `transaction`, `session`.
    pool_mode = "transaction"
    # How many server connections to allow per user/database pair.
    default_pool_size = 20
    # Maximum number of client connections allowed.
    max_client_conn = 100

  4. Setup Edge Runtime policy

    We need to change the Edge Runtime policy to per_worker to enable Background Tasks (see more in Testing background tasks locally).

    [edge_runtime]
    enabled = true
    # Configure one of the supported request policies: `oneshot`, `per_worker`.
    # Use `oneshot` for hot reload, or `per_worker` for load testing.
    policy = "oneshot"
    policy = "per_worker"
    # Port to attach the Chrome inspector for debugging edge functions.
    inspector_port = 8083

  5. Restart Supabase

    To apply the changes, restart Supabase:

    npx supabase stop
    npx supabase start

That’s it! You’re ready to create your first worker and start processing messages 🥳