Przejdź do treści
Logo Aurabase
aurabaza

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.

Referencja6 min przeczytanePoziom początkującyZmieniono 15 kwi 2026

Ta strona została przetłumaczona automatycznie. Wersja angielska jest miarodajna.

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.

SchematWłaścicielUżywać
project_{uuid}TyTabele, 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}_authaura-authUżytkownicy, sesje i MFA. Nie modyfikuj.
project_{uuid}_storageaura-storageWiadra, obiekty i zasady przechowywania
project_{uuid}_platformplatformaFunkcje, 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() — nie uuid_generate_v4(). Preferuj uuid zamiast bigint 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, nigdy timestamp nago
  • FKs z przyrostkiem _id: author_id, tenant_id
  • Wartość logiczna z przedrostkiem is_ lub has_
  • Brak kolumny project_id — na schemacie jest już izolator
exemplesql
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()
);
Uwaga

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 anon
  • auth.role() — tekst · anon / uwierzytelniony / rola_usługi
  • auth.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 aplikacji
  • auth.email() — tekst · e-mail użytkownika, odczyt z JWT
  • auth.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.

namingsql
-- ✓ 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> lub uq_<table>_<colonnes> (unikalny)
  • Zawsze indeks: FK, częste kolumny filter/order_by, where z RLS polityk
  • Nie indeksuj: Kolumny logiczne o niskiej liczności (użyj indeksu częściowego), tabele < 1000 wierszy
  • pgvector: using hnsw dla > 100 tys. wektorów, ivfflat w przeciwnym razie

Aby pójść dalej#