Genereer TypeScript typen uit uw database
Eén opdracht verandert uw tabellen in typen. Uw editor wijst vervolgens een verkeerde kolom of een verkeerde waarde af voordat u iets uitvoert.
Genereer het bestand#
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts
Schema-introspectie (GET /v1/db/schema) vereist een service_role sleutel (AURABASE_SERVICE_ROLE_KEY); het doorgeven van een anon-sleutel wordt afgewezen met een expliciet bericht. Zonder --url en --key leest @aurabase/gen NEXT_PUBLIC_AURABASE_URL en AURABASE_SERVICE_ROLE_KEY uit uw omgeving en .env, .env.local, .env.development (of een lokale schema-snapshot met --from-file).
Op een project met twee tabellen en twee functies wordt het volgende afgedrukt:
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).
Voer het opnieuw uit wanneer het schema verandert (of geef --check door in CI om te voorkomen dat het schema afwijkt). Voeg --schema <name> toe voor een ander schema dan public, --type-name om de naam van het hoofdtype te wijzigen, en --numeric-as-string om numeric/decimal te behouden als string in plaats van number.
Gebruik het samen met de klant#
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!)
Het gegenereerde type beschrijft elke tabel met Row, Insert en Update. Tegen een echt bestand gaf de compiler deze resultaten:
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 // fout: string is niet toewijsbaar aan nummer
await aura.from('todos').insert({ title: 1 }) // fout: nummer is niet toewijsbaar aan string
await aura.from('todos').insert({ title: 'ok' }) // ok: de andere kolommen hebben standaardwaarden
In Insert is een kolom met een standaardkolom of een null-kolom optioneel. In Update is elke kolom optioneel.
Rijtypen voor uw componenten#
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'
type Todo = Tables<'todos'> // een rij, zoals gelezen
type NewTodo = TablesInsert<'todos'> // wat insert() accepteert
type TodoPatch = TablesUpdate<'todos'> // welke update() accepteert
Enums<'name'> geeft de waarden van een database-enum.
Wat wordt gecontroleerd#
- Een tabel die niet in het gegenereerde bestand staat, is en niet afgewezen:
aura.from('anything')wordt nog steeds gecompileerd en de rijen ervan zijn niet getypt. - Functies verschijnen onder
Functionsmet getypte argumenten en retourwaarden:add(a int, b int) returns intgeeftArgs: { a: number; b: number }enReturns: number, en eenRETURNS TABLE (content text, dist float8)functie geeftReturns: { content: string; dist: number }[]. Een functie die een anoniem samengesteld type retourneert, wordt nog steeds weergegeven alsRecord<string, unknown>. - Filters,
insert()enupdate()payloads, opsommingen en insluitingen van relaties worden gecontroleerd. De kolomlijst binnen deselect('a, b')-reeks wordt gebruikt om het resultaat te typen, maar een verkeerd gespelde naam wordt alleen opgemerkt tijdens runtime (COLUMN_NOT_FOUND, met een hint "Misschien bedoelde u …"). - De Typen knop van Studio en
npx @aurabase/genproduceren hetzelfde bestand. - Het bestand weerspiegelt het schema op het moment dat u het hebt gegenereerd. Een later toegevoegde kolom is onbekend voor de typen totdat u het hulpprogramma opnieuw uitvoert.
- Voor schema-introspectie is
AURABASE_SERVICE_ROLE_KEYvereist (voer het lokaal of in CI uit; voer nooit eenservice_role-sleutel in en stel deze nooit bloot in clientcode).