अपने डेटाबेस से TypeScript प्रकार उत्पन्न करें
एक कमांड आपकी तालिकाओं को प्रकारों में बदल देता है। आपके कुछ भी चलाने से पहले आपका संपादक किसी गलत कॉलम या गलत मान को अस्वीकार कर देता है।
फ़ाइल जनरेट करें#
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts
स्कीमा आत्मनिरीक्षण (GET /v1/db/schema) के लिए service_role कुंजी (AURABASE_SERVICE_ROLE_KEY) की आवश्यकता होती है; anon कुंजी को पास करना एक स्पष्ट संदेश के साथ अस्वीकार कर दिया जाता है। --url और --key के बिना, @aurabase/gen आपके वातावरण से NEXT_PUBLIC_AURABASE_URL और AURABASE_SERVICE_ROLE_KEY पढ़ता है और .env, .env.local, .env.development (या --from-file के साथ एक स्थानीय स्कीमा स्नैपशॉट)।
दो तालिकाओं और दो कार्यों वाले प्रोजेक्ट पर, यह प्रिंट करता है:
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).
जब भी स्कीमा बदलती है तो इसे फिर से चलाएँ (या स्कीमा ड्रिफ्ट पर विफल होने के लिए CI में --check पास करें)। public के अलावा किसी अन्य स्कीमा के लिए --schema <name> जोड़ें, मुख्य प्रकार का नाम बदलने के लिए --type-name और number के बजाय numeric/decimal को string रखने के लिए --numeric-as-string जोड़ें।
इसे क्लाइंट के साथ प्रयोग करें#
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!)
उत्पन्न प्रकार प्रत्येक तालिका का वर्णन Row, Insert और Update के साथ करता है। एक वास्तविक फ़ाइल के विरुद्ध, संकलक ने ये परिणाम दिए:
const { data } = await aura.from('todos').select('id, title, done')
const title: string | undefined = data?.[0]?.title // ठीक है
const wrong: number | undefined = data?.[0]?.title // त्रुटि: स्ट्रिंग संख्या के लिए निर्दिष्ट नहीं है
await aura.from('todos').insert({ title: 1 }) // त्रुटि: संख्या स्ट्रिंग के लिए निर्दिष्ट नहीं है
await aura.from('todos').insert({ title: 'ok' }) // ठीक है: अन्य कॉलम में डिफ़ॉल्ट हैं
Insert में, डिफ़ॉल्ट या अशक्त कॉलम वाला कॉलम वैकल्पिक है। Update में, प्रत्येक कॉलम वैकल्पिक है।
आपके घटकों के लिए पंक्ति प्रकार#
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'
type Todo = Tables<'todos'> // एक पंक्ति, जैसा पढ़ा गया
type NewTodo = TablesInsert<'todos'> // क्या Insert() स्वीकार करता है
type TodoPatch = TablesUpdate<'todos'> // क्या अद्यतन() स्वीकार करता है
Enums<'name'> डेटाबेस एनम का मान देता है।
क्या चेक किया गया है#
- एक तालिका जो जेनरेट की गई फ़ाइल में नहीं है वह है, अस्वीकृत नहीं है:
aura.from('anything')अभी भी संकलित है, और इसकी पंक्तियाँ अलिखित हैं। - फ़ंक्शन टाइप किए गए तर्कों और रिटर्न मानों के साथ
Functionsके अंतर्गत दिखाई देते हैं:add(a int, b int) returns intArgs: { a: number; b: number }औरReturns: numberदेता है, औरRETURNS TABLE (content text, dist float8)फ़ंक्शनReturns: { content: string; dist: number }[]देता है। एक फ़ंक्शन जो अज्ञात समग्र प्रकार लौटाता है वह अभी भीRecord<string, unknown>के रूप में दिखता है। - फ़िल्टर,
insert()औरupdate()पेलोड, एनम और रिलेशनशिप एंबेड की जाँच की जाती है।select('a, b')स्ट्रिंग के अंदर कॉलम सूची का उपयोग परिणाम टाइप करने के लिए किया जाता है, लेकिन वहां एक गलत वर्तनी वाला नाम केवल रन टाइम (COLUMN_NOT_FOUND, "शायद आपका मतलब था ..." संकेत के साथ पकड़ा जाता है)। - स्टूडियो का प्रकार बटन और
npx @aurabase/genएक ही फ़ाइल बनाते हैं। - फ़ाइल आपके द्वारा जेनरेट किए गए समय की स्कीमा को दर्शाती है। बाद में जोड़ा गया कॉलम तब तक अज्ञात होता है जब तक आप टूल को दोबारा नहीं चलाते।
- स्कीमा आत्मनिरीक्षण के लिए
AURABASE_SERVICE_ROLE_KEYकी आवश्यकता होती है (इसे स्थानीय रूप से या CI में चलाएं; कभी भीservice_roleकुंजी न लगाएं या क्लाइंट कोड में इसे उजागर न करें)।