Genereer TypeScript typen uit uw database

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

De tool leest het schema van uw project en schrijft het bestand. Zonder --url en --key zoekt het naar AURABASE_URL en AURABASE_ANON_KEY (ook NEXT_PUBLIC_AURABASE_URL, VITE_AURABASE_URL en AURABASE_SERVICE_ROLE_KEY) in uw omgeving en in .env, .env.local en .env.development.

Op een project met twee tabellen en twee functies antwoordde het:

[aurabase-gen] ✓ Types écrits dans /tmp/database.types.ts (2 table(s), 2 fonction(s), 0 enum(s), 0 vue(s)).

Voer het opnieuw uit wanneer het schema verandert. Voeg --schema <name> toe voor een ander schema dan public en --type-name om de naam van het hoofdtype te wijzigen.

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

export const aura = createClient<Database>(process.env.AURA_URL!, process.env.AURA_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.

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.

• 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 Functions met hun argumenten. Een functie die een aangepast rijtype retourneert, wordt weergegeven als Json of unknown.
• 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.
• Gebruik de openbare sleutel om de typen te genereren, tenzij sommige tabellen ervoor verborgen zijn. Voer nooit een service_role-sleutel in.