Umowy
Nazewnictwo schematów, kolumn, zasad RLS, pomocników uwierzytelniania, indeksów. Stabilne, udokumentowane konwencje, dzięki którym Twój zespół może nazywać rzeczy w jeden sposób.
Jeden prefiks na domenę#
Każdy projekt otrzymuje cztery podschematy z przedrostkiem project_{uuid}. Twoje tabele biznesowe trafiają do głównego schematu; nigdy nie twórz obiektów w schematach systemowych.
| Schemat | Właściciel | Używać |
|---|---|---|
project_{uuid} | Ty | Tabele, widoki i funkcje biznesowe. To jest schemat, w którym ląduje Twój niekwalifikowany SQL (create table posts …); nosi nazwę public tylko w przypadku eksportowanego kodu SQL za pomocą aura db backup download i schema/dump, które są przenośne. |
project_{uuid}_auth | aura-auth | Użytkownicy, sesje i MFA. Nie modyfikuj. |
project_{uuid}_storage | aura-storage | Wiadra, obiekty i zasady przechowywania |
project_{uuid}_platform | platforma | Funkcje, zadania, cron i sekrety |
wąż_case, liczba mnoga, id uuid#
- Liczba mnoga tabele:
posts,comments,invoices - Kolumny w
snake_case:created_at,user_id,last_seen_at - Klucze podstawowe
id uuid primary key default gen_random_uuid()— nieuuid_generate_v4(). Preferujuuidzamiastbigint generated always as identity, gdy identyfikatory są udostępniane klientom (nie do odgadnięcia, brak problemu z precyzją 2^53 w JavaScript); kolumna tożsamości również działa, a kopie zapasowe i przywracanie obsługują to. - Znaczniki czasu
timestamptz, nigdytimestampnago - FKs z przyrostkiem
_id:author_id,tenant_id - Wartość logiczna z przedrostkiem
is_lubhas_ - Brak kolumny
project_id— na schemacie jest już izolator
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()
);
Nigdy nie dodawaj kolumny project_id. Izolacja pochodzi już ze schematu i taka kolumna dodałaby indeksy bez dodawania zabezpieczeń.
Do każdej sesji dodano trzy funkcje#
Brama otwiera połączenia Postgres z określonym request.jwt.claims. Trzej pomocnicy poniżej czytają te twierdzenia i można ich używać w dowolnym miejscu polis.
auth.uid()— identyfikator UUID bieżącego użytkownika, NULL, jeśli anonauth.role()— tekst · anon / uwierzytelniony / rola_usługiauth.tenant()— identyfikator UUID bieżącego dzierżawcy (RBAC dla wielu dzierżawców)auth.has_role(name)— wartość logiczna · true, jeśli użytkownik ma tę rolę w aplikacjiauth.email()— tekst · e-mail użytkownika, odczyt z JWTauth.claim(key)— jsonb · surowy dostęp do niestandardowego roszczenia
Przewidywalna nazwa, operacja, rola#
Konwencja: <table>_<scope>_<operation>. Przykład: posts_own_read, orders_admin_delete. Zawsze określaj to aura_authenticated lub to aura_anon.
-- ✓ Dobrze: table_scope_op
create policy "posts_own_read" on posts for select …
create policy "orders_admin_all" on orders for all …
-- ✗ Aby uniknąć
create policy "allow_stuff" -- zbyt niejasne
create policy "new_policy_42" -- nie opisowe
Nazewnictwo i kiedy indeksować#
- Nazwa:
idx_<table>_<colonnes>lubuq_<table>_<colonnes>(unikalny) - Zawsze indeks: FK, częste kolumny
filter/order_by,wherez RLS polityk - Nie indeksuj: Kolumny logiczne o niskiej liczności (użyj indeksu częściowego), tabele < 1000 wierszy
- pgvector:
using hnswdla > 100 tys. wektorów,ivfflatw przeciwnym razie