Skip to content

Commit 85a4233

Browse files
committed
docs: release v0.7.4 with portable setup and accurate workload guides
Remove deployment-specific defaults and observations from public guidance. Require explicit source-sync destinations and resolve pg-stand from the active Python environment. Document the active HTAP and IMDb query sets and index the source synchronization guide. Validation: 457 tests passed on Python 3.10 and 3.12; Ruff, wheel/sdist, 27 packaged guides, and fresh-wheel CLI smoke checks passed.
1 parent b30773e commit 85a4233

5 files changed

Lines changed: 13 additions & 8 deletions

File tree

‎doc/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ initializer documentation, and packaged profile and JOIN READMEs.
1818
| [SSH transport](ssh_mode_usage.md) | PostgreSQL runs on a remote host reached through SSH |
1919
| [Managed PostgreSQL](managed_mode_usage.md) | SQL-only access to a pre-created benchmark database |
2020
| [Workload configuration](workload_description.md) | You are defining the init command, measured command, and iteration axis |
21+
| [Source synchronization](sidecar-source-workflow.md) | You are developing from a checkout and updating a separate load-generator host |
2122
| [Reports and comparisons](logic_building_and_comparing_reports.md) | You are consuming JSON/HTML artifacts or joining benchmark runs |
2223
| [`pg_play` integration](pg_play-integration.md) | You are invoking the versioned machine contract from an orchestrator |
2324

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "pg-perf-bench"
7-
version = "0.7.3"
7+
version = "0.7.4"
88
description = "Reproducible PostgreSQL TPS benchmarks with environment evidence and report comparison"
99
readme = "README.md"
1010
requires-python = ">=3.10"

‎src/pg_perf_bench/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""PostgreSQL performance benchmark and evidence collector."""
22

3-
__version__ = '0.7.3'
3+
__version__ = '0.7.4'

‎src/pg_perf_bench/workload_profiles/imdb/sql/planner/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ implementation or a realistic traffic mix.
2727

2828
## Choosing a workload
2929

30-
Use the 14 scripts in the parent `sql` directory for the supported catalog workload.
31-
They return coherent records or explicitly defined aggregate groups and are
30+
Use the 11 active scripts in the parent `sql` directory for the default catalog workload;
31+
three other scripts are disabled and excluded from the default command.
32+
The active scripts return coherent records or explicitly defined aggregate groups and are
3233
validated against an independent source-record oracle. See the
3334
[profile README](../../README.md) for data contracts, weights and timeout policy.
3435

‎src/pg_perf_bench/workload_profiles/pagila-htap/README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ current logical workload day. All generated receipt dates are reachable; the upp
77
window bound advances with `benchmark_now()` without rewriting a shared counter. All period boundaries
88
and daily groups use UTC, independently of the server's `TimeZone`.
99

10-
The seven dashboard queries return cashier revenue, category revenue, catalog
11-
counts for the selected category, daily rentals of that category, its most-rented
12-
titles, daily cash receipts, and loyalty candidates. Revenue is attributed to
10+
Four dashboard queries are active by default: category catalog counts (query 3),
11+
most-rented titles (5), daily cash receipts (6), and loyalty candidates (7).
12+
Cashier revenue (1), category revenue (2), and daily rentals/returns (4) remain
13+
in block comments pending optimization and are not executed. To include one,
14+
uncomment its block in a copied custom profile and use the same SQL on all
15+
compared environments. Revenue is attributed to
1316
payment dates; `paid_rentals` counts distinct rentals within a payment day.
1417
Rentals are counted directly from `rental`, so extra payments do not inflate them.
1518
Store attribution follows the issuing cashier's store, not a copy's current
@@ -27,7 +30,7 @@ are byte-identical to `pagila`. Weights remain `01_select` 50, `02_insert` 25,
2730
`03_update` 20, `04_delete` 5, `05_reporting` 5. Reporting probability is 5/105
2831
(about 4.76%); its fraction of elapsed client time depends on query latency.
2932
Clients share this mix, so the profile does not reserve a separate analyst pool.
30-
The seven statements run in a read-only transaction at the connection's isolation
33+
The four active statements run in a read-only transaction at the connection's isolation
3134
level; default READ COMMITTED does not promise a single cross-statement snapshot.
3235

3336
The shared [data and time contract](../pagila/README.md#data-and-time-contract)

0 commit comments

Comments
 (0)