supabase-drizzle-bootstrap

Bootstrap Drizzle with Supabase

Overview

Guidelines for setting up and using Drizzle ORM with Supabase PostgreSQL.

actions:

• type: suggest message: | When setting up Drizzle with Supabase:

  1. Install required dependencies:

  npm install drizzle-orm pg @types/pg postgres jwt-decode
  npm install -D drizzle-kit
  

  1. Create a drizzle config file (drizzle.config.ts):

    import { config } from 'dotenv';
    import { defineConfig } from 'drizzle-kit';
  
    config({ path: '.env' });
  
    export default defineConfig({
    schema: './db/schema/index.ts',
    out: './supabase/migrations',
    dialect: 'postgresql',
    dbCredentials: {
        url: process.env.DATABASE_URL!,
    },
    });
  

  1. Schema files should be organized as:

  src/
  └── db/
      ├── schema/
      │   ├── index.ts // exports all schema definitions.          
      │   ├── auth.ts
      │   ├── todos.ts
      │   └── ...
      ├── drizzle.ts
      ├── index.ts
      └── jwt.ts
  

  1. Example schema structure:

  import { eq } from 'drizzle-orm'
  import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
  import { authUid, authUsers, authenticatedRole } from 'drizzle-orm/supabase'
  
  export const todos = pgTable('todos', {
    id: uuid('id').defaultRandom().primaryKey(),
    title: text('title').notNull(),
    completed: boolean('completed').notNull().default(false),
    created_at: timestamp('created_at').defaultNow().notNull(),
    user_id: uuid('user_id').notNull().references(() => authUsers.id, { onDelete: "cascade" })
  }, (table) => [
  
    // Row Level Security is defined here
    pgPolicy("users can insert their own todos", {
        for: "insert",
        to: authenticatedRole,
        withCheck: eq(table.id, authUid)
    }),
    pgPolicy("users can update their own todos", {
        for: "update",
        to: authenticatedRole,
        using: eq(table.id, authUid),
        withCheck: eq(table.id, authUid),
    }),
  ])