Doc: improve description of pgbench script weights.
authorTom Lane
Sun, 20 Dec 2020 18:37:25 +0000 (13:37 -0500)
committerTom Lane
Sun, 20 Dec 2020 18:37:25 +0000 (13:37 -0500)
Point out the workaround to be used if you want to write a script
file name that includes "@".  Clean up the text a little.

Fabien Coelho, additional wordsmithing by me

Discussion: https://postgr.es/m/1c4e81550d214741827a03292222db8d@G08CNEXMBPEKD06.g08.fujitsu.local

doc/src/sgml/ref/pgbench.sgml

index 7180fedd65850226cc5872cd44ea2b1b28a8dc3b..b03d0cc50f5b54593f400b2991bdbc9f1ee506a9 100644 (file)
@@ -396,15 +396,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.
+       
       
      
 
@@ -457,10 +461,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.
        
       
@@ -925,10 +935,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.