Genere tipos TypeScript desde su base de datos
Un comando convierte tus tablas en tipos. Luego, su editor rechaza una columna incorrecta o un valor incorrecto antes de ejecutar cualquier cosa.
Generar el archivo#
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts
La introspección de esquemas (GET /v1/db/schema) requiere una clave service_role (AURABASE_SERVICE_ROLE_KEY); pasar una clave anon se rechaza con un mensaje explícito. Sin --url y --key, @aurabase/gen lee NEXT_PUBLIC_AURABASE_URL y AURABASE_SERVICE_ROLE_KEY de su entorno y .env, .env.local, .env.development (o una instantánea de esquema local con --from-file).
En un proyecto con dos tablas y dos funciones, imprime:
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).
Ejecútelo nuevamente cada vez que cambie el esquema (o pase --check en CI para fallar en la deriva del esquema). Agregue --schema <name> para un esquema que no sea public, --type-name para cambiar el nombre del tipo principal y --numeric-as-string para mantener numeric/decimal como string en lugar de number.
Úsalo con el cliente.#
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!)
El tipo generado describe cada tabla con Row, Insert y Update. Comparado con un archivo real, el compilador dio estos resultados:
const { data } = await aura.from('todos').select('id, title, done')
const title: string | undefined = data?.[0]?.title // bien
const wrong: number | undefined = data?.[0]?.title // error: la cadena no se puede asignar al número
await aura.from('todos').insert({ title: 1 }) // error: el número no se puede asignar a la cadena
await aura.from('todos').insert({ title: 'ok' }) // ok: las otras columnas tienen valores predeterminados
En Insert, una columna con una columna predeterminada o que acepta valores NULL es opcional. En Update, cada columna es opcional.
Tipos de filas para sus componentes#
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'
type Todo = Tables<'todos'> // una fila, como se lee
type NewTodo = TablesInsert<'todos'> // qué insert() acepta
type TodoPatch = TablesUpdate<'todos'> // qué actualización() acepta
Enums<'name'> proporciona los valores de una enumeración de base de datos.
que esta comprobado#
- Una tabla que no está en el archivo generado es no rechazada:
aura.from('anything')aún se compila y sus filas no están tipificadas. - Las funciones aparecen en
Functionscon argumentos escritos y valores de retorno:add(a int, b int) returns intproporcionaArgs: { a: number; b: number }yReturns: number, y una funciónRETURNS TABLE (content text, dist float8)proporcionaReturns: { content: string; dist: number }[]. Una función que devuelve un tipo compuesto anónimo todavía se muestra comoRecord<string, unknown>. - Se verifican los filtros, las cargas útiles
insert()yupdate(), las enumeraciones y las incrustaciones de relaciones. La lista de columnas dentro de la cadenaselect('a, b')se usa para escribir el resultado, pero un nombre mal escrito solo se detecta en tiempo de ejecución (COLUMN_NOT_FOUND, con una sugerencia de "Quizás quisiste decir..."). - El botón Types de Studio y
npx @aurabase/genproducen el mismo archivo. - El archivo refleja el esquema en el momento en que lo generó. Una columna agregada más tarde es desconocida para los tipos hasta que vuelva a ejecutar la herramienta.
- La introspección de esquema requiere
AURABASE_SERVICE_ROLE_KEY(ejecútelo localmente o en CI; nunca confirme una claveservice_roleni la exponga en el código del cliente).