Use Supabase with RedwoodJS

Learn how to create a Supabase project, add some sample data to your database using Prisma migration and seeds, and query the data from a RedwoodJS app.

Setup your new Supabase Project

Create a new project in the Supabase Dashboard.

Be sure to make note of the Database Password you used as you will need this later to connect to your database.

New project for redwoodjs

Gather Database Connection Strings

Go to the database settings page. In this quickstart, we are going to connect via the connection pooler. If your network supports IPv6, you can connect to the database directly without using the connection pooler.

We will use the pooler both in Transaction and Session mode. Transaction mode is used for application queries and Session mode is used for running migrations with Prisma.

To do this, set the connection mode to Transaction in the database settings page and copy the connection string and append ?pgbouncer=true&&connection_limit=1. pgbouncer=true disables Prisma from generating prepared statements. This is required since our connection pooler does not support prepared statements in transaction mode yet. The connection_limit=1 parameter is only required if you are using Prisma from a serverless environment. This is the Transaction mode connection string.

To get the Session mode connection pooler string, change the port of the connection string from the dashboard to 5432.

You will need the Transaction mode connection string and the Session mode connection string to setup environment variables in Step 5.

You can copy and paste these connection strings from the Supabase Dashboard when needed in later steps.

pooled connection for redwoodjs

Create a RedwoodJS app

Create a RedwoodJS app with TypeScript.

The yarn package manager is required to create a RedwoodJS app. You will use it to run RedwoodJS commands later.

While TypeScript is recommended, If you want a JavaScript app, omit the --ts flag.

1
yarn create redwood-app my-app --ts

Open your RedwoodJS app in VS Code

You'll develop your app, manage database migrations, and run your app in VS Code.

1
2
cd my-appcode .

Configure Environment Variables

In your .env file, add the following environment variables for your database connection:

The DATABASE_URL should use the Transaction mode connection string you copied in Step 1.
The DIRECT_URL should use the Session mode connection string you copied in Step 1.

1
2
3
4
5
# Transaction mode connection string used for migrationsDATABASE_URL="postgres://postgres.[project-ref]:[db-password]@xxx.pooler.supabase.com:6543/postgres?pgbouncer=true&connection_limit=1"# Session mode connection string — used by Prisma ClientDIRECT_URL="postgres://postgres.[project-ref]:[db-password]@xxx.pooler.supabase.com:5432/postgres"

Update your Prisma Schema

By default, RedwoodJS ships with a SQLite database, but we want to use Postgres.

Update your Prisma schema file api/db/schema.prisma to use your Supabase Postgres database connection environment variables you setup in Step 5.

1
2
3
4
5
datasource db {  provider  = "postgresql"  url       = env("DATABASE_URL")  directUrl = env("DIRECT_URL")}

Create the Instrument model and apply a schema migration

Create the Instrument model in api/db/schema.prisma and then run yarn rw prisma migrate dev from your terminal to apply the migration.

1
2
3
4
model Instrument {  id   Int    @id @default(autoincrement())  name String @unique}

Update seed script

Let's seed the database with a few instruments.

Update the file scripts/seeds.ts to contain the following code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import type { Prisma } from '@prisma/client'import { db } from 'api/src/lib/db'export default async () => {  try {    const data: Prisma.InstrumentCreateArgs['data'][] = [      { name: 'dulcimer' },      { name: 'harp' },      { name: 'guitar' },    ]    console.log('Seeding instruments ...')    const instruments = await db.instrument.createMany({ data })    console.log('Done.', instruments)  } catch (error) {    console.error(error)  }}

Seed your database

Run the seed database command to populate the Instrument table with the instruments you just created.

The reset database command yarn rw prisma db reset will recreate the tables and will also run the seed script.

1
yarn rw prisma db seed

Scaffold the Instrument UI

Now, we'll use RedwoodJS generators to scaffold a CRUD UI for the Instrument model.

1
yarn rw g scaffold instrument

Start the app

Start the app via yarn rw dev. A browser will open to the RedwoodJS Splash page.

RedwoodJS Splash Page

View Books UI

Click on /instruments to visit http://localhost:8910/instruments where should see the list of instruments.

You may now edit, delete, and add new books using the scaffolded UI.