Neon Postgres
資料庫是選擇性的(AGENTS.md §0.5):僅在應用程式需要儲存比瀏覽器會話更久或可跨裝置共享的資料時使用。否則,不要匯入 @/lib/db,也不要提供遷移檔案,並將狀態保留在 localStorage / zustand 中。
此模板提供了一個現成的雙模式資料庫整合:
- 已設定(已設定環境變數,例如已部署):使用真正的 Neon Postgres。
- 未設定(沙盒即時預覽):資料庫會回退到本機的 PGLite(嵌入式 WASM Postgres),因此預覽始終能正常渲染。請使用
@/lib/db輔助程式進行開發;兩種模式使用相同的 API。
套件已預先安裝 — 請勿再次執行 npm install:pg(node-postgres,標準 Postgres 驅動程式)和 @electric-sql/pglite(本機資料庫回退方案)。
有關使用者帳戶、登入和讀取目前使用者,請參閱單獨的 auth 技能 — 此技能僅涵蓋資料庫部分。
開啟資料庫
在 .grok/app-env.json 中將 deploy.database 設定為 true:
{ "VITE_AUTH_ENABLED": "false", "deploy": { "database": true } }
這會告訴平台為已部署的應用程式佈建 Neon;將其保留為 false,則部署時不會獲得 DATABASE_URL,因此應用程式會在一個用完即棄的 PGLite 上默默運行,其資料行將會遺失。提供 migrations/*.sql 或登入功能時,無論此標誌為何,都會自動佈建 Neon。此標誌適用於在沒有這兩者的情況下查詢 @/lib/db 的應用程式。它不是 VITE_ 金鑰,也永遠不會到達瀏覽器。
環境變數 — 請勿建立 .env 檔案
永遠不要為資料庫編寫 .env / .env.local / .env.example。 在沙盒即時預覽中,請讓 DATABASE_URL 保持未設定 — @/lib/db 會自動使用嵌入式的 PGLite。當應用程式部署後,平台會注入 DATABASE_URL(Neon);您無需自行佈建或編寫它。
| 變數 | 位置 | 用途 |
|---|---|---|
DATABASE_URL | 伺服器 | 部署時的 Neon 連線字串(可選 — 若未設定則使用 PGLite 回退方案) |
切勿對其進行硬編碼;切勿將非 VITE_ 的變數暴露給客戶端。
資料庫(僅限伺服器端)
@/lib/db 匯出了 getSql() 和 dbSource:當 DATABASE_URL 已設定時,使用標準 Postgres 驅動程式(node-postgres,pg);未設定時,則使用本機的 PGLite 回退方案。兩種情況使用相同的 API:一個標記模板(和 .query() 方法),解析為 rows[]。僅能從 createServerFn 處理程式 / 伺服器載入函式中呼叫,絕不能從客戶端元件中呼叫。請在 migrations/ 中定義結構,不要內聯。
import { createServerFn } from "@tanstack/react-start";
import { getSql } from "@/lib/db";
export const listPosts = createServerFn({ method: "GET" }).handler(async () => {
const sql = await getSql();
// 為資料行形狀定義型別 — 伺服器函數的回傳值必須是可證明可序列化的。
return sql<{ id: number; title: string }>`select id, title from posts order by id desc`;
// 或:return sql.query<{ id: number; title: string }>("select id, title from posts where id = $1", [id]);
});
每個使用者的資料(僅在應用程式有登入功能後)。 標準驅動程式具有完整的資料庫存取權限,因此請在伺服器端將每個查詢都限定於已驗證的使用者 — 切勿信任客戶端發送的 ID。使用預先配置好的 authMiddleware 來取得已驗證的 context.userId,然後根據該 ID 進行過濾。完整模式(中介軟體、從客戶端程式碼呼叫、失敗關閉語義)請參閱 auth 技能:
import { authMiddleware } from "@/lib/auth/middleware";
export const listTodos = createServerFn({ method: "GET" })
.middleware([authMiddleware])
.handler(async ({ context }) => {
const sql = await getSql();
return sql<{ id: number; title: string }>`select id, title from todos where user_id = ${context.userId} order by id desc`;
});
// 修改操作也必須限定寫入範圍:`... where id = ${id} and user_id = ${context.userId}`
在沒有登入功能的情況下(預設),請勿使用 authMiddleware / requireUserId。 它們回退到的開發人員使用者僅是預覽用的便利設施。已部署應用程式的 VITE_AUTH_ENABLED 由平台設定,而非此工作區(目前部署器始終將其設為 "true"),因此部署後,兩者都會拒絕所有訪客 — 並且關閉驗證的應用程式沒有提供登入路由供他們恢復。僅使用資料庫的應用程式應將其資料行保留為無所屬狀態:不要有 user_id 欄位,或使用一個固定常數。在啟用登入功能時(auth 技能的升級步驟),再加入中介軟體,屆時再重新設定這些資料行的範圍或將其刪除。
無所屬的資料行可透過您的公開伺服器函數被全世界讀取和寫入:在此模式下,切勿持久化個人或敏感資料(姓名、電子郵件、關於個人的自由文字),並避免使用破壞性的批量修改(全部刪除、全部覆寫)— 如果應用程式需要這些功能,請提議改用登入功能。
遷移
migrations/*.sql 是唯一的結構來源。它們會套用到部署時的 Neon(npm run build 會針對 DATABASE_URL 執行 db:migrate,因此 Vercel 在部署時已準備好結構)和啟動時自動套用到 PGLite 預覽,因此開發環境與正式環境一致。
兩種套用器都不會進入子目錄,因此位於 migrations/auth/0001_auth.sql 的 Better Auth 結構不會被套用,除非應用程式開啟登入功能並將其複製到上層目錄(請勿編輯 — 請參閱 auth 技能)。請將您應用程式的結構放在從 0002 開始編號的新檔案中:
-- migrations/0002_schema.sql — 以待辦事項應用程式為例;請使用您應用程式的資料表
create table if not exists todos (
id serial primary key,
user_id text not null,
title text not null,
done boolean not null default false,
created_at timestamptz not null default now()
);
create index if not exists todos_user_id_idx on todos (user_id);
切勿編輯已套用的檔案 — 它會按名稱記錄在 _migrations 中,並且不會重新執行(請改為新增一個新檔案;新檔案會在下次請求時套用到正在執行的預覽)。建議使用冪等陳述式(… if not exists)。包含每個使用者資料的資料表應有一個 user_id text not null 欄位(TEXT 型別,非 UUID — 預覽的開發人員使用者 ID 是字串 'dev-user')。
預覽 ↔ 正式環境的差異
getSql() 會正規化結果型別,使兩個後端都回傳相同、JSON 安全的形狀:bigint/count(*) → number,date → 'YYYY-MM-DD' 字串,interval → 文字,numeric → 字串。需要注意的其餘差異:
- 超過 2^53 的
bigint會損失精確度,因為轉換為數字 — 如果您需要處理超大整數,請將其轉換為::text(資料行計數沒問題)。 - 預覽資料庫是記憶體資料庫:開發伺服器重新啟動時資料會清除、單一連線(無鎖競爭或並發寫入衝突),且不載入任何擴充套件 — 請勿執行
create extension;堅持使用核心 Postgres 功能。 - Neon 的連線池端點不保留任何工作階段狀態 — 請勿依賴
SET、LISTEN/NOTIFY或工作階段建議鎖。 - 將
user_id欄位保持為text型別 — 預覽使用'dev-user',正式環境使用 Better Auth 的文字 ID;uuid欄位會破壞預覽的插入。 - 已部署的 Neon 查詢會經過網路傳輸(並可能經歷冷啟動)— 請避免在程序內預覽資料庫中看起來很輕量的 N+1 查詢模式。