# @bettercms-ai/db 中文文档

规范地址：https://npmcn.com/package/%40bettercms-ai/db/

版本：0\.19\.0
npm 元数据更新时间：2026-11-05T14:14:34.819Z
中文译文更新时间：2026-11-08T00:18:23.220Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bettercms-ai/db
原文对照：https://npmcn.com/package/%40bettercms-ai/db/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：5.5 MB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：postgres ^3\.4\.9，drizzle-orm ^0\.45\.2
- 首次发布：2026-09-13T20:24:21.867Z
- 最新版本发布：2026-11-05T14:14:34.524Z
- 近 30 天下载量：4797（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

Drizzle 计划和工作空间范围查询帮助器,用于 BetterCMS

## 安装

```sh
npm install @bettercms-ai/db
```

也可以使用：`pnpm add @bettercms-ai/db`、`yarn add @bettercms-ai/db`、`bun add @bettercms-ai/db`

## README

# `@bettercms-ai/db`

> Drizzle ORM 用于 BetterCMS 的软件包—— 自动托管的 Postgres 软件包 `postgres` 驾驶员.

## 概览

此软件包包含BetterCMS后端的所有数据库表定义. 用这个 **滴入外科手术** 与 **`postgres`** 用于自备的 Postgres 连接的驱动程序.

## 司马

14个与 PRD §9 数据模型相匹配的表格 :

| 图表 | 说明 |
| --- | --- |
| `workspaces` | 顶层租户集装箱 |
| `users` | 更好的用户管理账户 |
| `workspace_members` | 用户工作空间与角色相接点 |
| `content_models` | 对结构化内容的定义 |
| `content_entries` | 内容模型实例 |
| `pages` | 带有 JSONB 块树的 CMS 页面 |
| `media_assets` | Cloudflare R2存储媒体元数据 |
| `forms` | 支持 Webhook 格式定义 |
| `form_submissions` | 来访者提交的表格 |
| `redirects` | URL重定向规则(301/302/307/308) |
| `api_keys` | 工作空间范围交付 API 密钥 |
| `plan_limits` | 计划一级资源配额 |
| `audit_logs` | 可变事件日志(第6阶段) |

## 关键设计决定

-   **文本标识** ——所有主要密钥的使用 `text` 与 BetterAuth 保持一致的 (noid)
-   **工作空间隔离** - 每张租户范围表都有一张 `workspace_id text()` 风扇
-   **软删除** - 表格与 `deleted_at timestamp()` 可收回的删除
-   **贾森布** 用于 `block_json`, (中文(简体) ), `fields`, (中文(简体) ), `data`,以及 `event_data` 栏
-   **索引** 优化工作空间范围、弹道检查和状态过滤器
-   **`block_embedding`** —— 说 `text` 栏 `pages` 用于第二阶段 pgvector AI 搜索

## 使用量

```ts
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: [],
});
```

## 脚本

```bash
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)
```

## 环境

要求数 `DATABASE_URL` 在您的环境中:

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

## 常见问题

### @bettercms-ai/db 是什么？

Drizzle 计划和工作空间范围查询帮助器,用于 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 和提交记录判断。