Skip to content

README.md

Latest commit

 

History

History
47 lines (37 loc) · 2.35 KB

README.md

File metadata and controls

47 lines (37 loc) · 2.35 KB
Raw

pg_perf_bench documentation

The root README describes the utility, its safety contract, and the main CLI workflows. This directory contains focused operational guides.

All guides ship in both the wheel and source distribution. After installation, this index is pg_perf_bench/docs/doc/README.md; see Installed documentation for the command that locates the installed README. Relative links connect the guides, common initializer documentation, and packaged profile and JOIN READMEs.

Guides

Document Use it when
Local transport PostgreSQL and the workload generator run on the same host
Docker transport PostgreSQL runs in an existing container
SSH transport PostgreSQL runs on a remote host reached through SSH
Managed PostgreSQL SQL-only access to a pre-created benchmark database
Workload configuration You are defining the init command, measured command, and iteration axis
Source synchronization You are developing from a checkout and updating a separate load-generator host
Reports and comparisons You are consuming JSON/HTML artifacts or joining benchmark runs
pg_play integration You are invoking the versioned machine contract from an orchestrator

Reading order

For a new benchmark:

  1. Read the safety contract in the root README.
  2. Select and configure one transport.
  3. Define a workload and verify all placeholders with plan.
  4. Run against a disposable database.
  5. Validate and compare the resulting artifacts.

Conventions

  • Examples use PostgreSQL 18 paths; adjust them for the target installation.
  • PGPASSWORD=secret is illustrative. Use an appropriate secret-injection mechanism and never commit real credentials.
  • pg_perf_bench_test always means a dedicated disposable database.
  • The workload-generator host is the machine running pg-perf-bench, pgbench, and psql.
  • The target host is the machine or container whose PostgreSQL instance is controlled and inspected.

All documentation is text-only. Generated benchmark HTML may still contain interactive charts rendered by the embedded ECharts library.