قم بإنشاء أنواع 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)).
قم بتشغيله مرة أخرى عندما يتغير المخطط (أو قم بتمرير --check في CI للفشل في انحراف المخطط). أضف --schema <name> لمخطط آخر غير public، و--type-name لإعادة تسمية النوع الرئيسي، و--numeric-as-string للاحتفاظ بـ numeric/decimal كـ string بدلاً من number.
استخدامه مع العميل#
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'> // ما يقبله الإدراج ().
type TodoPatch = TablesUpdate<'todos'> // ما التحديث () يقبل
Enums<'name'> يعطي قيم تعداد قاعدة البيانات.
ما يتم فحصه#
- الجدول غير الموجود في الملف الذي تم إنشاؤه هو وليس مرفوض:
aura.from('anything')لا يزال يتم تجميعه، ولم يتم كتابة صفوفه. - تظهر الوظائف ضمن
Functionsمع الوسائط المكتوبة والقيم المرجعة:add(a int, b int) returns intيعطيArgs: { 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أو كشفه في كود العميل).