@haatlabs-core/db-core

中文文档
0.18.5发布于 2026/11/14Apache-2.0TypeScriptESM + CJS近 30 天下载 5516

PostgreSQL and drizzle building blocks: shared columns, organizations, row-level security, audit logs.

原始使用文档

@haatlabs-core/db-core

What every app's database code shares, on PostgreSQL with drizzle. db-core owns no table and no migration: each app declares its tables and writes its migrations. What it owns is the shared columns, and the code that works on them.

  • createDatabase(url, { max }): a pool whose close() waits for every connection. Database is typed without a schema (nothing uses drizzle's relational queries), so one type serves every app.

  • withTenant(db, ctx, fn): a transaction with app.organization_id (TENANT_SETTING) bound for row-level security. Each app's policies read that setting.

  • runMigrations(systemUrl, { migrationsFolder }), runMigrationsCli(...).

  • @haatlabs-core/db-core/testing: startTestDatabase({ name, migrationsFolder, afterMigrate }), a migrated PostgreSQL in a container (needs @testcontainers/postgresql).

  • Column sets for the shared tables, and their indexes, from which an app builds its own:

    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
    
  • Repositories that take the app's tables: IdentityRepository, ApiKeyRepository, WebhookEventRepository, OutboxRepository (priority: the app's column, or false), PlatformAdminRepository. A table missing a shared column does not compile where the repository is built.

  • createOutboxWriter, createAuditWriter, isUniqueViolation.

drizzle-orm and pg are peers: the app's own copies are used.

Billing columns (since 0.5.0): planColumns, planFeatureColumns, planPriceColumns, subscriptionColumns, paymentEventColumns, usageRecordColumns, organizationFeatureColumns, each with its indexes; organizations.store_limit; and the outbox's outboxPriorityColumn(), whose default organization_goes_first() an app's migration creates from ORGANIZATION_GOES_FIRST_SQL before the outbox table.

insertOutbox.many(tx, messages) writes many outbox rows, one INSERT per 500, in the caller's transaction. An outbox row carries no delayMs and no deduplication (@haatlabs-core/queue), so a publish that needs them is made directly, after the commit, and is lost if the process dies between the two. A caller that needs the message to survive writes it to the outbox, without them, and coalesces in the handler instead.

Install

pnpm add @haatlabs-core/db-core

It leaves these packages to your app, so the app holds one copy: drizzle-orm, pg, @testcontainers/postgresql.

版本与发布记录

@haatlabs-core/db-core 共发布 27 个版本,首次发布于 2026/10/23;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.18.5latest2026/11/143 天前
0.18.42026/11/133 天前
0.18.32026/11/134 天前
0.18.22026/11/134 天前
0.18.12026/11/134 天前
0.18.02026/11/134 天前

关于 @haatlabs-core/db-core 的常见问题

@haatlabs-core/db-core 是什么?

PostgreSQL and drizzle building blocks: shared columns, organizations, row-level security, audit logs.

如何安装 @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 和提交记录判断。