@godspideai/ cognate- projections
经检查,能分解,可重建的对Cognate持久事件日志的预测. 预测是事件产生的决定性因素; ProjectionRunner 保持其衍生状态和检查站同步,逐批进行,决不跳过故障事件.
何时使用此软件包 : 您想要从已承诺的事件中得出的读取模型或索引——计数,列表,每个租户的视图——在重启后存活下来,可以从零开始重建,并在同时编剧下保持一致. 这个
@godspeedai/cognate-runtime-bun
运行时间使用此软件包来保持已注册的预测流; 您也可以运行一个 ProjectionRunner 直接覆盖任意
@godspeedai/cognate-events 存储.
安装
bun add @godspeedai/cognate-projections
要求数 阿宝 1.4.0 需要一个执行
@godspeedai/cognate-events DurableStore
合同——例如 @godspeedai/cognate-store-sqlite
或者说 @godspeedai/cognate-store-memory。 。 。 .
快开始
import { ProjectionRunner } from "@godspeedai/cognate-projections";
import type { Projection } from "@godspeedai/cognate-projections";
const ledger: Projection = {
name: "ledger",
version: "1", // bump to force a rebuild rather than reinterpret old state
apply(event, state) {
const count = (state.get(`count:${event.eventType}`) as number | undefined) ?? 0;
const total = (state.get("total") as number | undefined) ?? 0;
const amount = (event.payload as { amount?: number }).amount ?? 0;
return [
{ key: `count:${event.eventType}`, value: count + 1 },
{ key: "total", value: total + amount },
];
},
};
const runner = new ProjectionRunner(store, ledger);
const result = await runner.catchUp();
// { status: "ok", position: <last applied store position>, applied: 3 }
const total = await store.readProjection("ledger", "total");
apply 返回要写的密钥(value: null 删除密钥),并可能读取同一批次中较早时写入的状态 state.get。 。 。 .
跑者的行为
- 检出并一等能. 每批的文字和检查点 都通过一个解剖方式
commitProjection呼叫,由前阵地守卫 运行catchUp()两次应用每个事件一次. - 失败阻止了世界,这是正确的. 在应用错误中, 运行者执行成功的前缀, 记录失败事件时的错误, 然后返回
{ status: "error", ... }。 。 。 .catchUp()继续返回存储的错误,直到您清除它retry()重新尝试从检查站。 失败的事件永远不会被跳过 . - 版本更改需要重建. 一个存储的检查点,其版本与投影本身的产量不同
{ status: "rebuild_required" }· ;rebuild()删除派生状态并重放位置0. - 直播模式.
start()跟踪所犯之事;stop()在飞行中运行结束后取消订阅 。 所有运行——直播,catchUp, (中文(简体) ),retry, (中文(简体) ),rebuild——被序列化,使其永不重叠.waitFor(position)一旦检查站到达指定的商店位置,即可解决. - 同时期跑者是安全的. 两名跑者在一次投影比赛上通过商店的检查站冲突解决:输家重新读取检查站,并从中继续而无需双重应用.
限制
- 预测是推导出来的状态:这里没有什么是权威的
rebuild()将愉快地删除和重算一切。 永远不要在投影中存储唯一的数据副本. apply考虑到事件和状态——没有时钟、随机性或网络——必须具有决定性。 首先将非决定性输入记录为事件 .
相关软件包
@godspeedai/cognate-events——事件记录和检查站API 本套件以.@godspeedai/cognate-store-sqlite- 耐久的商店来投影.@godspeedai/cognate-runtime-bun——自动保持已登记的预测流;公共预测能通过服务和客户端读取.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0