# @haatlabs-core/db-core 中文文档

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

版本：0\.18\.5
npm 元数据更新时间：2026-11-13T18:15:26.496Z
中文译文更新时间：2026-11-17T06:45:56.881Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40haatlabs-core/db-core
原文对照：https://npmcn.com/package/%40haatlabs-core/db-core/?lang=original
项目主页：https://haatlabs.shop/docs/packages/db-core/
源码仓库：https://github.com/Haatlabs/haatlabs-platform

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

- 包体积（解压后）：289 kB，84 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：3 个
- peer 依赖：pg ^8\.23\.1，drizzle-orm ^0\.45\.3，@testcontainers/postgresql ^12\.2\.0
- 首次发布：2026-10-22T23:22:58.539Z
- 最新版本发布：2026-11-13T18:15:26.251Z
- 近 30 天下载量：5516（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 27 个）

## 中文简介

PostgreSQL和细雨构件:共享栏目,组织,行级安全,审计日志.

## 安装

```sh
npm install @haatlabs-core/db-core
```

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

## README

# @ haatlabs- core/ db- core

每个应用程序的数据库代码共享, 在PostgreSQL 有细雨。 db-core 没有桌子 并且没有迁移:每个应用程序宣布自己的表格并撰写其迁移。 它拥有的是 共享的柱子, 和对它们起作用的代码.

-   `createDatabase(url, { max })`:一个游泳池,其 `close()` 等待每一个连接. `Database` 输入时没有计划( 完全不用细雨的关系查询) , 所以 每个应用程序都有一个类型.
    
-   `withTenant(db, ctx, fn)`: 与 `app.organization_id` (单位:千美元)`TENANT_SETTING`(中文(简体) ) 锁定行级安全。 每个应用程序的政策都读取了这个设定.
    
-   `runMigrations(systemUrl, { migrationsFolder })`, (中文(简体) ), `runMigrationsCli(...)`。 。 。 .
    
-   `@haatlabs-core/db-core/testing`数字 : `startTestDatabase({ name, migrationsFolder, afterMigrate })`, (中文(简体) ), a 在容器中迁移的 PostgreSQL(需要) `@testcontainers/postgresql`) (中文(简体) ).
    
-   **列组** 用于共享表格及其索引,一个应用程序从中构建:
    
    ```
    export const organizations = pgTable('organizations', {
      ...organizationColumns(),
      storeLimit: integer('store_limit'), // the app's own: nullable or with a default
    });
    export const memberships = pgTable('memberships', membershipColumns({ users, organizations }),
      (t) => membershipIndexes(t));
    export { organizationOriginEnum, roleEnum } from '@haatlabs-core/db-core'; // for drizzle-kit
    ```
    
-   **仓库** 使用应用程序的表格: `IdentityRepository`, (中文(简体) ), `ApiKeyRepository`, (中文(简体) ), `WebhookEventRepository`, (中文(简体) ), `OutboxRepository` (单位:千美元)`priority`: 应用程序的列, 或 `false`, (中文(简体) ), `PlatformAdminRepository`。缺少共享列的表格不汇编 库已建立.
    
-   `createOutboxWriter`, (中文(简体) ), `createAuditWriter`, (中文(简体) ), `isUniqueViolation`。 。 。 .
    

`drizzle-orm` 财务报告和审定财务报表 `pg` 是同伴: 使用该应用程序自己的副本.

**计费栏** (自0.5.0起): `planColumns`, (中文(简体) ), `planFeatureColumns`, (中文(简体) ), `planPriceColumns`, (中文(简体) ), `subscriptionColumns`, (中文(简体) ), `paymentEventColumns`, (中文(简体) ), `usageRecordColumns`, (中文(简体) ), `organizationFeatureColumns`各有其索引; `organizations.store_limit`; 和 收发箱 `outboxPriorityColumn()`,其默认值 `organization_goes_first()` 一个应用程序 从 `ORGANIZATION_GOES_FIRST_SQL` 在发件箱前.

`insertOutbox.many(tx, messages)` 写许多出柜行,每500个内插一个 交易。 发件箱行没有 `delayMs` 没有 `deduplication` (@haatlabs-core/quue),所以一个 发布这些需要是在承诺之后直接制作的,如果进程死亡则丢失 二者之间. 一个需要信息才能活下来的打电话者 把它写到收发箱,没有 他们和众仆,是同舟共济的.

## 安装

```
pnpm add @haatlabs-core/db-core
```

这些软件包留给你的应用程序,所以应用程序持有一份: `drizzle-orm`, (中文(简体) ), `pg`, (中文(简体) ), `@testcontainers/postgresql`。 。 。 .

## 常见问题

### @haatlabs-core/db-core 是什么？

PostgreSQL和细雨构件:共享栏目,组织,行级安全,审计日志\.

### 如何安装 @haatlabs-core/db-core？

在项目目录运行 npm install @haatlabs-core/db-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：pg（^8\.23\.1）、drizzle-orm（^0\.45\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haatlabs-core/db-core 支持 TypeScript 吗？

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

### @haatlabs-core/db-core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @haatlabs-core/db-core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @haatlabs-core/db-core 可以商用吗？

@haatlabs-core/db-core 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @haatlabs-core/db-core 的下载量有多少？

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

### @haatlabs-core/db-core 还在维护吗？

最新版本 0\.18\.5 发布于 2026/11/14（3 天前）；至今共发布 27 个版本，其中过去 12 个月发布了 27 个；首次发布于 2026/10/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

