協定
スキーマ、列、RLS ポリシー、認証ヘルパー、インデックスの命名。安定した文書化された規則により、チームは単一の名前を付けることができます。
このページは自動翻訳されました。英語版が正式です。
ドメインごとに 1 つのプレフィックス#
各プロジェクトは、 project_{uuid}というプレフィックスが付いた 4 つのサブスキーマを受け取ります。ビジネス テーブルはメイン スキーマに入ります。システムスキーマ内にオブジェクトを作成しないでください。
| スキーマ | オーナー | 使用する |
|---|---|---|
project_{uuid} | あなた | テーブル、ビュー、ビジネス関数。これは、修飾されていない SQL (create table posts …) が到達するスキーマです。 public という名前が付けられるのは、移植性のある aura db backup download および schema/dumpを使用してエクスポートした SQL のみです。 |
project_{uuid}_auth | aura-auth | ユーザー、セッション、および MFA。改造しないでください。 |
project_{uuid}_storage | aura-storage | バケット、オブジェクト、およびストレージ ポリシー |
project_{uuid}_platform | プラットフォーム | 関数、ジョブ、cron、シークレット |
Snake_case、複数形、ID uuid#
- 複数の テーブル:
posts、comments、invoices snake_caseの列 :created_at、user_id、last_seen_at- 主キー
id uuid primary key default gen_random_uuid()—uuid_generate_v4()はありません。 ID がクライアントに公開される場合は、bigint generated always as identityよりもuuidを優先します (推測不可能であり、JavaScript では 2^53 の精度の問題はありません)。 ID 列も機能し、バックアップと復元で処理されます。 - タイムスタンプ
timestamptz、裸のtimestampはありません - FK サフィックス
_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 列は決して追加しないでください。分離はすでにスキーマによって行われており、そのような列はセキュリティを追加せずにインデックスを追加します。
各セッションに注入される 3 つの関数#
ゲートウェイは、request.jwt.claims が指定された Postgres 接続を開きます。以下の 3 つのヘルパーはこれらの主張を読み取り、ポリシー内のどこでも使用できます。
auth.uid()— 現在のユーザーの uuid、そうでない場合は NULLauth.role()— テキスト · anon / 認証済み / service_roleauth.tenant()— 現在のテナントの uuid (マルチテナント RBAC)auth.has_role(name)— ブール値 · ユーザーがこのアプリケーション ロールを持っている場合は trueauth.email()— テキスト · ユーザーの電子メール、JWT から読み取られますauth.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>(一意) - 常にインデックス: FK、頻繁に発生する
filter/order_by列、RLS ポリシーのwhere - インデックスを作成しない: カーディナリティが高く、低いブール列 (部分インデックスを使用)、テーブル < 1000 行
- pgvector: 100k を超えるベクトルの場合は
using hnsw、それ以外の場合はivfflat