Przejdź do treści
Logo Aurabase
aurabaza

Wygeneruj typy TypeScript ze swojej bazy danych

Jedno polecenie zamienia tabele w typy. Następnie edytor odrzuca niewłaściwą kolumnę lub niewłaściwą wartość, zanim cokolwiek uruchomisz.

Przewodnik krok po kroku4 min przeczytanePoziom początkującyZmieniono 12 paź 2026

Ta strona została przetłumaczona automatycznie. Wersja angielska jest miarodajna.

Wygeneruj plik#

terminalbash
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts

Introspekcja schematu (GET /v1/db/schema) wymaga klucza service_role (AURABASE_SERVICE_ROLE_KEY); przekazanie klucza anon jest odrzucane z wyraźnym komunikatem. Bez --url i --key, @aurabase/gen odczytuje NEXT_PUBLIC_AURABASE_URL i AURABASE_SERVICE_ROLE_KEY z Twojego środowiska oraz .env, .env.local, .env.development (lub migawkę schematu lokalnego z --from-file).

W projekcie z dwiema tabelami i dwiema funkcjami wypisuje:

text
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).

Uruchom go ponownie za każdym razem, gdy zmieni się schemat (lub przekaż --check w CI, aby nie udało się dryfować schematu). Dodaj --schema <name> dla schematu innego niż public, --type-name, aby zmienić nazwę typu głównego i --numeric-as-string, aby zachować numeric/decimal jako string zamiast number.

Użyj go z klientem#

src/lib/aurabase.tstypescript
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from '../types/database.types'

export const aura = createClient<Database>(process.env.NEXT_PUBLIC_AURABASE_URL!, process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!)

Wygenerowany typ opisuje każdą tabelę za pomocą Row, Insert i Update. W porównaniu z prawdziwym plikiem kompilator dał następujące wyniki:

checked.tstypescript
const { data } = await aura.from('todos').select('id, title, done')
const title: string | undefined = data?.[0]?.title   // OK

const wrong: number | undefined = data?.[0]?.title   // błąd: ciągu nie można przypisać do liczby
await aura.from('todos').insert({ title: 1 })         // błąd: liczby nie można przypisać do ciągu
await aura.from('todos').insert({ title: 'ok' })      // ok: pozostałe kolumny mają wartości domyślne

W Insert kolumna z kolumną domyślną lub kolumną dopuszczającą wartość null jest opcjonalna. W Update każda kolumna jest opcjonalna.

Typy wierszy dla komponentów#

Todo.tsxtypescript
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'

type Todo = Tables<'todos'>             // rząd, jak czytano
type NewTodo = TablesInsert<'todos'>    // jaka metoda Insert() akceptuje
type TodoPatch = TablesUpdate<'todos'>  // jaka aktualizacja() akceptuje

Enums<'name'> podaje wartości wyliczenia bazy danych.

Co jest sprawdzane#

  • Tabela, której nie ma w wygenerowanym pliku, jest , a nie odrzucona: aura.from('anything') nadal się kompiluje, a jej wiersze nie mają typu.
  • Funkcje pojawiają się pod Functions z wpisanymi argumentami i zwracanymi wartościami: add(a int, b int) returns int daje Args: { a: number; b: number } i Returns: number, a funkcja RETURNS TABLE (content text, dist float8) daje Returns: { content: string; dist: number }[]. Funkcja zwracająca anonimowy typ złożony nadal jest wyświetlana jako Record<string, unknown>.
  • Sprawdzane są filtry, ładunki insert() i update(), wyliczenia i osadzanie relacji. Lista kolumn wewnątrz ciągu select('a, b') jest używana do wpisania wyniku, ale błędnie napisana nazwa jest wychwytywana tylko w czasie wykonywania (COLUMN_NOT_FOUND, ze wskazówką « Być może miałeś na myśli… »).
  • Przycisk Wpisuje przycisk w Studio i npx @aurabase/gen, tworząc ten sam plik.
  • Plik odzwierciedla schemat z chwili jego wygenerowania. Kolumna dodana później jest nieznana typom do czasu ponownego uruchomienia narzędzia.
  • Introspekcja schematu wymaga AURABASE_SERVICE_ROLE_KEY (uruchom go lokalnie lub w CI; nigdy nie zatwierdzaj klucza service_role ani nie ujawniaj go w kodzie klienta).