Zum Inhalt springen
Aurabase-Logo
Aurabasis

Generieren Sie TypeScript-Typen aus Ihrer Datenbank

Ein Befehl verwandelt Ihre Tabellen in Typen. Ihr Editor lehnt dann eine falsche Spalte oder einen falschen Wert ab, bevor Sie etwas ausführen.

Anleitung4 Min. gelesenEbene AnfängerÜberarbeitet am 12.10.2026

Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.

Generieren Sie die Datei#

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

Für die Schema-Introspektion (GET /v1/db/schema) ist ein service_role-Schlüssel (AURABASE_SERVICE_ROLE_KEY) erforderlich. Die Übergabe eines anon-Schlüssels wird mit einer expliziten Meldung abgelehnt. Ohne --url und --key liest @aurabase/gen NEXT_PUBLIC_AURABASE_URL und AURABASE_SERVICE_ROLE_KEY aus Ihrer Umgebung und .env, .env.local, .env.development (oder einen lokalen Schema-Snapshot mit --from-file).

In einem Projekt mit zwei Tabellen und zwei Funktionen wird Folgendes gedruckt:

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

Führen Sie es erneut aus, wenn sich das Schema ändert (oder übergeben Sie --check in CI, um bei einer Schemaabweichung fehlzuschlagen). Fügen Sie --schema <name> für ein anderes Schema als public hinzu, --type-name, um den Haupttyp umzubenennen, und --numeric-as-string, um numeric/decimal als string anstelle von number beizubehalten.

Verwenden Sie es mit dem Kunden#

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!)

Der generierte Typ beschreibt jede Tabelle mit Row, Insert und Update. Für eine echte Datei lieferte der Compiler folgende Ergebnisse:

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   // Fehler: Zeichenfolge kann nicht einer Zahl zugewiesen werden
await aura.from('todos').insert({ title: 1 })         // Fehler: Zahl kann der Zeichenfolge nicht zugewiesen werden
await aura.from('todos').insert({ title: 'ok' })      // ok: Die anderen Spalten haben Standardwerte

In Insert ist eine Spalte mit einer Standardspalte oder einer Spalte, die NULL-Werte zulässt, optional. In Update ist jede Spalte optional.

Zeilentypen für Ihre Komponenten#

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

type Todo = Tables<'todos'>             // eine Zeile, wie gelesen
type NewTodo = TablesInsert<'todos'>    // was insert() akzeptiert
type TodoPatch = TablesUpdate<'todos'>  // was update() akzeptiert

Enums<'name'> gibt die Werte einer Datenbankenum an.

Was wird überprüft#

  • Eine Tabelle, die nicht in der generierten Datei enthalten ist, wird nicht abgelehnt: aura.from('anything') wird weiterhin kompiliert und ihre Zeilen sind untypisiert.
  • Funktionen erscheinen unter Functions mit typisierten Argumenten und Rückgabewerten: add(a int, b int) returns int ergibt Args: { a: number; b: number } und Returns: number und eine RETURNS TABLE (content text, dist float8)-Funktion ergibt Returns: { content: string; dist: number }[]. Eine Funktion, die einen anonymen zusammengesetzten Typ zurückgibt, wird weiterhin als Record<string, unknown> angezeigt.
  • Filter, insert()- und update()-Payloads, Aufzählungen und Beziehungseinbettungen werden überprüft. Die Spaltenliste innerhalb der Zeichenfolge select('a, b') wird zur Eingabe des Ergebnisses verwendet, aber ein falsch geschriebener Name wird dort nur zur Laufzeit abgefangen (COLUMN_NOT_FOUND, mit dem Hinweis „Vielleicht meinten Sie …“).
  • Die -Typen-Schaltfläche von Studio und npx @aurabase/gen erzeugen dieselbe Datei.
  • Die Datei spiegelt das Schema zum Zeitpunkt der Erstellung wider. Eine später hinzugefügte Spalte ist den Typen unbekannt, bis Sie das Tool erneut ausführen.
  • Für die Schema-Introspektion ist AURABASE_SERVICE_ROLE_KEY erforderlich (lokal oder in CI ausführen; niemals einen service_role-Schlüssel festschreiben oder im Client-Code verfügbar machen).