@bettercms-ai/db

中文文档
0.19.0发布于 2026/11/05TypeScriptES Module近 30 天下载 4797

Drizzle schema and workspace-scoped query helpers for BetterCMS

原始使用文档
文档目录6 节
  1. Overview
  2. Schema
  3. Key Design Decisions
  4. Usage
  5. Scripts
  6. Environment

@bettercms-ai/db

Drizzle ORM schema package for BetterCMS — self-hosted Postgres with postgres driver.

Overview

This package contains all database table definitions for the BetterCMS backend. It uses Drizzle ORM with the postgres driver for self-hosted Postgres connections.

Schema

14 tables matching the PRD §9 Data Model:

TableDescription
workspacesTop-level tenant container
usersBetterAuth-managed user accounts
workspace_membersUser↔workspace junction with roles
content_modelsSchema definitions for structured content
content_entriesInstances of content models
pagesCMS pages with JSONB block trees
media_assetsCloudflare R2-stored media metadata
formsForm definitions with webhook support
form_submissionsVisitor form submissions
redirectsURL redirect rules (301/302/307/308)
api_keysWorkspace-scoped delivery API keys
plan_limitsPlan tier resource quotas
audit_logsImmutable event log (Phase 6)

Key Design Decisions

  • Text IDs — all primary keys use text (nanoid) for consistency with BetterAuth
  • Workspace isolation — every tenant-scoped table has a workspace_id text() FK
  • Soft deletes — tables with deleted_at timestamp() for recoverable deletions
  • JSONB — used for block_json, fields, data, and event_data columns
  • Indexes — optimized for workspace-scoping, slug lookups, and status filters
  • block_embedding — text column on pages for Phase 2 pgvector AI search

Usage

import { db, schema } from "@bettercms-ai/db";

// Query pages for a workspace
const pages = await db
  .select()
  .from(schema.pages)
  .where(eq(schema.pages.workspaceId, workspaceId));

// Insert a new page
await db.insert(schema.pages).values({
  id: nanoid(),
  workspaceId,
  title: "Hello World",
  slug: "hello-world",
  status: "draft",
  blockJson: [],
});

Scripts

bun run db:generate   # Generate migrations (drizzle-kit generate)
bun run db:push       # Push schema to Neon (drizzle-kit push)
bun run db:migrate    # Run migrations (drizzle-kit migrate)
bun run db:studio     # Open Drizzle Studio (drizzle-kit studio)

Environment

Requires DATABASE_URL in your environment:

DATABASE_URL=postgresql://user:password@localhost:5432/bettercms

版本与发布记录

@bettercms-ai/db 共发布 46 个版本,首次发布于 2026/09/14;过去 12 个月发布了 46 个版本。

版本发布日期距今
0.19.0latest2026/11/052 天前
0.18.62026/11/035 天前
0.18.52026/11/017 天前
0.18.42026/10/318 天前
0.18.32026/10/2712 天前
0.18.22026/10/2712 天前

关于 @bettercms-ai/db 的常见问题

@bettercms-ai/db 是什么?

Drizzle schema and workspace-scoped query helpers for BetterCMS

如何安装 @bettercms-ai/db?

在项目目录运行 npm install @bettercms-ai/db,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:postgres(^3.4.9)、drizzle-orm(^0.45.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@bettercms-ai/db 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@bettercms-ai/db 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@bettercms-ai/db 可以商用吗?

@bettercms-ai/db 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@bettercms-ai/db 的下载量有多少?

根据 npm 官方下载统计,@bettercms-ai/db 在 2026/10/08 – 2026/11/06 这 30 天内被下载 4,797 次,日均约 160 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bettercms-ai/db 还在维护吗?

最新版本 0.19.0 发布于 2026/11/05(2 天前);至今共发布 46 个版本,其中过去 12 个月发布了 46 个;首次发布于 2026/09/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。