# @iworkflow/dbos 中文文档

规范地址：https://npmcn.com/package/%40iworkflow/dbos/

版本：0\.15\.1
npm 元数据更新时间：2026-11-01T06:36:46.955Z
中文译文更新时间：2026-11-01T13:03:03.673Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40iworkflow/dbos
原文对照：https://npmcn.com/package/%40iworkflow/dbos/?lang=original
项目主页：https://github.com/iconicompany/iworkflow#readme
源码仓库：https://github.com/iconicompany/iworkflow

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

- 包体积（解压后）：102 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- peer 依赖：@dbos-inc/dbos-sdk ^5\.3\.0
- 首次发布：2026-10-21T11:55:23.402Z
- 最新版本发布：2026-11-01T06:36:46.776Z
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

@iworkflow/core的DBOS适配器

## 安装

```sh
npm install @iworkflow/dbos
```

也可以使用：`pnpm add @iworkflow/dbos`、`yarn add @iworkflow/dbos`、`bun add @iworkflow/dbos`

## README

# @iworkflow / dbos

DBOSдля `@iworkflow/core`。同行: `@dbos-inc/dbos-sdk` ^ 5.3;зависимость `pg`.

-   `dbosRuntime({ systemDatabaseUrl }).start(def)` ——приложение `def.app`,очередь `def.app`,версия `<app>-patching`.
    
-   `dbosClient()` - старт， сигнал，查询по id。
    
-   ,Модулизовущиедругдруга,делятоднусистемнуюбазу: `dbosRuntime({ systemDatabaseUrl })` / `dbosClient({ systemDatabaseUrl })` или `DBOS_SYSTEM_DATABASE_URL`;без адреса - отказ。Тестымодуля——всвоейбазе:одноимённыеочередиперехватываютзадачи。
    
-   Своё， схеме `iwf`： `heartbeat` (прогрессшага), `birth` （патчи кода， начавшего процесс）。
    
-   Запускмодулей——под咨询——замком:миграцииDBOSнапустойбазеиначеловят僵局。
    
-   Рантайм владеет dbos процесса： `stop` снимает все регистрации dbos， повторный `start` регистрируетзаново。
    
-   Прод——рольнамодуль:схемуведётвладелецбазы,модульбезDDL - `DBOS_ADMIN_URL=<владелец> bunx -p @iworkflow/dbos iworkflow-dbos migrate --prune --app italent=italentproduction ...` (полный список модулей； без `--prune` роли только добавляются；повторять после обновления пакета)， модуля `dbosRuntime({ systemDatabaseUrl, migrate: false, connection: { password: () => token() } })` ——входтокеном,остальноеизадреса(sslmode sslrootcert)。Триггеры:рольмодуляпишеттолькосвоипроцессы,чужому- завести очередь， отменить， послать сообщение；дочерний - только， модуля родителя， так что `parentId`， входиитогчужогопроцессазаписьювбазунеподделать。Роль вне списка - отказ。Версия `DBOS_APPLICATION_VERSION` - \* \* префиксом `<модуль>-`.
    
-   Системной базы нет - `start` создаёт™（нужен доступ™базе） `postgres` право createdb)， иначе заведи заранее。
    
-   Все поды 0:0:0:0:0 `local`:новыйподвосстанавливает悬而未决——процессы,покастарыйещёихведёт。В k8s - один под \* `strategy: Recreate`， пока нет своего executor id на под。
    

Переменные: `DBOS_SYSTEM_DATABASE_URL`， `DBOS_QUEUE_POLL_MS`， `DBOS_RESULT_POLL_MS`， `DBOS_APPLICATION_VERSION`.

## 常见问题

### @iworkflow/dbos 是什么？

@iworkflow/core的DBOS适配器

### 如何安装 @iworkflow/dbos？

在项目目录运行 npm install @iworkflow/dbos，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@dbos-inc/dbos-sdk（^5\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 iworkflow-dbos，可以用 npx iworkflow-dbos 直接运行。

### @iworkflow/dbos 支持 TypeScript 吗？

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

### @iworkflow/dbos 支持 ESM 还是 CommonJS？

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

### @iworkflow/dbos 需要什么版本的 Node\.js？

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

### @iworkflow/dbos 可以商用吗？

@iworkflow/dbos 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @iworkflow/dbos 还在维护吗？

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