الاتفاقيات
تسمية المخططات والأعمدة وسياسات RLS ومساعدي المصادقة والفهارس. اصطلاحات مستقرة وموثقة بحيث يكون لدى فريقك طريقة واحدة لتسمية الأشياء.
تمت ترجمة هذه الصفحة تلقائيًا. النسخة الإنجليزية موثوقة.
بادئة واحدة لكل مجال#
يتلقى كل مشروع أربعة مخططات فرعية مسبوقة بـ project_{uuid}. تدخل جداول الأعمال الخاصة بك في المخطط الرئيسي؛ لا تقم أبدًا بإنشاء كائنات في مخططات النظام.
| المخطط | المالك | استخدم |
|---|---|---|
project_{uuid} | أنت | الجداول وطرق العرض ووظائف الأعمال. هذا هو المخطط الذي وصلت إليه SQL غير المؤهلة (create table posts …) ؛ يتم تسميته public فقط في SQL التي تقوم بتصديرها باستخدام aura db backup download و schema/dump، وهي محمولة. |
project_{uuid}_auth | aura-auth | المستخدمون والجلسات وMFA. لا تقم بتعديل. |
project_{uuid}_storage | aura-storage | الدلاء والأشياء وسياسات التخزين |
project_{uuid}_platform | منصة | الوظائف والوظائف والكرون والأسرار |
Snake_case، الجمع، معرف uuid#
- الجمع الجداول:
posts,comments,invoices - الأعمدة في
snake_case:created_at,user_id,last_seen_at - المفاتيح الأساسية
id uuid primary key default gen_random_uuid()— لاuuid_generate_v4(). تفضيلuuidعلىbigint generated always as identityعندما تكون المعرفات مكشوفة للعملاء (لا يمكن تخمينها، لا توجد مشكلة دقة 2^53 في JavaScript)؛ يعمل عمود الهوية أيضًا، وتتعامل معه عمليات النسخ الاحتياطي والاستعادة. - الطوابع الزمنية
timestamptz، لاtimestampعارٍ أبدًا - FKs لاحقة
_id:author_id,tenant_id - القيم المنطقية مسبوقة بـ
is_أوhas_ - لا يوجد عمود
project_id— المخطط هو العازل بالفعل
sql
create table posts (
id uuid primary key default gen_random_uuid(),
author_id uuid not null references users(id) on delete cascade,
title text not null,
is_published boolean not null default false,
created_at timestamptz not null default now()
);
انتبه
لا تقم مطلقًا بإضافة عمود project_id. يأتي العزل بالفعل من المخطط، وسيضيف مثل هذا العمود فهارس دون إضافة أمان.
يتم إدخال ثلاث وظائف في كل جلسة#
تفتح البوابة اتصالات Postgres مع تحديد request.jwt.claims. يقرأ المساعدون الثلاثة أدناه هذه المطالبات ويمكن استخدامها في أي مكان في سياساتك.
auth.uid()— uuid للمستخدم الحالي، NULL إذا كان مجهولاًauth.role()— نص · حالًا / مصادق عليه / دور_الخدمةauth.tenant()— uuid للمستأجر الحالي (RBAC متعدد المستأجرين)auth.has_role(name)— منطقي · صحيح إذا كان لدى المستخدم دور التطبيق هذاauth.email()— نص · البريد الإلكتروني للمستخدم، اقرأ من JWTauth.claim(key)— jsonb · الوصول الأولي إلى المطالبة المخصصة
اسم يمكن التنبؤ به، عملية، دور#
الاتفاقية: <table>_<scope>_<operation>. مثال: posts_own_read, orders_admin_delete. حدد دائمًا to aura_authenticated أو to aura_anon.
sql
-- ✓ جيد: table_scope_op
create policy "posts_own_read" on posts for select …
create policy "orders_admin_all" on orders for all …
-- ✗ لتجنب
create policy "allow_stuff" -- غامضة جدا
create policy "new_policy_42" -- ليست وصفية
التسمية ومتى يتم الفهرسة#
- الاسم:
idx_<table>_<colonnes>أوuq_<table>_<colonnes>(فريد) - فهرسة دائمًا: FKs، أعمدة
filterالمتكررة /order_by،whereلسياسات RLS - لا تقم بالفهرسة: الأعمدة المنطقية ذات العلاقة الأساسية العالية المنخفضة (استخدم الفهرس الجزئي)، والجداول <1000 صف
- pgvector:
using hnswلأكثر من 100 ألف متجه،ivfflatخلاف ذلك