生成 TypeScript 类型

1
npm i supabase@">=1.8.1" --save-dev

1
npx supabase login

1
npx supabase init

1
npx supabase gen types typescript --project-id "$PROJECT_REF" --schema public > database.types.ts

1
npx supabase gen types typescript --local > database.types.ts

1
npx supabase gen types typescript --db-url postgres://postgres.[POOLER_TENANT_ID]:[POSTGRES_PASSWORD]@[your-domain-or-ip]:5432/postgres --schema public > database.types.ts

1
create table public.movies (
2
  id bigint generated always as identity primary key,
3
  name text not null,
4
  data jsonb null
5
);

1
export type Json = string | number | boolean | null | { [key: string]: Json | undefined } | Json[]
2
3
export interface Database {
4
  public: {
5
    Tables: {
6
      movies: {
7
        Row: {
8
          // the data expected from .select()
9
          id: number
10
          name: string
11
          data: Json | null
12
        }
13
        Insert: {
14
          // the data to be passed to .insert()
15
          id?: never // generated columns must not be supplied
16
          name: string // `not null` columns with no default must be supplied
17
          data?: Json | null // nullable columns can be omitted
18
        }
19
        Update: {
20
          // the data to be passed to .update()
21
          id?: never
22
          name?: string // `not null` columns are optional on .update()
23
          data?: Json | null
24
        }
25
      }
26
    }
27
  }
28
}

1
import { createClient } from '@supabase/supabase-js'
2
3
import { Database } from './database.types'
4
5
const supabase = createClient<Database>(
6
  process.env.SUPABASE_URL,
7
  process.env.SUPABASE_PUBLISHABLE_KEY
8
)

1
export type Json = // ...
2
3
export interface Database {
4
  // ...
5
}

1
import { MergeDeep } from 'type-fest'
2
3
import { Database as DatabaseGenerated } from './database-generated.types'
4
5
export { Json } from './database-generated.types'
6
7
// Override the type for a specific column in a view:
8
export type Database = MergeDeep<
9
  DatabaseGenerated,
10
  {
11
    public: {
12
      Views: {
13
        movies_view: {
14
          Row: {
15
            // id is a primary key in public.movies, so it must be `not null`
16
            id: number
17
          }
18
        }
19
      }
20
    }
21
  }
22
>

1
import { MergeDeep } from 'type-fest'
2
3
import { Database as DatabaseGenerated } from './database-generated.types'
4
5
// Define your custom JSON type
6
type CustomJsonType = {
7
  foo: string
8
  bar: { baz: number }
9
  en: 'ONE' | 'TWO' | 'THREE'
10
}
11
12
export type Database = MergeDeep<
13
  DatabaseGenerated,
14
  {
15
    public: {
16
      Tables: {
17
        your_table: {
18
          Row: {
19
            data: CustomJsonType | null
20
          }
21
          // Optional: Use if you want type-checking for inserts and updates
22
          // Insert: {
23
          //   data?: CustomJsonType | null;
24
          // };
25
          // Update: {
26
          //   data?: CustomJsonType | null;
27
          // };
28
        }
29
      }
30
      Views: {
31
        your_view: {
32
          Row: {
33
            data: CustomJsonType | null
34
          }
35
        }
36
      }
37
    }
38
  }
39
>

1
const res = await client.from('your_table').select('data->bar->baz, data->en, data->bar')
2
3
if (res.data) {
4
  console.log(res.data)
5
  // TypeScript infers the shape of your JSON data:
6
  // [
7
  //   {
8
  //     baz: number;
9
  //     en: 'ONE' | 'TWO' | 'THREE';
10
  //     bar: { baz: number };
11
  //   }
12
  // ]
13
}

1
// Partial type override allows you to only override some of the properties in your results
2
const { data } = await supabase.from('countries').select().overrideTypes<Array<{ id: string }>>()
3
// For a full replacement of the original return type use the `{ merge: false }` property as second argument
4
const { data } = await supabase
5
  .from('countries')
6
  .select()
7
  .overrideTypes<Array<{ id: string }>, { merge: false }>()
8
// Use it with `maybeSingle` or `single`
9
const { data } = await supabase.from('countries').select().single().overrideTypes<{ id: string }>()

1
import { Database, Tables, Enums } from "./database.types.ts";
2
3
// Before 😕
4
let movie: Database['public']['Tables']['movies']['Row'] = // ...
5
6
// After 😍
7
let movie: Tables<'movies'>

1
create table countries (
2
  "id" serial primary key,
3
  "name" text
4
);
5
6
create table cities (
7
  "id" serial primary key,
8
  "name" text,
9
  "country_id" int references "countries"
10
);

1
import { QueryData, QueryError, QueryResult } from '@supabase/supabase-js'
2
3
const countriesWithCitiesQuery = supabase.from('countries').select(`
4
  id,
5
  name,
6
  cities (
7
    id,
8
    name
9
  )
10
`)
11
type CountriesWithCities = QueryData<typeof countriesWithCitiesQuery>
12
13
const { data, error } = await countriesWithCitiesQuery
14
if (error) throw error
15
const countriesWithCities: CountriesWithCities = data

1
"update-types": "npx supabase gen types --lang=typescript --project-id \"$PROJECT_REF\" > database.types.ts"

1
name: Update database types
2
3
on:
4
  schedule:
5
    # sets the action to run daily. You can modify this to run the action more or less frequently
6
    - cron: '0 0 * * *'
7
8
jobs:
9
  update:
10
    runs-on: ubuntu-latest
11
    permissions:
12
      contents: write
13
    env:
14
      SUPABASE_ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
15
      PROJECT_REF: <your-project-id>
16
    steps:
17
      - uses: actions/checkout@v4
18
        with:
19
          persist-credentials: false
20
          fetch-depth: 0
21
      - uses: actions/setup-node@v4
22
        with:
23
          node-version: 22
24
      - run: npm run update-types
25
      - name: check for file changes
26
        id: git_status
27
        run: |
28
          echo "status=$(git status -s)" >> $GITHUB_OUTPUT
29
      - name: Commit files
30
        if: ${{contains(steps.git_status.outputs.status, ' ')}}
31
        run: |
32
          git add database.types.ts
33
          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
34
          git config --local user.name "github-actions[bot]"
35
          git commit -m "Update database types" -a
36
      - name: Push changes
37
        if: ${{contains(steps.git_status.outputs.status, ' ')}}
38
        uses: ad-m/github-push-action@master
39
        with:
40
          github_token: ${{ secrets.GITHUB_TOKEN }}
41
          branch: ${{ github.ref }}