Files
orbit/docs/api/retention.md

1.4 KiB

保留清单(只读)

orbit-admin retention inventory 用于在制定保留窗口、归档和备份恢复方案前盘点历史数据。它只执行带截止时间的统计查询,不删除、搬迁、改写数据,也不会自动判断某条记录可以安全归档。

ORBIT_MYSQL_DSN='user:password@tcp(127.0.0.1:3306)/orbit' \
  go run ./cmd/orbit-admin retention inventory \
  --before 2026-09-18T00:00:00Z

示例输出:

{"cutoff":"2026-09-18T00:00:00Z","expired_idempotency":0,"terminal_tasks":0,"uncertain_tasks":0,"active_tasks":0,"terminal_workflows":0,"active_workflows":0,"acknowledged_deliveries":0,"unconfirmed_deliveries":0,"processed_inbox":0,"unprocessed_inbox":0,"events":0,"audit_events":0}

所有时间按 UTC 解析,严格早于 --before 的记录才计入。截止时间不能晚于数据库当前时间,避免把未来记录误认为历史。terminal_tasks 只统计确定终态且 effect_uncertain=false 的任务;uncertain_tasks、active_tasks、active_workflows、unconfirmed_deliveries 和 unprocessed_inbox 是需要先处理或保留的阻塞项。

结果是盘点快照,不是归档授权。真正的清理或归档还必须完成保留周期评审、未确认副作用核对、事件投递和流程推进核对、备份恢复演练、权限隔离及审计;当前命令没有 apply 或删除路径。