Our open-source projects, here for you!

Portugal

wfe-postgres (1.0.0)

Published 2026-03-26 01:02:46 +00:00 by siennathesane

Set up this registry in the Cargo configuration file (for example ~/.cargo/config.toml):

[registry]
default = "gitea"

[registries.gitea]
index = "sparse+" # Sparse index
# index = "" # Git

[net]
git-fetch-with-cli = true

To install the package using Cargo, run the following command:

cargo add wfe-postgres@1.0.0

For more information on the Cargo registry, see the documentation.

PostgreSQL persistence provider for WFE

wfe-postgres

PostgreSQL persistence provider for the WFE workflow engine.

What it does

Implements the full PersistenceProvider trait backed by PostgreSQL via sqlx. All workflow data, events, subscriptions, and scheduled commands live in a dedicated wfc schema. Uses JSONB for structured data (execution pointer children, scope, extension attributes) and TIMESTAMPTZ for timestamps. Schema and indexes are created automatically via ensure_store_exists.

Quick start

use wfe_postgres::PostgresPersistenceProvider;

let provider = PostgresPersistenceProvider::new(
    "postgres://wfe:wfe@localhost:5433/wfe_test"
).await?;

// Create schema and tables (idempotent)
provider.ensure_store_exists().await?;

Wire it into the WFE host:

let host = WorkflowHost::new(provider);

API

Type	Trait
`PostgresPersistenceProvider`	`PersistenceProvider`, `WorkflowRepository`, `EventRepository`, `SubscriptionRepository`, `ScheduledCommandRepository`

Additional methods:

truncate_all() -- truncates all tables with CASCADE, useful for test cleanup

Configuration

Connection string follows the standard PostgreSQL URI format:

postgres://user:password@host:port/database

The pool is configured with up to 10 connections. All tables are created under the wfc schema.

Schema

Tables created in wfc:

Table	Purpose
`wfc.workflows`	Workflow instances. `data` is JSONB, timestamps are TIMESTAMPTZ.
`wfc.execution_pointers`	Step state. `children`, `scope`, `extension_attributes` are JSONB. References `wfc.workflows(id)`.
`wfc.events`	Published events. `event_data` is JSONB.
`wfc.event_subscriptions`	Active subscriptions with CAS-style external token locking.
`wfc.scheduled_commands`	Deferred commands. Unique on `(command_name, data)` with upsert semantics.
`wfc.execution_errors`	Error log with auto-incrementing serial primary key.

Indexes are created on next_execution, status, (event_name, event_key), is_processed, event_time, workflow_id, and execute_time.

Testing

Requires a running PostgreSQL instance. Use the project docker-compose:

docker compose up -d postgres
cargo test -p wfe-postgres

Default test connection string: postgres://wfe:wfe@localhost:5433/wfe_test

License

MIT

ID	Version
async-trait	^0.1
chrono	^0.4
serde	^1
serde_json	^1
sqlx	^0.8
thiserror	^2
tokio	^1
tracing	^0.1
uuid	^1
wfe-core	^1.0.0
pretty_assertions	^1
rstest	^0.23
tokio	^1
wfe-core	^1.0.0

Details

Cargo

2026-03-26 01:02:46 +00:00

Project Site

Repository Site

MIT

23 KiB

Assets (1)

wfe-postgres-1.0.0.crate 23 KiB

Versions (2) View all

1.4.0

2026-03-27

1.0.0

2026-03-26