diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index b7463177d1..5ced63edbe 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -346,15 +346,19 @@ pgbench options d =scriptname[@weight] - Add the specified built-in script to the list of executed scripts. - An optional integer weight after @ allows to adjust the - probability of drawing the script. If not specified, it is set to 1. + Add the specified built-in script to the list of scripts to be executed. Available built-in scripts are: tpcb-like, simple-update and select-only. Unambiguous prefixes of built-in names are accepted. - With special name list, show the list of built-in scripts + With the special name list, show the list of built-in scripts and exit immediately. + + Optionally, write an integer weight after @ to + adjust the probability of selecting this script versus other ones. + The default weight is 1. + See below for details. + @@ -408,10 +412,16 @@ pgbench options d filename[@weight] - Add a transaction script read from filename to - the list of executed scripts. - An optional integer weight after @ allows to adjust the - probability of drawing the test. + Add a transaction script read from filename + to the list of scripts to be executed. + + + Optionally, write an integer weight after @ to + adjust the probability of selecting this script versus other ones. + The default weight is 1. + (To use a script file name that includes an @ + character, append a weight so that there is no ambiguity, for + example filen@me@1.) See below for details. @@ -816,10 +826,10 @@ pgbench options d pgbench executes test scripts chosen randomly from a specified list. - They include built-in scripts with and - user-provided custom scripts with . - Each script may be given a relative weight specified after a - @ so as to change its drawing probability. + The scripts may include built-in scripts specified with + and user-provided scripts specified with . + Each script may be given a relative weight specified after an + @ so as to change its selection probability. The default weight is 1. Scripts with a weight of 0 are ignored.