Skip to content

Commit 242b2e9

Browse files
AbeOmorAbeOmor
authored
docs: standardize terminology to durable functions (#198)
1 parent 2e9d9f9 commit 242b2e9

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<img src="docs/website/lockup_arrow_dark.svg" alt="pg_durable logo" width="560" />
44

5-
## Durable SQL workflows for PostgreSQL — no extra infra.
5+
## Durable SQL functions for PostgreSQL — no extra infra.
66

77
Long-running, fault-tolerant functions defined entirely in SQL. Composable operators,
88
automatic checkpointing, crash-safe replay, and parallel execution. Built on Postgres —
@@ -201,7 +201,7 @@ pg_durable is a PostgreSQL extension (built with [pgrx](https://github.com/pgcen
201201
└────────────────────────────────────────────────────────────────────┘
202202
```
203203

204-
If you'd rather author durable workflows in Rust, Python, or Node while still persisting state in PostgreSQL, you can use duroxide and duroxide-pg directly from your host language — pg_durable is what you'd build on top of that pair when you'd prefer authoring in SQL.
204+
If you'd rather author durable functions in Rust, Python, or Node while still persisting state in PostgreSQL, you can use duroxide and duroxide-pg directly from your host language — pg_durable is what you'd build on top of that pair when you'd prefer authoring in SQL.
205205

206206
## Status
207207

‎docs/pg_durable_spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pg_durable
22

3-
**SQL-native durable workflows for PostgreSQL**
3+
**SQL-native durable functions for PostgreSQL**
44

55
---
66

‎docs/website/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>pg_durable — Durable SQL workflows for PostgreSQL</title>
6+
<title>pg_durable — Durable SQL functions for PostgreSQL</title>
77
<meta
88
name="description"
9-
content="Build durable, fault-tolerant workflows in pure SQL. Retries, scheduling, parallel execution, and conditional branching — all inside PostgreSQL."
9+
content="Build durable, fault-tolerant functions in pure SQL. Retries, scheduling, parallel execution, and conditional branching — all inside PostgreSQL."
1010
/>
1111
<link rel="icon" type="image/svg+xml" href="favicon.svg" />
1212
<link rel="mask-icon" href="favicon.svg" color="#3d86c6" />
@@ -58,7 +58,7 @@
5858
<section class="hero">
5959
<div class="container hero-inner">
6060
<span class="hero-eyebrow">Open-source · durable functions for Postgres</span>
61-
<h1>Durable, crash-proof workflows<br />built into <span class="accent">Postgres</span></h1>
61+
<h1>Durable, crash-proof functions<br />built into <span class="accent">Postgres</span></h1>
6262
<p class="subtitle">
6363
Orchestrate retries, scheduling, parallel fan-out, and conditional branching with a tiny SQL DSL.
6464
Built on Postgres&nbsp;+ a background worker — no containers, no external services, just Postgres.
@@ -813,7 +813,7 @@ <h2>pg_durable, fully managed on <span class="accent-azure">Azure HorizonDB</spa
813813
</div>
814814
<p class="horizon-lede">
815815
Azure HorizonDB is Microsoft's new PostgreSQL cloud service — engineered for performance and built
816-
with pg_durable inside. Keep the durable workflows you write here, and add enterprise scale,
816+
with pg_durable inside. Keep the durable functions you write here, and add enterprise scale,
817817
security, and AI without managing a single server.
818818
</p>
819819
<div class="horizon-grid">

‎examples/operational-scenarios/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ psql -h <host> -U <user> -d <database>
3131

3232
> ⚠️ **These scripts are illustrative.** Two things to keep in mind before running the `pg_durable` versions verbatim:
3333
>
34-
> - **`VACUUM` cannot run inside a transaction block.** The durable worker executes each node inside a transaction, so a bare `VACUUM` step will error at runtime. Treat the `VACUUM (...)` nodes as illustrative — in production, trigger vacuum from a separate maintenance connection (e.g. an out-of-band `psql` session or a scheduled job) once the durable workflow signals it's safe.
34+
> - **`VACUUM` cannot run inside a transaction block.** The durable worker executes each node inside a transaction, so a bare `VACUUM` step will error at runtime. Treat the `VACUUM (...)` nodes as illustrative — in production, trigger vacuum from a separate maintenance connection (e.g. an out-of-band `psql` session or a scheduled job) once the durable function signals it's safe.
3535
> - **Approval steps pause the workflow.** Each remediation branch uses `df.wait_for_signal('approve-…')`. In these demo scripts a short `timeout_seconds` is supplied so the workflow auto-continues instead of hanging. In production, omit the timeout and have an operator approve explicitly with `df.signal('<instance_id>', 'approve-…')`.
3636
3737
## Blocker Identification Reference

0 commit comments

Comments
 (0)