API Reference docket v#0.1.1

Copy Markdown View Source

Modules

Public entry point for durable graph operations.

Bundle contract for a durable Docket backend.

Persistence contract for append-only run events.

Persistence contract for tenant-owned effective graph versions.

Persistence contract for the durable run aggregate.

Read-only description of an already committed runtime transition.

Context passed to observers and processless test sinks alongside each checkpoint.

Best-effort notification of an already-committed durable checkpoint.

Public typed error returned by runtime and execution APIs.

Append-only fact about run lifecycle, node execution, channel updates, edge triggers, and interrupts.

One page of retained run events with the retention bounds observed alongside it.

Adapter boundary for executing one runtime graph node activation.

Synchronous local executor: calls the node module directly in the activation's dispatcher task.

Canonical, editable graph document used by host applications.

Public verification and runtime materialization entry point.

A public graph diagnostic.

Editable public edge between graph endpoints.

Public graph construction and editing error.

Public input or state field in a graph document.

Editable public graph node.

Public output projection from graph fields.

Stable reference to one saved, content-addressed graph version.

Lightweight metadata for one retained saved graph version.

One newest-first page of retained graph-version metadata.

Durable guard expression descriptors evaluated on graph edges.

Interrupt request returned by node code to pause a run for external input.

Behaviour implemented by executable node modules.

The complete PostgreSQL backend bundle for a durable Docket runtime.

Coordinates the admission preference shared by one PostgreSQL backend instance.

Instance-resolved PostgreSQL admission-plan boundary.

Tenant-blind PostgreSQL admission engine.

One implementation-owned, data-only PostgreSQL admission operation.

Statistically-fair PostgreSQL admission engine.

Postgres append-only persistence for already-assigned runtime events.

Optional node-local cache of compiled runtime graphs and known-incompatible graph versions.

Contract for a vehicle graph cache.

Postgres storage for immutable, content-addressed durable graphs.

Creates and versions the tables owned by Docket's PostgreSQL backend.

PostgreSQL-native one-statement commitment for a claimed runtime moment.

LISTEN fast path turning committed immediate-wake notifications into dispatcher polls.

Periodic, bounded retention for Postgres events, terminal runs, and graph versions.

Maps one durable Docket.Run to its Postgres row.

Postgres persistence for the durable run aggregate and its operational delivery state.

Row schema for docket_events — append-only run facts, mirroring Docket.Event.

Row schema for docket_runs.

Bounded metric-label projections for PostgreSQL backend telemetry.

Ephemeral execution shell for one claimed run.

Public reducer descriptors for graph state fields, plus the pure reduction engine the runtime applies at every commit.

Durable execution state for one graph run.

Committed state of one runtime channel inside a Docket.Run.

Durable, JSON-safe description of a terminal graph failure.

Committed state of one interrupt on a Docket.Run.

Completed result of one task in the active superstep, held on Docket.Run.pending_writes until the superstep's update barrier.

Durable description of one node execution attempt.

Durable future wake owned by the run document.

Substrate-neutral operational projection of one durable run.

One newest-first page of lightweight durable run summaries.

Lightweight projection of one durable run for collection reads.

Internal executable graph materialization produced by Docket.Graph.Compiler.

Internal runtime channel definition.

Required lowering metadata mapping runtime IDs back to public graph intent.

Internal runtime node definition.

Substrate-neutral pre-commit value for exactly one runtime transition.

Pure, named mutations of an already-committed Docket.Run.

Supervision tree for one named Docket runtime instance.

Serializable schema IR used by graph fields and node contracts.

Live :telemetry emission for run events.

Inline test runtime: executes graph transitions in the calling process using the same loop, algorithm, validation, reducer, and checkpoint-building code as backend execution vehicles.

Mix Tasks

Generates a fresh Docket schema migration or a host schema-V1-to-current upgrade.