@iworkflow/dbos

中文文档
0.15.1发布于 2026/11/01MITTypeScriptES Module

DBOS adapter for @iworkflow/core

原始使用文档

@iworkflow/dbos

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

  • dbosRuntime({ systemDatabaseUrl }).start(def) — приложение def.app, очередь def.app, версия <app>-patching.

  • dbosClient() — старт, сигнал, query по id.

  • Модули, зовущие друг друга, делят одну системную базу: dbosRuntime({ systemDatabaseUrl }) / dbosClient({ systemDatabaseUrl }) или DBOS_SYSTEM_DATABASE_URL; без адреса — отказ. Тесты модуля — в своей базе: одноимённые очереди перехватывают задачи.

  • Своё в схеме iwf: heartbeat (прогресс шага), birth (патчи кода, начавшего процесс).

  • Запуск модулей — под advisory-замком: миграции DBOS на пустой базе иначе ловят deadlock.

  • Рантайм владеет 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), иначе заведи заранее.

  • Все поды с executor id local: новый под восстанавливает PENDING-процессы, пока старый ещё их ведёт. В k8s — один под и strategy: Recreate, пока нет своего executor id на под.

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

版本与发布记录

@iworkflow/dbos 共发布 18 个版本,首次发布于 2026/10/21;过去 12 个月发布了 18 个版本。

版本发布日期距今
0.15.1latest2026/11/012 天前
0.15.02026/11/012 天前
0.14.02026/10/303 天前
0.13.02026/10/303 天前
0.12.02026/10/304 天前
0.11.02026/10/304 天前

关于 @iworkflow/dbos 的常见问题

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