İçeriğe geç
Aurabase Logosu
aura tabanı

Veritabanınızdan TypeScript türleri oluşturun

Tek bir komut tablolarınızı türlere dönüştürür. Editörünüz daha sonra herhangi bir şeyi çalıştırmadan önce yanlış bir sütunu veya yanlış bir değeri reddeder.

Nasıl yapılır kılavuzu4 dk. okuSeviye acemi12 Eki 2026 tarihinde revize edildi

Bu sayfa otomatik olarak çevrildi. İngilizce versiyonu yetkilidir.

Dosyayı oluştur#

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

Şema iç gözlemi (GET /v1/db/schema) bir service_role anahtarı (AURABASE_SERVICE_ROLE_KEY) gerektirir; anon anahtarının iletilmesi açık bir mesajla reddedilir. --url ve --key olmadan, @aurabase/gen ortamınızdan NEXT_PUBLIC_AURABASE_URL ve AURABASE_SERVICE_ROLE_KEY okur ve .env, .env.local, .env.development (veya --from-file ile yerel şema anlık görüntüsünü) okur.

İki tablo ve iki işlev içeren bir projede şunu yazdırır:

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

Şema değiştiğinde yeniden çalıştırın (veya şema kaymasında başarısız olmak için CI'da --check iletin). public dışındaki bir şema için --schema <name>, ana türü yeniden adlandırmak için --type-name ve numeric/decimal öğesini number yerine string olarak tutmak için --numeric-as-string ekleyin.

İstemciyle birlikte kullanın#

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

Oluşturulan tür her tabloyu Row, Insert ve Update ile açıklar. Gerçek bir dosyaya karşı derleyici şu sonuçları verdi:

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

const wrong: number | undefined = data?.[0]?.title   // hata: dize sayıya atanamaz
await aura.from('todos').insert({ title: 1 })         // hata: sayı dizeye atanamaz
await aura.from('todos').insert({ title: 'ok' })      // tamam: diğer sütunların varsayılanları var

Insert'de, varsayılan veya null değeri olan bir sütuna sahip bir sütun isteğe bağlıdır. Update'de her sütun isteğe bağlıdır.

Bileşenleriniz için satır türleri#

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

type Todo = Tables<'todos'>             // okunduğu gibi bir satır
type NewTodo = TablesInsert<'todos'>    // insert() neyi kabul eder
type TodoPatch = TablesUpdate<'todos'>  // update() neyi kabul eder

Enums<'name'> bir veritabanı numaralandırmasının değerlerini verir.

Ne kontrol ediliyor#

  • Oluşturulan dosyada bulunmayan bir tablo değil, reddedildi: aura.from('anything') hala derleniyor ve satırlarının türü yazılmamış.
  • İşlevler, yazılan bağımsız değişkenler ve dönüş değerleriyle Functions altında görünür: add(a int, b int) returns int, Args: { a: number; b: number } ve Returns: number değerini verir ve RETURNS TABLE (content text, dist float8) işlevi, Returns: { content: string; dist: number }[] değerini verir. Anonim bir bileşik tür döndüren bir işlev hala Record<string, unknown> olarak gösterilir.
  • Filtreler, insert() ve update() yükleri, numaralandırmalar ve ilişki yerleştirmeleri kontrol edilir. select('a, b') dizesinin içindeki sütun listesi sonucu yazmak için kullanılır, ancak burada yanlış yazılmış bir ad yalnızca çalışma zamanında yakalanır (COLUMN_NOT_FOUND, « Belki de şunu demek istediniz... » ipucuyla).
  • Studio'nun Türleri düğmesi ve npx @aurabase/gen aynı dosyayı üretir.
  • Dosya, onu oluşturduğunuz andaki şemayı yansıtır. Daha sonra eklenen bir sütun, siz aracı yeniden çalıştırana kadar türler tarafından bilinmez.
  • Şema iç gözlemi AURABASE_SERVICE_ROLE_KEY gerektirir (bunu yerel olarak veya CI'da çalıştırın; asla bir service_role anahtarı işlemeyin veya onu istemci kodunda göstermeyin).