OxL Reference

fn status

The state of a saga, or none when no such saga exists.

Example:

oxl✓ checked in CI
@error data Boom { m: str }

service Bank {
  @public @idempotent rpc hold(n: u64) -> u64
  @public @idempotent rpc unhold(n: u64) -> () | Boom
  @public @idempotent rpc refuse(n: u64) -> u64 | Boom
}

impl Bank {
  rpc hold(n) => n
  rpc unhold(n) { fail Boom{ m: "bank is down" } }
  rpc refuse(n) { fail Boom{ m: "no" } }
}

// the second step fails and its compensation never succeeds: the saga becomes stuck
saga pay(n: u64) -> u64 {
  Bank.hold(n)   undo h => Bank.unhold(h)
  -> Bank.refuse(n)
}

fn main() io, net, time, db {
  let _ = pay(9)
  for s in std.saga.list(.Stuck) {
    let again = std.saga.status(s.id)!
    print("{again.name} {again.status} completed={again.completed} cursor={again.cursor}")
  }
  print("{std.saga.status("no-such-saga") == none}")
}
Output
main.pay stuck completed=1 cursor=2
true
pub(api) fn status(sagaId: str) -> SagaStatus?  net, db, time

Since. 1.0.0-beta

Parameters

NameType
sagaIdstr

Returns

SagaStatus?

Effects

net, db, time

Defined in: std/saga/saga.oxl:988

See also