Overeenkomsten
Naamgeving van schema's, kolommen, RLS-beleid, auth-helpers, indexen. Stabiele, gedocumenteerde conventies, zodat uw team dingen op één manier kan benoemen.
Eén voorvoegsel per domein#
Elk project ontvangt vier subschema's met het voorvoegsel project_{uuid}. Uw bedrijfstabellen worden in het hoofdschema opgenomen; Maak nooit objecten in systeemschema's.
| Schema | Eigenaar | Gebruik |
|---|---|---|
project_{uuid} | jij | Tabellen, weergaven en zakelijke functies. Dit is het schema waarin uw niet-gekwalificeerde SQL (create table posts …) terechtkomt; het heet alleen public op de SQL die u exporteert met aura db backup download en schema/dump, die overdraagbaar zijn. |
project_{uuid}_auth | aura-auth | Gebruikers, sessies en MFA. Niet wijzigen. |
project_{uuid}_storage | aura-storage | Emmers, objecten en opslagbeleid |
project_{uuid}_platform | platform | Functies, banen, cron en geheimen |
snake_case, meervoud, id uuid#
- Meervoud tabellen:
posts,comments,invoices - Kolommen in
snake_case:created_at,user_id,last_seen_at - Primaire sleutels
id uuid primary key default gen_random_uuid()— neeuuid_generate_v4(). Geef de voorkeur aanuuidbovenbigint generated always as identitywanneer ID's worden weergegeven aan clients (niet te raden, geen 2^53 precisieprobleem in JavaScript); een identiteitskolom werkt ook, en back-ups en herstelbewerkingen kunnen dit verwerken. - Tijdstempels
timestamptz, nooittimestampnaakt - FK's met achtervoegsel
_id:author_id,tenant_id - Booleans voorafgegaan door
is_ofhas_ - Geen kolom
project_id— het schema is al de isolator
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()
);
Voeg nooit een kolom project_id toe. Isolatie komt al voort uit het schema, en zo'n kolom zou indexen toevoegen zonder beveiliging toe te voegen.
Drie functies geïnjecteerd in elke sessie#
De gateway opent Postgres-verbindingen waarbij request.jwt.claims is opgegeven. De drie onderstaande helpers lezen deze claims en kunnen overal in uw polis worden gebruikt.
auth.uid()— uuid van de huidige gebruiker, NULL indien anonauth.role()— tekst · anoniem / geverifieerd / service_rolauth.tenant()— uuid van de huidige tenant (RBAC met meerdere tenants)auth.has_role(name)— boolean · waar als de gebruiker deze applicatierol heeftauth.email()— tekst · e-mailadres van gebruiker, voorgelezen uit de JWTauth.claim(key)— jsonb · onbewerkte toegang tot een aangepaste claim
Een voorspelbare naam, een operatie, een rol#
Conventie: <table>_<scope>_<operation>. Voorbeeld: posts_own_read, orders_admin_delete. Geef altijd to aura_authenticated of to aura_anon op.
-- ✓ Goed: table_scope_op
create policy "posts_own_read" on posts for select …
create policy "orders_admin_all" on orders for all …
-- ✗ Om te vermijden
create policy "allow_stuff" -- te vaag
create policy "new_policy_42" -- niet beschrijvend
Naamgeving en wanneer indexeren#
- Naam:
idx_<table>_<colonnes>ofuq_<table>_<colonnes>(uniek) - Indexeer altijd: FK's, frequente
filter/order_bykolommen,wherevan RLS beleid - Niet indexeren: Booleaanse kolommen met hoge kardinaliteit laag (gebruik gedeeltelijke index), tabellen < 1000 rijen
- pgvector:
using hnswvoor > 100k vectoren,ivfflatanders