Anlaşmalar
Şemaların, sütunların, RLS politikalarının, kimlik doğrulama yardımcılarının, dizinlerin adlandırılması. Ekibinizin işleri tek bir şekilde adlandırabilmesi için istikrarlı, belgelenmiş kurallar.
Alan başına bir önek#
Her proje project_{uuid} ön ekine sahip dört alt şema alır. İş tablolarınız ana şemaya girer; asla sistem şemalarında nesneler oluşturmayın.
| Şema | Sahip | Kullanım |
|---|---|---|
project_{uuid} | sen | Tablolar, görünümler ve iş fonksiyonları. Bu, niteliksiz SQL'inizin (create table posts …) yer aldığı şemadır; yalnızca taşınabilir olan aura db backup download ve schema/dump ile dışa aktardığınız SQL'de public olarak adlandırılır. |
project_{uuid}_auth | aura-auth | Kullanıcılar, oturumlar ve MFA. Değişiklik yapmayın. |
project_{uuid}_storage | aura-storage | Kovalar, nesneler ve depolama politikaları |
project_{uuid}_platform | platformu | İşlevler, işler, cron ve sırlar |
Snake_case, çoğul, kimlik uuid#
- Çoğul tablolar:
posts,comments,invoices snake_caseiçindeki Sütunları:created_at,user_id,last_seen_at- Birincil anahtarlar
id uuid primary key default gen_random_uuid()— hayıruuid_generate_v4(). Kimlikler istemcilere açıkkenuuidyerinebigint generated always as identity'yi tercih edin (tahmin edilemez, JavaScript'te 2^53 kesinlik sorunu yok); bir kimlik sütunu da çalışır ve yedeklemeler ve geri yüklemeler bunu halleder. - Zaman damgaları
timestamptz, aslatimestampçıplak - FK'ler son eki
_id:author_id,tenant_id - Boolean'lar ön eki
is_veyahas_ - Sütun yok
project_id— şema zaten yalıtkandır
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()
);
Hiçbir zaman project_id sütunu eklemeyin. Yalıtım zaten şemadan gelir ve böyle bir sütun, güvenlik eklemeden dizinler ekleyecektir.
Her oturuma üç işlev enjekte edildi#
Ağ geçidi, request.jwt.claims belirtilen Postgres bağlantılarını açar. Aşağıdaki üç yardımcı bu talepleri okur ve poliçelerinizin herhangi bir yerinde kullanılabilir.
auth.uid()— Geçerli kullanıcının kullanıcı kimliği, anonim ise NULLauth.role()— metin · anon / kimliği doğrulanmış / service_roleauth.tenant()— Geçerli kiracının kullanıcı kimliği (çok kiracılı RBAC)auth.has_role(name)— boolean · true Kullanıcı bu uygulama rolüne sahipseauth.email()— metin · kullanıcı e-postası, JWT'den okunduauth.claim(key)— jsonb · özel bir talebe ham erişim
Tahmin edilebilir bir isim, bir operasyon, bir rol#
Kural: <table>_<scope>_<operation>. Örnek: posts_own_read, orders_admin_delete. Her zaman to aura_authenticated veya to aura_anon belirtin.
-- ✓ İyi: table_scope_op
create policy "posts_own_read" on posts for select …
create policy "orders_admin_all" on orders for all …
-- ✗ Kaçınmak için
create policy "allow_stuff" -- çok belirsiz
create policy "new_policy_42" -- açıklayıcı değil
Adlandırma ve ne zaman dizine ekleneceği#
- Ad:
idx_<table>_<colonnes>veyauq_<table>_<colonnes>(benzersiz) - Her zaman dizini: FK'ler, sık
filter/order_bysütunları, RLS ilkelerininwhere - Dizine ekleme: Yüksek kardinaliteye sahip düşük Boole sütunları (kısmi dizin kullanın), tablolar < 1000 satır
- pgvector: > 100k vektörler için
using hnsw, aksi takdirdeivfflat