Reference

Every module’s interface, generated by odoc from its .mli, where each function says what it does, what it refuses and what it defaults to.

The packages

A dune file names a library as it is installed (rowtype-postgres); OCaml code names it as a module (Rowtype_postgres).

Package	Libraries	What it is
spool	spool	The queue: its table’s statements, kinds, enqueueing, the runner, and an operator’s hand; its migrations installed in share/spool/migrations
rowtype, rowtype-postgres, rowtype-migrate	the same	A statement described once, its Postgres backend, which spool runs over, and the command that applies spool’s migrations, released on their own; spool installs rowtype and rowtype-postgres
wiretype	wiretype	JSON as descriptions, which a job’s payload is, released on its own; installed with spool

spool

• Spool – the table, kinds, enqueueing, an operator’s hand, and running: table, statements, enqueue, find, counts, cancel, retry and handle. Its modules:
  • Spool.Kind – a kind of job: its name, its payload’s description, and how it is run.
  • Spool.Runner – a runner of queues: made, started, drained in a test, and stopped.
  • Spool.Id – a job’s handle.

What it is built on

• Rowtype and Rowtype_postgres – a statement described once, and running one on Postgres: the connection a job is enqueued through, its transaction, and the connection string a runner is given.
• Wiretype – JSON as descriptions: a kind’s payload.