Error returns a formatted error message including the error code. This implements the standard Go error interface.

RegisterWorkflow registers a function as a durable workflow that can be executed and recovered. The function is registered with type safety - P repres

RunWorkflow executes a workflow function with type safety and durability guarantees. The workflow can be executed immediately or enqueued for later ex

Deprecate a patch

* Test database setup */

New creates a new SystemDatabase instance and runs migrations renderSQL formats a canonical pg-style query string with sprintf and runs it through the

WithWorkflowID sets a custom workflow ID instead of generating one automatically.

Launch launches the DBOS runtime using the provided DBOSContext. This is a package-level wrapper for the DBOSContext.Launch() method. Example: ctx,

Wait for workflow completion and return the result

SchemaPrefix returns the qualified-table prefix, e.g. `"dbos".` for Postgres or "" for SQLite (no schemas). Includes the trailing dot.

WithQueue enqueues the workflow to the specified queue instead of executing immediately. Queued workflows will be processed by the queue runner accord

RunAsStep executes a function as a durable step within a workflow. Steps provide at-least-once execution guarantees and automatic retry capabilities.

withRetrierLogger sets the logger for the retrier

GetWorkflowSteps retrieves the execution steps of a workflow. Returns a list of step information including step IDs, names, outputs, errors, and child

Name returns a stable identifier for the dialect.

WithStepName sets a custom name for the step. If the step name has already been set by a previous call to WithStepName, this option will be ignored

Delete workflows and all their associated data Accessors

Implements https://pkg.go.dev/errors#Is

Read values from a durable stream asynchronously

retryWithResult executes a function that returns a value with retry logic It uses the non-generic retry function under the hood

ListWorkflows retrieves a list of workflows based on the provided filters. The function supports filtering by workflow IDs, status, time ranges, name

Decode deserializes a string from the database back into a value.

Shutdown gracefully shuts down the DBOS runtime using the provided DBOSContext and timeout. This is a package-level wrapper for the DBOSContext.Shutdo

NewDBOSContext creates a new DBOS context with the provided configuration. The context must be launched with Launch() for workflow execution and shoul

NewWorkflowQueue creates a new workflow queue with the specified name and configuration options. Deprecated: Use [RegisterQueue], which persists the

Enqueue adds a workflow to a named queue for later execution with type safety. The workflow will be persisted with ENQUEUED status until picked up by

registerWFQ / retrieveWFQ / listWFQ are test helpers that call the public queue API (which returns the Queue interface) and unwrap the concrete *Workf

*testing.T -> string; ensures setupDBOS and follow-up callers (e.g. NewClient) share the same sqlite file.

WithEnqueueApplicationVersion overrides the application version for the enqueued workflow.

testAllSerializationPaths tests workflow recovery and verifies all read paths. This is the unified test function that exercises: 1. Workflow recovery:

retry executes a function with retry logic using functional optionsr

Encode serializes a value to a string representation for database storage.

getDatabaseURL returns a default database URL if none is configured, following dbos/utils_test.go pattern

GetWorkflowID retrieves the workflow ID from the context if called within a DBOS workflow. Returns an error if not called from within a workflow conte

sendTextMessage sends a text WebSocket message to the connected client

Context Lifecycle

SetEvent sets a key-value event for the current workflow with type safety. Events are persistent and can be retrieved by other workflows using GetEven

WithQueueBasePollingInterval sets the initial polling interval for the queue. This is the starting interval and the minimum - the queue will never pol

setWorkflowStatusPending sets the workflow's status to PENDING in the DB (clearing output, error, started_at_epoch_ms).

WithWorkflowIDs filters workflows by the specified workflow IDs.

NewClient creates a new DBOS client with the provided configuration. The client manages its own DBOSContext internally. Example: config := dbos.Cli

WithGlobalConcurrency limits the total number of workflows that can run concurrently from the queue across all executors. This provides global concurr

WithWorkflowIDPrefix filters workflows by workflow ID prefix(es).

Send sends a message to another workflow with type safety. Send can be called from within a workflow (as a durable step) or from outside workflows. W

SysDB management

CreateSchedule creates a new schedule for a workflow. The reconciler loop picks the new schedule up on its next tick and installs it in the cron sched

WithDeduplicationID sets a deduplication ID for a queue workflow.

WithTimeout returns a copy of the DBOS context that is canceled after the given timeout.

* Test database reset. Deletes rows from dbos-managed tables instead of dropping the database, which is much cheaper — especially on CockroachDB where

resolveEncoder returns the serializer to use for encoding values within a workflow. Priority: portable workflow → user custom serializer → default JSO

runAsTxn executes a step function that receives a transaction when run on its own. The step body and checkpoint share one transaction, so system DB wr

Manually expand array parameters for databases that don't support them

WithEnqueueWorkflowID sets a custom workflow ID instead of generating one automatically.

GetWorkflowAggregates returns aggregate counts of workflows grouped by one or more columns and/or by created_at time bucket. At least one GroupBy* fl

GetSchedule gets a schedule by name. Example: schedule, err := dbos.GetSchedule(ctx, "my-schedule")

WithStatus filters workflows by the specified list of statuses.

nextStepID returns the next step ID and increments the counter

ListSchedules lists schedules, optionally filtered by the supplied options. Pass no options to return all schedules. Example: schedules, err := dbo

PgxPool unwraps the underlying *pgxpool.Pool. Returns nil if the Pool is not pgx-backed. Used by call sites that still need pgx-specific features (not

Returns a copy of the DBOS context with the given key-value pair

WithQueueName filters workflows by the specified queue name(s). This is typically used when listing queued workflows.

Returns a copy that is not canceled when the parent is canceled

WriteStream writes a value to a durable stream with type safety. Streams are append-only and ordered by offset. WriteStream can only be called from w

RewriteQuery converts a canonical Postgres-style query (with $N placeholders and a "%s" schema-prefix slot already rendered) into the dialect's native