Skip to content

参考 ​

本部分面向已经使用 Pulse、需要核对行为边界或实现集成的开发者。操作步骤与完整程序位于使用指南;参考页集中说明生命周期、错误、检查点协议和版本迁移。

版本范围 ​

本文档以当前主线的 API 对象模型为基线;性能、SQLite、恢复和历史对照统一收录在统一生产性能对比。升级差异见迁移参考。

按问题查阅 ​

需要确认的问题页面
当前正式版与历史版本的执行、存储和恢复成本统一生产性能对比
什么时候封闭定义、节点有哪些状态、回调发生几次生命周期
错误表示什么、应该修改声明还是处理运行失败错误
何时确认与发布输出、恢复哪些成果、重试预算如何保留检查点
如何从 v0.4.1 或过渡开发 API 迁移版本迁移
v0.5.0 与当前主线有哪些 API 差异版本迁移

对象与接口位置 ​

对象或入口责任实际用法
Graph可复用的定义、端口、静态挂载与默认配置New、DeclareInput/Output、Add、Sub、Validate
Inputs一次运行的外部输入Seed、SkipSeed
Execution一次运行的状态、槽位、错误与取消NewExecution、Start、Wait、Cancel
ReadOutput成功收尾后的声明出口读取先检查 error,再处理三态
Topology定义结构与静态问题Topology、Mermaid,不启动也不封闭
Snapshot一次运行的无值状态样本Execution.Snapshot,不用于恢复
Observer生命周期回调WithObserver 或 WithExecObserver
CheckpointHooks同步可靠确认与恢复桥接WithExecCheckpoint,通常由 Durable 集成

普通宿主只需根包。记录适配与 YAML 装配分别位于 pulse/observe 与 pulse/yaml,依赖方向始终由外围包指向根包。存储、Codec、持久 RunID 和运行所有权由独立 Durable 层负责。

查阅和排错顺序 ​

先确认自己使用的版本,再定位动作所处阶段:定义装配、本次输入准备、启动校验、节点执行、结果读取或检查点恢复。只有这些前提一致,错误名与状态才有准确含义。

  • 定义阶段的缺失来源、无效出口、依赖环:修正结构,重新校验。
  • 本次必需输入没有提供:准备完整 Inputs,创建新执行。
  • 正常 skipped:按接口的缺值策略处理,整轮可以成功。
  • 真实运行失败或取消:保留原因,等待所有节点结束,再决定业务后续操作。
  • 可靠确认结果不确定:停止本次发布,从持久层权威记录恢复。

公开符号的完整类型说明可通过包文档继续查阅。本参考不重新定义历史设计文档;需要设计背景时可阅读仓库中的当前核心设计和对象模型设计。

下一步 ​

执行控制从生命周期开始,故障处理从错误开始。正在升级项目时,先阅读版本迁移,再返回相应操作主题。

开发版 API 文档 · Go 1.26+ · MIT