EmDash 支援多種資料庫後端。根據您的部署目標進行選擇。
概述
| 資料庫 | 最適合 | 部署 |
|---|---|---|
| D1 | Cloudflare Workers | Edge,全球分散 |
| PostgreSQL | 生產環境 Node.js | 任何支援 Postgres 的平台 |
| libSQL | 遠端資料庫 | Edge 或 Node.js |
| SQLite | Node.js,本地開發 | 單一伺服器 |
Cloudflare D1
D1 是 Cloudflare 的無伺服器 SQLite 資料庫。在部署到 Cloudflare Workers 時使用它。
import { d1 } from "@emdash-cms/cloudflare";
export default defineConfig({
integrations: [
emdash({
database: d1({ binding: "DB" }),
}),
],
});
配置
| 選項 | 類型 | 預設值 | 描述 |
|---|---|---|---|
binding | string | — | 來自 wrangler.jsonc 的 D1 綁定名稱 |
session | string | "disabled" | 讀取複製模式(見下文) |
bookmarkCookie | string | "__em_d1_bookmark" | 會話書籤的 Cookie 名稱 |
設定
wrangler.jsonc
{
"d1_databases": [
{
"binding": "DB",
"database_name": "emdash-db"
}
]
} wrangler.toml
[[d1_databases]]
binding = "DB"
database_name = "emdash-db" 讀取副本
D1 支援讀取複製來降低全球分散式站點的讀取延遲。啟用後,讀取查詢會路由到附近的副本,而不是總是存取主資料庫。
EmDash 使用 D1 Sessions API 透明地管理這一點。使用 session 選項啟用它:
import { d1 } from "@emdash-cms/cloudflare";
export default defineConfig({
integrations: [
emdash({
database: d1({
binding: "DB",
session: "auto",
}),
}),
],
});
會話模式
| 模式 | 行為 |
|---|---|
"disabled" | 無會話。所有查詢都發送到主資料庫。預設值。 |
"auto" | 匿名請求從最近的副本讀取。已驗證使用者透過書籤 Cookie 獲得讀己之寫一致性。 |
"primary-first" | 類似於 "auto",但第一個查詢總是發送到主資料庫。用於寫入非常頻繁的站點。 |
運作原理
- 匿名訪客獲得
first-unconstrained— 讀取會發送到最近的副本以獲得最低延遲。由於匿名使用者從不寫入,因此不需要一致性保證。 - 已驗證使用者(編輯者、作者)獲得基於書籤的會話。寫入後,書籤 Cookie 確保下一個請求至少看到該狀態。
- 寫入請求(
POST、PUT、DELETE)始終從主資料庫開始。 - 建置時查詢(Astro 內容集合)完全繞過會話並直接使用主資料庫。
libSQL
libSQL 是支援遠端連接的 SQLite 分支。當您需要不使用 Cloudflare D1 的遠端資料庫時使用它。
import { libsql } from "emdash/db";
export default defineConfig({
integrations: [
emdash({
database: libsql({
url: process.env.LIBSQL_DATABASE_URL,
authToken: process.env.LIBSQL_AUTH_TOKEN,
}),
}),
],
});
配置
| 選項 | 類型 | 描述 |
|---|---|---|
url | string | 資料庫 URL(libsql://... 或 file:...) |
authToken | string | 遠端資料庫的驗證權杖(本地可選) |
本地開發
在開發期間使用本地 libSQL 檔案:
database: libsql({ url: "file:./data.db" });
PostgreSQL
PostgreSQL 支援需要完整關聯式資料庫的 Node.js 部署。
import { postgres } from "emdash/db";
export default defineConfig({
integrations: [
emdash({
database: postgres({
connectionString: process.env.DATABASE_URL,
}),
}),
],
});
配置
您可以使用連接字串或單獨的參數進行連接:
// 連接字串
database: postgres({
connectionString: "postgres://user:password@localhost:5432/emdash",
});
// 單獨的參數
database: postgres({
host: "localhost",
port: 5432,
database: "emdash",
user: "emdash",
password: process.env.DB_PASSWORD,
ssl: true,
});
| 選項 | 類型 | 描述 |
|---|---|---|
connectionString | string | PostgreSQL 連接 URL |
host | string | 資料庫主機 |
port | number | 資料庫埠 |
database | string | 資料庫名稱 |
user | string | 資料庫使用者 |
password | string | 資料庫密碼 |
ssl | boolean | 啟用 SSL |
pool.min | number | 最小連接池數(預設 0) |
pool.max | number | 最大連接池數(預設 10) |
連接池
適配器在底層使用 pg.Pool。根據您的部署調整連接池大小:
database: postgres({
connectionString: process.env.DATABASE_URL,
pool: { min: 2, max: 20 },
});
SQLite
使用 better-sqlite3 的 SQLite 是 Node.js 部署的最簡單選項。
import { sqlite } from "emdash/db";
export default defineConfig({
integrations: [
emdash({
database: sqlite({ url: "file:./data.db" }),
}),
],
});
配置
| 選項 | 類型 | 描述 |
|---|---|---|
url | string | 帶有 file: 前綴的檔案路徑 |
檔案路徑
url 必須以 file: 開頭:
// 相對路徑
database: sqlite({ url: "file:./data/emdash.db" });
// 絕對路徑
database: sqlite({ url: "file:/var/data/emdash.db" });
// 來自環境變數
database: sqlite({ url: `file:${process.env.DATABASE_PATH}` });
遷移
EmDash 在第一個請求時自動執行遷移,適用於每個支援的方言(D1、SQLite、libSQL、PostgreSQL)。遷移與 emdash 套件捆綁在一起並嵌入到您的建置中。
如果資料庫為空(沒有集合)並且設定精靈尚未完成,EmDash 還會在首次啟動時套用種子檔案。種子從 .emdash/seed.json、package.json#emdash.seed 中的路徑或 seed/seed.json 讀取 — 以先找到的為準 — 並在編譯時內聯到建置中。如果都不存在,則使用內建的預設種子。針對現有資料庫的後續啟動會保持其內容不變。
基於環境的配置
為每個環境使用不同的資料庫:
import { sqlite, libsql, postgres } from "emdash/db";
import { d1 } from "@emdash-cms/cloudflare";
const database = import.meta.env.PROD ? d1({ binding: "DB" }) : sqlite({ url: "file:./data.db" });
export default defineConfig({
integrations: [emdash({ database })],
});
選擇也可以基於環境變數而不是建置模式:
const database = process.env.DATABASE_URL
? postgres({ connectionString: process.env.DATABASE_URL })
: sqlite({ url: "file:./data.db" });