StellaOps.Workflow.DataStore.PostgreSQL
PostgreSQL store for the workflow engine: definitions, runtime state, projections, signals and schedules; applies its schema migrations at host startup.
| Package | StellaOps.Workflow.DataStore.PostgreSQL |
| Component | Workflow |
| Licence | BUSL-1.1 (Workflow licence) |
| Package kind | Library |
| Target framework | net10.0 |
To add the package to a project, see Installing Stella Ops packages.
Namespaces
| Namespace | Types |
|---|---|
StellaOps.Workflow.DataStore.PostgreSQL | 29 |
StellaOps.Workflow.DataStore.PostgreSQL namespace
| Type | Kind | Description |
|---|---|---|
PostgresWorkflowBackendOptions | class | Operator knobs of the Workflow PostgreSQL store. |
PostgresWorkflowChildLinkStore | class | PostgreSQL IWorkflowChildLinkStore: each write and its durable outbox message commit together, in the ambient mutation transaction when there is one. |
PostgresWorkflowDataStoreExtensions | class | Registers the PostgreSQL workflow store. |
PostgresWorkflowDataStoreRegistrationOptions | class | Optional parts of PostgresWorkflowDataStoreExtensions.AddWorkflowPostgresDataStore(IServiceCollection, IConfiguration, Action<PostgresWorkflowDataStoreRegistrationOptions>). |
PostgresWorkflowDataStoreRoutine | class | Dependency-injection routine of the PostgreSQL store. |
PostgresWorkflowDatabase | class | The PostgreSQL connection and change scope of the workflow store. |
PostgresWorkflowDefinitionStore | class | PostgreSQL-backed implementation of IWorkflowDefinitionStoreand IWorkflowDefinitionGovernanceStore. |
PostgresWorkflowDurableMaintenanceStore | class | PostgreSQL IWorkflowDurableMaintenanceStore: read-only probes over the durable tables. |
PostgresWorkflowDurableStartStore | class | PostgreSQL IWorkflowDurableStartStore. |
PostgresWorkflowExecutionConsoleReadStore | class | PostgreSQL IWorkflowExecutionConsoleReadStore. |
PostgresWorkflowExternalActivityStore | class | PostgreSQL IWorkflowExternalActivityStore. |
PostgresWorkflowFirstSeenLedger | class | The durable first-seen ledger in workflow.wf_first_seen_workflows (the schema script). |
PostgresWorkflowHistoryStore | class | PostgreSQL IWorkflowHistoryStore: events in wf_execution_events, the history cursor (floor, next sequence, legal hold, retention policy) on the instance row. |
PostgresWorkflowHostedJobLockService | class | The hosted job lock, in PostgreSQL. |
PostgresWorkflowMapStore | class | PostgreSQL IWorkflowMapStore. |
PostgresWorkflowMutationCoordinator | class | Begins the change scopes of the PostgreSQL workflow store. |
PostgresWorkflowMutationSessionAccessor | class | Holds the PostgreSQL session of the open change scope. |
PostgresWorkflowOutboxStore | class | PostgreSQL IWorkflowOutboxStoreover the durable, activity-dispatch and activity-cancel outboxes and the activity-completion inbox. |
PostgresWorkflowProjectionRetentionStore | class | PostgreSQL IWorkflowProjectionRetentionStore. |
PostgresWorkflowProjectionStore | class | The instance and task projections, in PostgreSQL. |
PostgresWorkflowRegisteredSignalStore | class | PostgreSQL IWorkflowRegisteredSignalStore: each PostgresWorkflowRegisteredSignalStore.WriteAsync(WorkflowRegisteredSignalWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction), so a version conflict or a duplicate key leaves nothing behind. |
PostgresWorkflowRuntimeStateStore | class | The runtime states of instances, in PostgreSQL. |
PostgresWorkflowScheduleBus | class | Schedules signals in the PostgreSQL signal store. |
PostgresWorkflowSignalBus | class | The native PostgreSQL signal driver: the signal store delivers the wakes. |
PostgresWorkflowSignalDeadLetterStore | class | The dead-lettered signals, in PostgreSQL. |
PostgresWorkflowSignalStore | class | The signal queue, in PostgreSQL. |
PostgresWorkflowSqlBuilder | class | Run-time statements of the Workflow store. |
PostgresWorkflowWakeOutbox | class | The wake outbox, in PostgreSQL. |
WorkflowTables | class | The fixed names of the Workflow PostgreSQL store. |
PostgresWorkflowBackendOptions class
public sealed class PostgresWorkflowBackendOptions
Operator knobs of the Workflow PostgreSQL store. The schema and table names are fixed, not options (see WorkflowTables), and the connection comes only from PostgresWorkflowBackendOptions.ConnectionEnvironmentVariable: there is no connection string name and no generic fallback.
PostgresWorkflowBackendOptions() constructor
public PostgresWorkflowBackendOptions()
Creates an instance of PostgresWorkflowBackendOptions.
ConnectionEnvironmentVariable constant
public const string ConnectionEnvironmentVariable = "STELLAOPS_POSTGRES_WORKFLOW_CONNECTION"
The Workflow service’s own database connection key; fail closed without it.
SectionName constant
public const string SectionName = "WorkflowBackend:Postgres"
The configuration section the options bind from: WorkflowBackend:Postgres.
ApplicationName property
public string? ApplicationName { get; set; }
The application name the connections report to PostgreSQL; stellaops-workflow when not set.
BlockingWaitSeconds property
public int BlockingWaitSeconds { get; set; }
How long a receive waits for a signal before it returns empty, in seconds; a value below 1 counts as 1. The default is 30.
ClaimTimeoutSeconds property
public int ClaimTimeoutSeconds { get; set; }
How long a claimed signal stays leased to its consumer, in seconds. The default is 60.
ConnectionIdleLifetimeSeconds property
public int? ConnectionIdleLifetimeSeconds { get; set; }
How long an idle pooled connection is kept, in seconds; the driver default applies when not set or not positive. The default is 300.
MaxPoolSize property
public int MaxPoolSize { get; set; }
The largest number of pooled connections, at least PostgresWorkflowBackendOptions.MinPoolSize. The default is 100.
MinPoolSize property
public int MinPoolSize { get; set; }
The smallest number of pooled connections; a negative value counts as 0. The default is 1.
NotifyChannel property
public string NotifyChannel { get; set; }
The PostgreSQL notification channel that announces new signals. The default is workflow_signal.
Pooling property
public bool Pooling { get; set; }
Whether connections are pooled. The default is true.
WakeOutboxNotifyChannel property
public string WakeOutboxNotifyChannel { get; set; }
The PostgreSQL notification channel of the wake outbox. The default is workflow_signal_wake_outbox.
PostgresWorkflowChildLinkStore class
public sealed class PostgresWorkflowChildLinkStore : IWorkflowChildLinkStore
PostgreSQL IWorkflowChildLinkStore: each write and its durable outbox message commit together, in the ambient mutation transaction when there is one.
PostgresWorkflowChildLinkStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowChildLinkStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowChildLinkStore: each write and its durable outbox message commit together, in the ambient mutation transaction when there is one.
GetAsync(string, CancellationToken) method
public Task<WorkflowChildLink?> GetAsync(string linkId, CancellationToken cancellationToken = default)
Reads a child link.
Parameters
linkId: The link.cancellationToken: Cancels the operation.
Returns
The link, or null.
InsertAsync(WorkflowChildLink, WorkflowOutboxMessage, CancellationToken) method
public Task InsertAsync(WorkflowChildLink link, WorkflowOutboxMessage message, CancellationToken cancellationToken = default)
Inserts the link and appends the message; throws WorkflowStoreDuplicateExceptionwhen the link exists.
UpdateAsync(WorkflowChildLink, long, WorkflowOutboxMessage, CancellationToken) method
public Task UpdateAsync(WorkflowChildLink link, long expectedVersion, WorkflowOutboxMessage? message, CancellationToken cancellationToken = default)
Replaces the link when its stored version is expectedVersion and appends the message, if any; throws WorkflowStoreConcurrencyExceptionon a version mismatch.
PostgresWorkflowDataStoreExtensions class
public static class PostgresWorkflowDataStoreExtensions
Registers the PostgreSQL workflow store.
AddWorkflowPostgresDataStore(IServiceCollection, IConfiguration, Action<PostgresWorkflowDataStoreRegistrationOptions>) extension method
public static IServiceCollection AddWorkflowPostgresDataStore(this IServiceCollection services, IConfiguration configuration, Action<PostgresWorkflowDataStoreRegistrationOptions>? configure = null)
Registers the PostgreSQL workflow store when WorkflowBackend:Provider is Postgres or unset; otherwise it only records the store module. The connection string is the STELLAOPS_POSTGRES_WORKFLOW_CONNECTION setting; registration fails without it.
Parameters
services: The service collection to add the services to.configuration: The host configuration.configure: Changes what is registered besides the store, for example the start-up schema script.
Returns
The same service collection, for chaining.
PostgresWorkflowDataStoreRegistrationOptions class
public sealed class PostgresWorkflowDataStoreRegistrationOptions
Optional parts of PostgresWorkflowDataStoreExtensions.AddWorkflowPostgresDataStore(IServiceCollection, IConfiguration, Action<PostgresWorkflowDataStoreRegistrationOptions>).
PostgresWorkflowDataStoreRegistrationOptions() constructor
public PostgresWorkflowDataStoreRegistrationOptions()
Creates an instance of PostgresWorkflowDataStoreRegistrationOptions.
ApplyMigrationsOnStartup property
public bool ApplyMigrationsOnStartup { get; set; }
Apply the schema script of StellaOps.Workflow.Persistence at host start (startup migrations).
RegisterDefinitionStore property
public bool RegisterDefinitionStore { get; set; }
Replace IWorkflowDefinitionStorewith PostgresWorkflowDefinitionStore.
RegisterWakeOutbox property
public bool RegisterWakeOutbox { get; set; }
Replace the wake outbox and its receiver with PostgresWorkflowWakeOutbox.
PostgresWorkflowDataStoreRoutine class
public sealed class PostgresWorkflowDataStoreRoutine : IDependencyInjectionRoutine
Dependency-injection routine of the PostgreSQL store. A host that loads this assembly as a plugin discovers the routine; it registers exactly what PostgresWorkflowDataStoreExtensions.AddWorkflowPostgresDataStore(IServiceCollection, IConfiguration, Action<PostgresWorkflowDataStoreRegistrationOptions>)registers.
PostgresWorkflowDataStoreRoutine() constructor
public PostgresWorkflowDataStoreRoutine()
Creates an instance of PostgresWorkflowDataStoreRoutine.
Register(IServiceCollection, IConfiguration) method
public IServiceCollection Register(IServiceCollection services, IConfiguration configuration)
Registers what AddWorkflowPostgresDataStore registers.
Parameters
services: The service collection.configuration: The host configuration.
Returns
The same service collection.
PostgresWorkflowDatabase class
public sealed class PostgresWorkflowDatabase
The PostgreSQL connection and change scope of the workflow store.
PostgresWorkflowDatabase(IConfiguration, IOptions<PostgresWorkflowBackendOptions>, PostgresWorkflowMutationSessionAccessor, IWorkflowMutationScopeAccessor) constructor
public PostgresWorkflowDatabase(IConfiguration configuration, IOptions<PostgresWorkflowBackendOptions> options, PostgresWorkflowMutationSessionAccessor sessionAccessor, IWorkflowMutationScopeAccessor scopeAccessor)
The PostgreSQL connection and change scope of the workflow store.
PostgresWorkflowDefinitionStore class
public sealed class PostgresWorkflowDefinitionStore : IWorkflowDefinitionStore, IWorkflowDefinitionGovernanceStore
PostgreSQL-backed implementation of IWorkflowDefinitionStoreand IWorkflowDefinitionGovernanceStore. Stores versioned canonical workflow definitions with their provenance in the wf_definitions table; a stored version is immutable, a managed definition is activated only through governance, and every governed activation leaves a row in wf_definition_audit.
PostgresWorkflowDefinitionStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowDefinitionStore(PostgresWorkflowDatabase db)
PostgreSQL-backed implementation of IWorkflowDefinitionStoreand IWorkflowDefinitionGovernanceStore. Stores versioned canonical workflow definitions with their provenance in the wf_definitions table; a stored version is immutable, a managed definition is activated only through governance, and every governed activation leaves a row in wf_definition_audit.
ActivateAsync(string, string, CancellationToken) method
public Task ActivateAsync(string workflowName, string version, CancellationToken cancellationToken = default)
Sets a specific version as active for a workflow name. Deactivates all other versions of the same workflow.
ActivateGovernedAsync(WorkflowDefinitionActivationRecord, CancellationToken) method
public Task ActivateGovernedAsync(WorkflowDefinitionActivationRecord activation, CancellationToken cancellationToken = default)
Activates a version under the activation fence and the rollback rule, and records the activation for the audit.
Parameters
activation: The activation.cancellationToken: Cancels the operation.
Returns
A task that completes when the version is active.
Exceptions
InvalidOperationException: The fence or the rollback rule refuses the activation; the message is theWORKFLOW_DEFINITION_*code.
FindByHashAsync(string, string, CancellationToken) method
public Task<WorkflowDefinitionRecord?> FindByHashAsync(string workflowName, string contentHash, CancellationToken cancellationToken = default)
Finds any definition record matching the given content hash, regardless of version. Used to detect duplicate imports.
GetActiveAsync(string, CancellationToken) method
public Task<WorkflowDefinitionRecord?> GetActiveAsync(string workflowName, CancellationToken cancellationToken = default)
Gets the active definition for a workflow name. Returns null if no definition is stored for this workflow.
GetAllActiveAsync(CancellationToken) method
public Task<IReadOnlyCollection<WorkflowDefinitionRecord>> GetAllActiveAsync(CancellationToken cancellationToken = default)
Gets all active definitions across all workflow names.
GetAsync(string, string, CancellationToken) method
public Task<WorkflowDefinitionRecord?> GetAsync(string workflowName, string version, CancellationToken cancellationToken = default)
Gets a specific version of a workflow definition.
GetVersionsAsync(string, CancellationToken) method
public Task<IReadOnlyCollection<WorkflowDefinitionRecord>> GetVersionsAsync(string workflowName, CancellationToken cancellationToken = default)
Gets all versions of a workflow definition, ordered by creation date descending.
UpsertAsync(WorkflowDefinitionRecord, CancellationToken) method
public Task UpsertAsync(WorkflowDefinitionRecord record, CancellationToken cancellationToken = default)
Inserts or updates a definition record.
PostgresWorkflowDurableMaintenanceStore class
public sealed class PostgresWorkflowDurableMaintenanceStore : IWorkflowDurableMaintenanceStore
PostgreSQL IWorkflowDurableMaintenanceStore: read-only probes over the durable tables.
PostgresWorkflowDurableMaintenanceStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowDurableMaintenanceStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowDurableMaintenanceStore: read-only probes over the durable tables.
HasOrphanedStepAttemptsAsync(CancellationToken) method
public Task<bool> HasOrphanedStepAttemptsAsync(CancellationToken cancellationToken = default)
True when a step attempt exists whose step (same step, execution and scope ids) does not.
PostgresWorkflowDurableStartStore class
public sealed class PostgresWorkflowDurableStartStore : IWorkflowDurableStartStore
PostgreSQL IWorkflowDurableStartStore. Each write and its durable outbox messages run in one savepoint of the ambient mutation transaction (or their own transaction). A root start writes the instance and runtime-state rows in the shape PostgresWorkflowProjectionStoreand PostgresWorkflowRuntimeStateStorewrite them: the instance key is the workflow execution id, as for every PostgreSQL instance row, so no surrogate id is drawn.
PostgresWorkflowDurableStartStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowDurableStartStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowDurableStartStore. Each write and its durable outbox messages run in one savepoint of the ambient mutation transaction (or their own transaction). A root start writes the instance and runtime-state rows in the shape PostgresWorkflowProjectionStoreand PostgresWorkflowRuntimeStateStorewrite them: the instance key is the workflow execution id, as for every PostgreSQL instance row, so no surrogate id is drawn.
GetFenceAsync(string, CancellationToken) method
public Task<WorkflowPrestartTerminalFence?> GetFenceAsync(string startRequestId, CancellationToken cancellationToken = default)
Reads the prestart terminal fence of a start request.
Parameters
startRequestId: The start request.cancellationToken: Cancels the operation.
Returns
The fence, or null.
GetReceiptAsync(string, CancellationToken) method
public Task<WorkflowStartReceipt?> GetReceiptAsync(string startRequestId, CancellationToken cancellationToken = default)
Reads the receipt of a start request.
Parameters
startRequestId: The start request.cancellationToken: Cancels the operation.
Returns
The receipt, or null.
GetTerminalInboxAsync(string, CancellationToken) method
public Task<WorkflowTerminalInboxEntry?> GetTerminalInboxAsync(string commandEventId, CancellationToken cancellationToken = default)
Reads a terminal inbox entry.
Parameters
commandEventId: The command.cancellationToken: Cancels the operation.
Returns
The entry, or null.
HasOpenExecutionAsync(string, string, string, CancellationToken) method
public Task<bool> HasOpenExecutionAsync(string definitionCode, string businessReferenceSha256, string openStatus, CancellationToken cancellationToken = default)
True when an execution of the definition is open for the business reference.
RecordPrestartTerminalAsync(WorkflowPrestartTerminalFence, WorkflowStartReceipt, WorkflowTerminalInboxEntry, WorkflowOutboxMessage, CancellationToken) method
public Task RecordPrestartTerminalAsync(WorkflowPrestartTerminalFence fence, WorkflowStartReceipt? newReceipt, WorkflowTerminalInboxEntry inbox, WorkflowOutboxMessage message, CancellationToken cancellationToken = default)
Records a prestart terminal command: the fence, the fenced receipt when none exists, the inbox entry and the acknowledgement.
RecordStartDecisionAsync(WorkflowStartReceipt, WorkflowRootExecutionStart, IReadOnlyList<WorkflowOutboxMessage>, CancellationToken) method
public Task RecordStartDecisionAsync(WorkflowStartReceipt receipt, WorkflowRootExecutionStart? root, IReadOnlyList<WorkflowOutboxMessage> messages, CancellationToken cancellationToken = default)
Records a start decision: the receipt, the root execution rows when the start created one (the store allocates the instance id), and the messages.
TryCompleteReceiptAsync(WorkflowStartReceipt, WorkflowOutboxMessage, CancellationToken) method
public Task<bool> TryCompleteReceiptAsync(WorkflowStartReceipt receipt, WorkflowOutboxMessage message, CancellationToken cancellationToken = default)
Writes the result into a receipt that has none yet, with its message. Returns false, and writes nothing, when the stored receipt already carries a result.
PostgresWorkflowExecutionConsoleReadStore class
public sealed class PostgresWorkflowExecutionConsoleReadStore : IWorkflowExecutionConsoleReadStore
PostgreSQL IWorkflowExecutionConsoleReadStore. Identifiers compare and sort with the C collation (byte order), whatever the database collation, so the list cursor pages the same rows.
PostgresWorkflowExecutionConsoleReadStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowExecutionConsoleReadStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowExecutionConsoleReadStore. Identifiers compare and sort with the C collation (byte order), whatever the database collation, so the list cursor pages the same rows.
GetAttemptsAsync(string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleAttemptRecord>> GetAttemptsAsync(string workflowExecutionId, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount step attempts of the execution, by creation time.
GetDeliveriesAsync(string, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleDeliveryRecord>> GetDeliveriesAsync(string workflowExecutionId, CancellationToken cancellationToken = default)
All activity dispatches of the execution, then all its completions, unsorted.
GetExecutionAsync(string, CancellationToken) method
public Task<WorkflowConsoleExecutionRecord?> GetExecutionAsync(string workflowExecutionId, CancellationToken cancellationToken = default)
Reads one execution.
Parameters
workflowExecutionId: The execution.cancellationToken: Cancels the operation.
Returns
The execution, or null.
GetMapItemsAsync(string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleMapItemRecord>> GetMapItemsAsync(string workflowExecutionId, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount items of the execution’s maps, by map execution id, then ordinal.
GetMapsAsync(string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleMapRecord>> GetMapsAsync(string workflowExecutionId, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount map executions of the execution, in the backend’s natural order.
GetScopesAsync(string, int, bool, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleScopeRecord>> GetScopesAsync(string workflowExecutionId, int maxCount, bool orderByCreation, CancellationToken cancellationToken = default)
Up to maxCount scopes of the execution; ordered by creation time when orderByCreation is set, otherwise in the backend’s natural order.
GetStepsAsync(string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleStepRecord>> GetStepsAsync(string workflowExecutionId, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount steps of the execution, by creation time.
ListExecutionsAsync(DateTime?, string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowConsoleExecutionRecord>> ListExecutionsAsync(DateTime? createdBeforeUtc, string? executionIdBefore, int take, CancellationToken cancellationToken = default)
Up to take executions, newest first (created time, then execution id, both descending), strictly after the cursor position when createdBeforeUtc is set.
PostgresWorkflowExternalActivityStore class
public sealed class PostgresWorkflowExternalActivityStore : IWorkflowExternalActivityStore
PostgreSQL IWorkflowExternalActivityStore. Each PostgresWorkflowExternalActivityStore.WriteAsync(WorkflowExternalActivityWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction), so a version conflict or a duplicate key leaves nothing behind. Versioned rows are updated before anything is inserted, in one fixed order (map executions, map items, runtime states, instance cursors, steps, lineages), so two decisions on the same execution queue on the same row lock instead of deadlocking; the loser then matches no row and reports a version conflict.
PostgresWorkflowExternalActivityStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowExternalActivityStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowExternalActivityStore. Each PostgresWorkflowExternalActivityStore.WriteAsync(WorkflowExternalActivityWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction), so a version conflict or a duplicate key leaves nothing behind. Versioned rows are updated before anything is inserted, in one fixed order (map executions, map items, runtime states, instance cursors, steps, lineages), so two decisions on the same execution queue on the same row lock instead of deadlocking; the loser then matches no row and reports a version conflict.
GetAttemptAsync(string, CancellationToken) method
public Task<WorkflowActivityAttempt?> GetAttemptAsync(string attemptId, CancellationToken cancellationToken = default)
Reads an attempt.
Parameters
attemptId: The attempt.cancellationToken: Cancels the operation.
Returns
The attempt, or null.
GetAttemptByNumberAsync(string, int, CancellationToken) method
public Task<WorkflowActivityAttempt?> GetAttemptByNumberAsync(string stepExecutionId, int attemptNumber, CancellationToken cancellationToken = default)
Reads an attempt of a step by number.
Parameters
stepExecutionId: The step execution.attemptNumber: The attempt number.cancellationToken: Cancels the operation.
Returns
The attempt, or null.
GetCompletionAsync(string, CancellationToken) method
public Task<WorkflowActivityCompletionEntry?> GetCompletionAsync(string eventId, CancellationToken cancellationToken = default)
Reads a completion.
Parameters
eventId: The completion event.cancellationToken: Cancels the operation.
Returns
The completion, or null.
GetDispatchForAttemptAsync(string, CancellationToken) method
public Task<WorkflowActivityDispatchEntry?> GetDispatchForAttemptAsync(string attemptId, CancellationToken cancellationToken = default)
Reads the dispatch of an attempt.
Parameters
attemptId: The attempt.cancellationToken: Cancels the operation.
Returns
The dispatch, or null.
GetLastAttemptNumberAsync(string, CancellationToken) method
public Task<int> GetLastAttemptNumberAsync(string stepExecutionId, CancellationToken cancellationToken = default)
The highest attempt number recorded for the step; 0 when it has none.
GetLastReprocessOccurrenceAsync(string, CancellationToken) method
public Task<int> GetLastReprocessOccurrenceAsync(string sourceScopeExecutionId, CancellationToken cancellationToken = default)
The highest reprocess occurrence of the scope; 0 when it has none.
GetLineageAsync(string, CancellationToken) method
public Task<WorkflowContinuationLineage?> GetLineageAsync(string lineageId, CancellationToken cancellationToken = default)
Reads a lineage.
Parameters
lineageId: The lineage.cancellationToken: Cancels the operation.
Returns
The lineage, or null.
GetLineagesAsync(string, string, string, CancellationToken) method
public Task<IReadOnlyList<WorkflowContinuationLineage>> GetLineagesAsync(string stepExecutionId, string? sourceAttemptId, string status, CancellationToken cancellationToken = default)
The step’s lineages in status, highest generation first, optionally limited to one source attempt.
GetMapItemsAsync(string, string, CancellationToken) method
public Task<IReadOnlyList<WorkflowActivityMapItemState>> GetMapItemsAsync(string mapExecutionId, string status, CancellationToken cancellationToken = default)
Reads the items of a map in a status.
Parameters
mapExecutionId: The map execution.status: The status.cancellationToken: Cancels the operation.
Returns
The items.
GetMapsForStopAsync(WorkflowActivityStopTargetKind, string, CancellationToken) method
public Task<IReadOnlyList<WorkflowActivityMapState>> GetMapsForStopAsync(WorkflowActivityStopTargetKind targetKind, string targetId, CancellationToken cancellationToken = default)
The map executions a stop targets, in any status.
GetReadyCancelsAsync(int, CancellationToken) method
public Task<IReadOnlyList<WorkflowActivityCancelEntry>> GetReadyCancelsAsync(int maxCount, CancellationToken cancellationToken = default)
Reads up to maxCount READY cancels, oldest first.
GetReadyDispatchesAsync(int, CancellationToken) method
public Task<IReadOnlyList<WorkflowActivityDispatchEntry>> GetReadyDispatchesAsync(int maxCount, CancellationToken cancellationToken = default)
Reads up to maxCount READY dispatches, oldest first.
GetRootScopeExecutionIdAsync(string, CancellationToken) method
public Task<string?> GetRootScopeExecutionIdAsync(string workflowExecutionId, CancellationToken cancellationToken = default)
Reads the root scope of an execution.
Parameters
workflowExecutionId: The execution.cancellationToken: Cancels the operation.
Returns
The root scope, or null.
GetRuntimeAsync(string, CancellationToken) method
public Task<WorkflowActivityRuntimeState?> GetRuntimeAsync(string workflowExecutionId, CancellationToken cancellationToken = default)
Reads the runtime state of an execution.
Parameters
workflowExecutionId: The execution.cancellationToken: Cancels the operation.
Returns
The runtime state, or null.
GetStepAsync(string, CancellationToken) method
public Task<WorkflowActivityStep?> GetStepAsync(string stepExecutionId, CancellationToken cancellationToken = default)
Reads a step.
Parameters
stepExecutionId: The step execution.cancellationToken: Cancels the operation.
Returns
The step, or null.
GetStepsForStopAsync(WorkflowActivityStopTargetKind, string, CancellationToken) method
public Task<IReadOnlyList<WorkflowActivityStep>> GetStepsForStopAsync(WorkflowActivityStopTargetKind targetKind, string targetId, CancellationToken cancellationToken = default)
The steps a stop targets, ordered by step execution id; for a map, the items’ active steps.
MarkCancelPublishedAsync(string, DateTime, CancellationToken) method
public Task MarkCancelPublishedAsync(string cancelId, DateTime publishedAtUtc, CancellationToken cancellationToken = default)
Marks a cancel PUBLISHED and counts the delivery attempt; does nothing when it is already PUBLISHED and throws when it does not exist.
MarkDispatchPublishedAsync(string, DateTime, CancellationToken) method
public Task MarkDispatchPublishedAsync(string dispatchId, DateTime publishedAtUtc, CancellationToken cancellationToken = default)
Marks a dispatch PUBLISHED and counts the delivery attempt; does nothing when it is already PUBLISHED and throws when it does not exist.
WriteAsync(WorkflowExternalActivityWrite, CancellationToken) method
public Task WriteAsync(WorkflowExternalActivityWrite write, CancellationToken cancellationToken = default)
Writes the changes atomically. Throws WorkflowStoreConcurrencyExceptionwhen a changed row’s version moved and WorkflowStoreDuplicateExceptionwhen a new row’s key exists.
PostgresWorkflowFirstSeenLedger class
public sealed class PostgresWorkflowFirstSeenLedger : IWorkflowFirstSeenLedger
The durable first-seen ledger in workflow.wf_first_seen_workflows (the schema script). It only inserts: a workflow already recorded keeps its first row (ON CONFLICT DO NOTHING), and the table’s trigger refuses UPDATE, DELETE and TRUNCATE. Its row count is the cumulative Designated Workflow technical count, which survives restarts and the removal of a workflow from the code catalogue. Every recording locks the table for its transaction, so engine instances that share the database are serialised and record each name once. Recording never refuses a workflow.
PostgresWorkflowFirstSeenLedger(PostgresWorkflowDatabase) constructor
public PostgresWorkflowFirstSeenLedger(PostgresWorkflowDatabase db)
The durable first-seen ledger in workflow.wf_first_seen_workflows (the schema script). It only inserts: a workflow already recorded keeps its first row (ON CONFLICT DO NOTHING), and the table’s trigger refuses UPDATE, DELETE and TRUNCATE. Its row count is the cumulative Designated Workflow technical count, which survives restarts and the removal of a workflow from the code catalogue. Every recording locks the table for its transaction, so engine instances that share the database are serialised and record each name once. Recording never refuses a workflow.
IsDurable property
public bool IsDurable { get; }
true when the record survives a restart (the PostgreSQL and MongoDB ledgers); false for the process-memory ledger of a host without a workflow store, which counts only what this process has seen.
CountAsync(CancellationToken) method
public Task<int> CountAsync(CancellationToken cancellationToken = default)
The number of distinct workflows ever recorded.
ListAsync(CancellationToken) method
public Task<IReadOnlyList<WorkflowFirstSeenRecord>> ListAsync(CancellationToken cancellationToken = default)
Every workflow ever recorded, one entry per workflow with its first sighting, ordered by WorkflowFirstSeenIdentity.Key(string)(ordinal). The number of entries is the count IWorkflowFirstSeenLedger.CountAsync(CancellationToken)returns for the same ledger state. Reads only; records nothing.
RecordAsync(IReadOnlyCollection<string>, string, DateTimeOffset, CancellationToken) method
public Task RecordAsync(IReadOnlyCollection<string> workflowNames, string source, DateTimeOffset seenOnUtc, CancellationToken cancellationToken = default)
Records the workflows in workflowNames that the ledger has not seen, with source (WorkflowFirstSeenSources) and seenOnUtc. A workflow already recorded is left as it is. Every recording is serialised against every other recording of the same ledger, so engines that share it record each name once.
RecordStoredDefinitionsAsync(CancellationToken) method
public Task RecordStoredDefinitionsAsync(CancellationToken cancellationToken = default)
Records every workflow the definition store holds that the ledger has not seen, active or not, with the creation time of its first stored version. It reconciles imports whose ledger write was interrupted and definitions stored before the ledger existed. A ledger without a durable definition store records nothing here.
PostgresWorkflowHistoryStore class
public sealed class PostgresWorkflowHistoryStore : IWorkflowHistoryStore
PostgreSQL IWorkflowHistoryStore: events in wf_execution_events, the history cursor (floor, next sequence, legal hold, retention policy) on the instance row.
PostgresWorkflowHistoryStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowHistoryStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowHistoryStore: events in wf_execution_events, the history cursor (floor, next sequence, legal hold, retention policy) on the instance row.
CompactPrefixAsync(string, long, int, CancellationToken) method
public Task<WorkflowHistoryCompactionResult> CompactPrefixAsync(string workflowExecutionId, long throughSequence, int maxCount, CancellationToken cancellationToken = default)
Deletes, in one write, up to maxCount events from the history floor through throughSequence, stopping before the first retention-held event, and moves the floor to the first event kept.
GetCursorAsync(string, CancellationToken) method
public Task<WorkflowHistoryCursor> GetCursorAsync(string workflowExecutionId, CancellationToken cancellationToken = default)
Reads the history cursor; throws when the execution does not exist.
GetEventsAsync(string, long, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowHistoryEvent>> GetEventsAsync(string workflowExecutionId, long afterSequence, int maxCount, CancellationToken cancellationToken = default)
Reads up to maxCount events after afterSequence, in sequence order.
PostgresWorkflowHostedJobLockService class
public sealed class PostgresWorkflowHostedJobLockService : IWorkflowHostedJobLockService
The hosted job lock, in PostgreSQL.
PostgresWorkflowHostedJobLockService(PostgresWorkflowDatabase) constructor
public PostgresWorkflowHostedJobLockService(PostgresWorkflowDatabase database)
The hosted job lock, in PostgreSQL.
ReleaseAsync(string, string, CancellationToken) method
public Task ReleaseAsync(string lockName, string lockOwner, CancellationToken cancellationToken = default)
Releases a lock the owner holds.
Parameters
lockName: The lock.lockOwner: The owner.cancellationToken: Cancels the operation.
Returns
A task that completes when the lock is released.
TryAcquireAsync(string, string, DateTime, TimeSpan, CancellationToken) method
public Task<bool> TryAcquireAsync(string lockName, string lockOwner, DateTime acquiredOnUtc, TimeSpan lease, CancellationToken cancellationToken = default)
Takes a lock for an owner unless another owner holds an unexpired lease.
Parameters
lockName: The lock.lockOwner: The owner.acquiredOnUtc: The time, in UTC.lease: How long the lock is held.cancellationToken: Cancels the operation.
Returns
Whether the owner holds the lock.
PostgresWorkflowMapStore class
public sealed class PostgresWorkflowMapStore : IWorkflowMapStore
PostgreSQL IWorkflowMapStore. Each PostgresWorkflowMapStore.WriteAsync(WorkflowMapWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction). Changed rows are updated before anything is inserted, the map executions first and then the items, each in key order: two claims on the same map queue on the map row, and the one that commits second matches no row and loses as a whole with a version conflict.
PostgresWorkflowMapStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowMapStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowMapStore. Each PostgresWorkflowMapStore.WriteAsync(WorkflowMapWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction). Changed rows are updated before anything is inserted, the map executions first and then the items, each in key order: two claims on the same map queue on the map row, and the one that commits second matches no row and loses as a whole with a version conflict.
CountActiveClaimsAsync(string, DateTime, CancellationToken) method
public Task<int> CountActiveClaimsAsync(string mapExecutionId, DateTime nowUtc, CancellationToken cancellationToken = default)
Counts the map’s CLAIMED items that hold capacity at nowUtc: an active step, or an unexpired lease.
CountGlobalActiveClaimsAsync(string, DateTime, CancellationToken) method
public Task<int> CountGlobalActiveClaimsAsync(string globalActivityClass, DateTime nowUtc, CancellationToken cancellationToken = default)
Counts the active claims (as above) across every map of the global activity class.
GetClaimableItemsAsync(string, DateTime, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowMapItemRecord>> GetClaimableItemsAsync(string mapExecutionId, DateTime nowUtc, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount items that can be claimed at nowUtc, ordered by ordinal: READY items, and CLAIMED items with no active step whose lease has expired.
GetGlobalMaxConcurrencyAsync(string, CancellationToken) method
public Task<int> GetGlobalMaxConcurrencyAsync(string globalActivityClass, CancellationToken cancellationToken = default)
The lowest declared max concurrency among the maps of the global activity class.
GetItemAsync(string, CancellationToken) method
public Task<WorkflowMapItemRecord?> GetItemAsync(string mapItemId, CancellationToken cancellationToken = default)
Reads a map item.
Parameters
mapItemId: The map item.cancellationToken: Cancels the operation.
Returns
The item, or null.
GetItemsAsync(string, CancellationToken) method
public Task<IReadOnlyList<WorkflowMapItemRecord>> GetItemsAsync(string mapExecutionId, CancellationToken cancellationToken = default)
All items of the map, ordered by ordinal.
GetItemsByActiveStepAsync(string, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowMapItemRecord>> GetItemsByActiveStepAsync(string activeStepExecutionId, int maxCount, CancellationToken cancellationToken = default)
Up to maxCount items whose active step is activeStepExecutionId.
GetMapAsync(string, CancellationToken) method
public Task<WorkflowMapExecutionRecord?> GetMapAsync(string mapExecutionId, CancellationToken cancellationToken = default)
Reads a map execution.
Parameters
mapExecutionId: The map execution.cancellationToken: Cancels the operation.
Returns
The map, or null.
WriteAsync(WorkflowMapWrite, CancellationToken) method
public Task WriteAsync(WorkflowMapWrite write, CancellationToken cancellationToken = default)
Writes the changes atomically. Throws WorkflowStoreConcurrencyExceptionwhen a changed row’s version moved and WorkflowStoreDuplicateExceptionwhen a new row’s key exists.
PostgresWorkflowMutationCoordinator class
public sealed class PostgresWorkflowMutationCoordinator : IWorkflowMutationCoordinator
Begins the change scopes of the PostgreSQL workflow store.
PostgresWorkflowMutationCoordinator(PostgresWorkflowDatabase) constructor
public PostgresWorkflowMutationCoordinator(PostgresWorkflowDatabase database)
Begins the change scopes of the PostgreSQL workflow store.
BeginAsync(CancellationToken) method
public Task<IWorkflowMutationScope> BeginAsync(CancellationToken cancellationToken = default)
Begins a change scope.
Parameters
cancellationToken: Cancels the operation.
Returns
The scope.
PostgresWorkflowMutationSessionAccessor class
public sealed class PostgresWorkflowMutationSessionAccessor
Holds the PostgreSQL session of the open change scope.
PostgresWorkflowMutationSessionAccessor() constructor
public PostgresWorkflowMutationSessionAccessor()
Creates an instance of PostgresWorkflowMutationSessionAccessor.
PostgresWorkflowOutboxStore class
public sealed class PostgresWorkflowOutboxStore : IWorkflowOutboxStore
PostgreSQL IWorkflowOutboxStoreover the durable, activity-dispatch and activity-cancel outboxes and the activity-completion inbox.
PostgresWorkflowOutboxStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowOutboxStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowOutboxStoreover the durable, activity-dispatch and activity-cancel outboxes and the activity-completion inbox.
CompactDeliveredAsync(DateTime, int, CancellationToken) method
public Task CompactDeliveredAsync(DateTime cutoffUtc, int batchSize, CancellationToken cancellationToken = default)
Deletes up to batchSize rows per outbox published before cutoffUtc, and as many activity-completion inbox rows applied before it.
GetReadyAsync(WorkflowOutboxKind, IReadOnlyCollection<string>, int, CancellationToken) method
public Task<IReadOnlyList<WorkflowOutboxEntry>> GetReadyAsync(WorkflowOutboxKind kind, IReadOnlyCollection<string>? channels, int maxCount, CancellationToken cancellationToken = default)
Reads up to maxCount READY entries, oldest first, optionally limited to some channels.
RecordDeliveryAttemptAsync(WorkflowOutboxEntry, DateTime?, CancellationToken) method
public Task RecordDeliveryAttemptAsync(WorkflowOutboxEntry entry, DateTime? publishedAtUtc, CancellationToken cancellationToken = default)
Counts one delivery attempt; a non-null publishedAtUtc marks the entry PUBLISHED.
TryMarkPublishedAsync(WorkflowOutboxKind, string, DateTime, CancellationToken) method
public Task<bool> TryMarkPublishedAsync(WorkflowOutboxKind kind, string entryKey, DateTime publishedAtUtc, CancellationToken cancellationToken = default)
Marks a READY entry PUBLISHED; false when it is not READY (already published or missing).
PostgresWorkflowProjectionRetentionStore class
public sealed class PostgresWorkflowProjectionRetentionStore : IWorkflowProjectionRetentionStore
PostgreSQL IWorkflowProjectionRetentionStore. Marks stale instances and tasks, then purges each eligible instance with its tasks and every durable row it owns, all in one transaction. An instance under legal hold or the HOLD_ALL policy or with a READY outbox row is kept; an instance in a child link goes only with its whole child family and the family’s links (WorkflowChildFamilyRetention), as in MongoDB. A task also goes on its own purge_after_utc (set when it completes), with its events, while its instance stays, unless that instance is held.
PostgresWorkflowProjectionRetentionStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowProjectionRetentionStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowProjectionRetentionStore. Marks stale instances and tasks, then purges each eligible instance with its tasks and every durable row it owns, all in one transaction. An instance under legal hold or the HOLD_ALL policy or with a READY outbox row is kept; an instance in a child link goes only with its whole child family and the family’s links (WorkflowChildFamilyRetention), as in MongoDB. A task also goes on its own purge_after_utc (set when it completes), with its events, while its instance stays, unless that instance is held.
RunAsync(DateTime, WorkflowRetentionOverride, CancellationToken) method
public Task<WorkflowProjectionRetentionBatch> RunAsync(DateTime nowUtc, WorkflowRetentionOverride? retentionOverride = null, CancellationToken cancellationToken = default)
Marks stale and purges the projections whose dates have passed.
Parameters
nowUtc: The time the dates are compared with, in UTC.retentionOverride: Age thresholds that replace the stored dates; none when not set.cancellationToken: Cancels the operation.
Returns
What was marked and purged.
PostgresWorkflowProjectionStore class
public sealed class PostgresWorkflowProjectionStore : IWorkflowProjectionStore
The instance and task projections, in PostgreSQL.
PostgresWorkflowProjectionStore(PostgresWorkflowDatabase, IConfiguration) constructor
public PostgresWorkflowProjectionStore(PostgresWorkflowDatabase database, IConfiguration configuration)
The instance and task projections, in PostgreSQL.
ApplyRuntimeProgressAsync(string, WorkflowTaskCompletionPlan, WorkflowBusinessReference, CancellationToken) method
public Task ApplyRuntimeProgressAsync(string workflowInstanceId, WorkflowTaskCompletionPlan progressPlan, WorkflowBusinessReference? businessReference, CancellationToken cancellationToken = default)
Applies the progress of an instance that moved without a task completion, such as after a signal.
Parameters
workflowInstanceId: The instance.progressPlan: The plan.businessReference: The business reference.cancellationToken: Cancels the operation.
Returns
A task that completes when the progress is applied.
ApplyTaskCompletionAsync(string, string, IDictionary<string, object>, WorkflowTaskCompletionPlan, WorkflowBusinessReference, CancellationToken) method
public Task<WorkflowTaskSummary> ApplyTaskCompletionAsync(string workflowTaskId, string actorId, IDictionary<string, object?> payload, WorkflowTaskCompletionPlan completionPlan, WorkflowBusinessReference? businessReference, CancellationToken cancellationToken = default)
Completes a task and applies the completion plan: new tasks, state and instance status.
Parameters
workflowTaskId: The task.actorId: Who acts.payload: The completion payload.completionPlan: The plan.businessReference: The business reference after the completion.cancellationToken: Cancels the operation.
Returns
The completed task.
AssignTaskAsync(string, string, string, CancellationToken) method
public Task<WorkflowTaskSummary> AssignTaskAsync(string workflowTaskId, string actorId, string assignee, CancellationToken cancellationToken = default)
Assigns a task to a user.
Parameters
workflowTaskId: The task.actorId: Who acts.assignee: The user.cancellationToken: Cancels the operation.
Returns
The task.
AssignTaskRolesAsync(string, string, IReadOnlyCollection<string>, CancellationToken) method
public Task<WorkflowTaskSummary> AssignTaskRolesAsync(string workflowTaskId, string actorId, IReadOnlyCollection<string> targetRoles, CancellationToken cancellationToken = default)
Assigns a task to roles.
Parameters
workflowTaskId: The task.actorId: Who acts.targetRoles: The roles.cancellationToken: Cancels the operation.
Returns
The task.
CreateWorkflowAsync(WorkflowDefinitionDescriptor, WorkflowBusinessReference, WorkflowStartExecutionPlan, CancellationToken) method
public Task<StartWorkflowResponse> CreateWorkflowAsync(WorkflowDefinitionDescriptor definition, WorkflowBusinessReference? businessReference, WorkflowStartExecutionPlan executionPlan, CancellationToken cancellationToken = default)
Creates the projection of a new instance with the tasks of its start plan.
Parameters
definition: The workflow definition.businessReference: The business reference.executionPlan: The start plan.cancellationToken: Cancels the operation.
Returns
The new instance.
GetExecutionSnapshotAsync(string, CancellationToken) method
public Task<WorkflowExecutionSnapshot?> GetExecutionSnapshotAsync(string workflowTaskId, CancellationToken cancellationToken = default)
Reads a task with the state of its instance.
Parameters
workflowTaskId: The task.cancellationToken: Cancels the operation.
Returns
The snapshot, or null.
GetInstanceAsync(string, CancellationToken) method
public Task<WorkflowInstanceSummary?> GetInstanceAsync(string workflowInstanceId, CancellationToken cancellationToken = default)
Reads an instance.
Parameters
workflowInstanceId: The instance.cancellationToken: Cancels the operation.
Returns
The instance, or null.
GetInstanceDetailsAsync(string, CancellationToken) method
public Task<WorkflowInstanceProjectionDetails?> GetInstanceDetailsAsync(string workflowInstanceId, CancellationToken cancellationToken = default)
Reads an instance with its state, tasks and task events.
Parameters
workflowInstanceId: The instance.cancellationToken: Cancels the operation.
Returns
The details, or null.
GetInstancesAsync(WorkflowInstancesGetRequest, CancellationToken) method
public Task<IReadOnlyCollection<WorkflowInstanceSummary>> GetInstancesAsync(WorkflowInstancesGetRequest request, CancellationToken cancellationToken = default)
Lists instances.
Parameters
request: The filter.cancellationToken: Cancels the operation.
Returns
The instances.
GetTaskAsync(string, CancellationToken) method
public Task<WorkflowTaskSummary?> GetTaskAsync(string workflowTaskId, CancellationToken cancellationToken = default)
Reads a task.
Parameters
workflowTaskId: The task.cancellationToken: Cancels the operation.
Returns
The task, or null.
GetTasksAsync(WorkflowTasksGetRequest, CancellationToken) method
public Task<IReadOnlyCollection<WorkflowTaskSummary>> GetTasksAsync(WorkflowTasksGetRequest request, CancellationToken cancellationToken = default)
Lists tasks.
Parameters
request: The filter.cancellationToken: Cancels the operation.
Returns
The tasks.
ReleaseTaskAsync(string, string, CancellationToken) method
public Task<WorkflowTaskSummary> ReleaseTaskAsync(string workflowTaskId, string actorId, CancellationToken cancellationToken = default)
Releases an assigned task.
Parameters
workflowTaskId: The task.actorId: Who acts.cancellationToken: Cancels the operation.
Returns
The task.
PostgresWorkflowRegisteredSignalStore class
public sealed class PostgresWorkflowRegisteredSignalStore : IWorkflowRegisteredSignalStore
PostgreSQL IWorkflowRegisteredSignalStore: each PostgresWorkflowRegisteredSignalStore.WriteAsync(WorkflowRegisteredSignalWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction), so a version conflict or a duplicate key leaves nothing behind.
PostgresWorkflowRegisteredSignalStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowRegisteredSignalStore(PostgresWorkflowDatabase database)
PostgreSQL IWorkflowRegisteredSignalStore: each PostgresWorkflowRegisteredSignalStore.WriteAsync(WorkflowRegisteredSignalWrite, CancellationToken)runs in one savepoint of the ambient mutation transaction (or its own transaction), so a version conflict or a duplicate key leaves nothing behind.
FindWaitAsync(string, string, string, string, string, CancellationToken) method
public Task<WorkflowRegisteredSignalWait?> FindWaitAsync(string workflowExecutionId, string signalCode, string? serviceAudience, string? signalRegistrationId, string? signalKey, CancellationToken cancellationToken = default)
Finds the wait of an execution for a signal code and audience, by registration id when one is given and by signal key otherwise.
GetInboxAsync(string, CancellationToken) method
public Task<WorkflowRegisteredSignalInboxEntry?> GetInboxAsync(string signalEventId, CancellationToken cancellationToken = default)
Reads a signal inbox entry.
Parameters
signalEventId: The signal event.cancellationToken: Cancels the operation.
Returns
The entry, or null.
GetOldestUncorrelatedInboxAsync(string, string, string, string, string, CancellationToken) method
public Task<WorkflowRegisteredSignalInboxEntry?> GetOldestUncorrelatedInboxAsync(string workflowExecutionId, string signalKey, string signalCode, string serviceAudience, string uncorrelatedDisposition, CancellationToken cancellationToken = default)
The oldest signal received for this execution, key, code and audience that no wait has taken yet.
GetTimerAsync(string, CancellationToken) method
public Task<WorkflowSignalDeadlineTimer?> GetTimerAsync(string timerId, CancellationToken cancellationToken = default)
Reads a deadline timer.
Parameters
timerId: The timer.cancellationToken: Cancels the operation.
Returns
The timer, or null.
GetTimerForWaitAsync(string, CancellationToken) method
public Task<WorkflowSignalDeadlineTimer?> GetTimerForWaitAsync(string signalRegistrationId, CancellationToken cancellationToken = default)
Reads the deadline timer of a wait.
Parameters
signalRegistrationId: The wait.cancellationToken: Cancels the operation.
Returns
The timer, or null.
GetWaitAsync(string, CancellationToken) method
public Task<WorkflowRegisteredSignalWait?> GetWaitAsync(string signalRegistrationId, CancellationToken cancellationToken = default)
Reads a registered wait.
Parameters
signalRegistrationId: The wait.cancellationToken: Cancels the operation.
Returns
The wait, or null.
WriteAsync(WorkflowRegisteredSignalWrite, CancellationToken) method
public Task WriteAsync(WorkflowRegisteredSignalWrite write, CancellationToken cancellationToken = default)
Writes the changes atomically. Throws WorkflowStoreConcurrencyExceptionwhen the changed wait’s version moved and WorkflowStoreDuplicateExceptionwhen a new row’s key exists.
PostgresWorkflowRuntimeStateStore class
public sealed class PostgresWorkflowRuntimeStateStore : IWorkflowRuntimeStateStore
The runtime states of instances, in PostgreSQL.
PostgresWorkflowRuntimeStateStore(PostgresWorkflowDatabase) constructor
public PostgresWorkflowRuntimeStateStore(PostgresWorkflowDatabase database)
The runtime states of instances, in PostgreSQL.
DeleteAsync(IReadOnlyCollection<string>, CancellationToken) method
public Task<int> DeleteAsync(IReadOnlyCollection<string> workflowInstanceIds, CancellationToken cancellationToken = default)
Deletes the runtime states of instances.
Parameters
workflowInstanceIds: The instances.cancellationToken: Cancels the operation.
Returns
The states deleted.
GetAsync(string, CancellationToken) method
public Task<WorkflowRuntimeStateRecord?> GetAsync(string workflowInstanceId, CancellationToken cancellationToken = default)
Reads the runtime state of an instance.
Parameters
workflowInstanceId: The instance.cancellationToken: Cancels the operation.
Returns
The state, or null.
GetManyAsync(IReadOnlyCollection<string>, CancellationToken) method
public Task<IReadOnlyCollection<WorkflowRuntimeStateRecord>> GetManyAsync(IReadOnlyCollection<string> workflowInstanceIds, CancellationToken cancellationToken = default)
Reads the runtime states of instances.
Parameters
workflowInstanceIds: The instances.cancellationToken: Cancels the operation.
Returns
The states found.
MarkStaleAsync(IReadOnlyCollection<string>, DateTime, CancellationToken) method
public Task<int> MarkStaleAsync(IReadOnlyCollection<string> workflowInstanceIds, DateTime updatedOnUtc, CancellationToken cancellationToken = default)
Marks instances stale.
Parameters
workflowInstanceIds: The instances.updatedOnUtc: The change time, in UTC.cancellationToken: Cancels the operation.
Returns
The instances marked.
UpsertAsync(WorkflowRuntimeStateRecord, CancellationToken) method
public Task UpsertAsync(WorkflowRuntimeStateRecord state, CancellationToken cancellationToken = default)
Writes a runtime state whose version is one above the stored one (or the first).
Parameters
state: The state.cancellationToken: Cancels the operation.
Returns
A task that completes when the state is written.
Exceptions
WorkflowRuntimeStateConcurrencyException: Another write changed the instance first.
PostgresWorkflowScheduleBus class
public sealed class PostgresWorkflowScheduleBus : IWorkflowSignalScheduler
Schedules signals in the PostgreSQL signal store.
PostgresWorkflowScheduleBus(PostgresWorkflowSignalStore) constructor
public PostgresWorkflowScheduleBus(PostgresWorkflowSignalStore signalStore)
Schedules signals in the PostgreSQL signal store.
ScheduleAsync(WorkflowSignalEnvelope, DateTime, CancellationToken) method
public Task ScheduleAsync(WorkflowSignalEnvelope envelope, DateTime dueAtUtc, CancellationToken cancellationToken = default)
Stores a signal that becomes available at dueAtUtc.
Parameters
envelope: The signal.dueAtUtc: When the signal is due, in UTC.cancellationToken: Cancels the operation.
Returns
A task that completes when the signal is stored.
PostgresWorkflowSignalBus class
public sealed class PostgresWorkflowSignalBus : IWorkflowSignalDriver
The native PostgreSQL signal driver: the signal store delivers the wakes.
PostgresWorkflowSignalBus(PostgresWorkflowSignalStore) constructor
public PostgresWorkflowSignalBus(PostgresWorkflowSignalStore signalStore)
The native PostgreSQL signal driver: the signal store delivers the wakes.
DispatchMode property
public WorkflowSignalDriverDispatchMode DispatchMode { get; }
When the engine tells the driver that a signal is available.
DriverName property
public string DriverName { get; }
The driver name, as WorkflowSignalDriver:Provider selects it.
NotifySignalAvailableAsync(WorkflowSignalWakeNotification, CancellationToken) method
public Task NotifySignalAvailableAsync(WorkflowSignalWakeNotification notification, CancellationToken cancellationToken = default)
Tells the consumers that a signal is available.
Parameters
notification: The available signal.cancellationToken: Cancels the operation.
Returns
A task that completes when the notification is sent.
ReceiveAsync(string, CancellationToken) method
public Task<IWorkflowSignalLease?> ReceiveAsync(string consumerName, CancellationToken cancellationToken = default)
Waits up to the driver’s blocking wait for a signal to claim.
Parameters
consumerName: The consumer.cancellationToken: Cancels the operation.
Returns
The lease of the claimed signal, or null when none arrives in time.
PostgresWorkflowSignalDeadLetterStore class
public sealed class PostgresWorkflowSignalDeadLetterStore : IWorkflowSignalDeadLetterStore
The dead-lettered signals, in PostgreSQL.
PostgresWorkflowSignalDeadLetterStore(PostgresWorkflowSignalStore) constructor
public PostgresWorkflowSignalDeadLetterStore(PostgresWorkflowSignalStore signalStore)
The dead-lettered signals, in PostgreSQL.
GetMessagesAsync(WorkflowSignalDeadLettersGetRequest, CancellationToken) method
public Task<WorkflowSignalDeadLettersGetResponse> GetMessagesAsync(WorkflowSignalDeadLettersGetRequest request, CancellationToken cancellationToken = default)
Lists the dead-lettered signals.
Parameters
request: The request.cancellationToken: Cancels the operation.
Returns
A page of dead letters.
ReplayAsync(WorkflowSignalDeadLetterReplayRequest, CancellationToken) method
public Task<WorkflowSignalDeadLetterReplayResponse> ReplayAsync(WorkflowSignalDeadLetterReplayRequest request, CancellationToken cancellationToken = default)
Puts a dead letter back on the signal queue.
Parameters
request: The request.cancellationToken: Cancels the operation.
Returns
The outcome.
PostgresWorkflowSignalStore class
public sealed class PostgresWorkflowSignalStore : IWorkflowSignalStore, IWorkflowSignalClaimStore
The signal queue, in PostgreSQL.
PostgresWorkflowSignalStore(PostgresWorkflowDatabase, PostgresWorkflowSqlBuilder) constructor
public PostgresWorkflowSignalStore(PostgresWorkflowDatabase database, PostgresWorkflowSqlBuilder sqlBuilder)
The signal queue, in PostgreSQL.
PublishAsync(WorkflowSignalEnvelope, CancellationToken) method
public Task PublishAsync(WorkflowSignalEnvelope envelope, CancellationToken cancellationToken = default)
Stores a signal for delivery.
Parameters
envelope: The signal.cancellationToken: Cancels the operation.
Returns
A task that completes when the signal is stored.
PublishDeadLetterAsync(WorkflowSignalEnvelope, CancellationToken) method
public Task PublishDeadLetterAsync(WorkflowSignalEnvelope envelope, CancellationToken cancellationToken = default)
Stores a signal that could not be processed as a dead letter.
Parameters
envelope: The signal.cancellationToken: Cancels the operation.
Returns
A task that completes when the signal is stored.
TryClaimAsync(string, CancellationToken) method
public Task<IWorkflowSignalLease?> TryClaimAsync(string consumerName, CancellationToken cancellationToken = default)
Claims one available signal for a consumer.
Parameters
consumerName: The consumer.cancellationToken: Cancels the operation.
Returns
The lease of the claimed signal, or null when none is available.
PostgresWorkflowSqlBuilder class
public sealed class PostgresWorkflowSqlBuilder
Run-time statements of the Workflow store. It emits no DDL: the schema script in StellaOps.Workflow.Persistence is the only DDL authority, and every table is named as that script creates it.
PostgresWorkflowSqlBuilder(IOptions<PostgresWorkflowBackendOptions>) constructor
public PostgresWorkflowSqlBuilder(IOptions<PostgresWorkflowBackendOptions> options)
Run-time statements of the Workflow store. It emits no DDL: the schema script in StellaOps.Workflow.Persistence is the only DDL authority, and every table is named as that script creates it.
BuildNotifySql() method
public string BuildNotifySql()
The SQL that notifies the signal channel.
Returns
The SQL.
BuildReadySignalClaimSql() method
public string BuildReadySignalClaimSql()
The SQL that claims one ready signal for a consumer.
Returns
The SQL.
BuildWakeOutboxClaimSql() method
public string BuildWakeOutboxClaimSql()
The SQL that claims one wake outbox notification.
Returns
The SQL.
BuildWakeOutboxNotifySql() method
public string BuildWakeOutboxNotifySql()
The SQL that notifies the wake outbox channel.
Returns
The SQL.
PostgresWorkflowWakeOutbox class
public sealed class PostgresWorkflowWakeOutbox : IWorkflowWakeOutbox, IWorkflowWakeOutboxReceiver
The wake outbox, in PostgreSQL.
PostgresWorkflowWakeOutbox(PostgresWorkflowDatabase, PostgresWorkflowSqlBuilder) constructor
public PostgresWorkflowWakeOutbox(PostgresWorkflowDatabase database, PostgresWorkflowSqlBuilder sqlBuilder)
The wake outbox, in PostgreSQL.
EnqueueAsync(WorkflowSignalWakeNotification, CancellationToken) method
public Task EnqueueAsync(WorkflowSignalWakeNotification notification, CancellationToken cancellationToken = default)
Writes a wake notification to the outbox.
Parameters
notification: The notification.cancellationToken: Cancels the operation.
Returns
A task that completes when the notification is written.
ReceiveAsync(string, CancellationToken) method
public Task<IWorkflowWakeOutboxLease?> ReceiveAsync(string consumerName, CancellationToken cancellationToken = default)
Claims one wake notification of the outbox for a consumer.
Parameters
consumerName: The consumer.cancellationToken: Cancels the operation.
Returns
The lease of the notification, or null when there is none.
WorkflowTables class
public static class WorkflowTables
The fixed names of the Workflow PostgreSQL store. The schema script in StellaOps.Workflow.Persistence is the only DDL authority and creates exactly these tables in exactly this schema; nothing here is configurable. Every statement in this store names its table literally.
DeadLetters constant
public const string DeadLetters = "workflow.wf_signal_dead_letters"
The dead-lettered signals.
DefinitionAudit constant
public const string DefinitionAudit = "workflow.wf_definition_audit"
The definition activation audit.
Definitions constant
public const string Definitions = "workflow.wf_definitions"
The stored definitions.
FirstSeenWorkflows constant
public const string FirstSeenWorkflows = "workflow.wf_first_seen_workflows"
The first-seen ledger.
HostLocks constant
public const string HostLocks = "workflow.wf_host_locks"
The hosted job locks.
Instances constant
public const string Instances = "workflow.wf_instances"
The instance projections.
RuntimeStates constant
public const string RuntimeStates = "workflow.wf_runtime_states"
The runtime states.
Schema constant
public const string Schema = "workflow"
The schema the schema script creates.
SignalQueue constant
public const string SignalQueue = "workflow.wf_signal_queue"
The signal queue.
TaskEvents constant
public const string TaskEvents = "workflow.wf_task_events"
The task events.
Tasks constant
public const string Tasks = "workflow.wf_tasks"
The task projections.
WakeOutbox constant
public const string WakeOutbox = "workflow.wf_signal_wake_outbox"
The wake outbox.
