mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-08-23 23:37:19 +02:00
Doc: improve description of pgbench script weights.
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
This commit is contained in:
parent
21b2ee6ee3
commit
14c6afbbb3
@ -346,15 +346,19 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
|
|||||||
<term><option>--builtin</option>=<replaceable>scriptname[@weight]</replaceable></term>
|
<term><option>--builtin</option>=<replaceable>scriptname[@weight]</replaceable></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Add the specified built-in script to the list of executed scripts.
|
Add the specified built-in script to the list of scripts to be executed.
|
||||||
An optional integer weight after <literal>@</literal> allows to adjust the
|
|
||||||
probability of drawing the script. If not specified, it is set to 1.
|
|
||||||
Available built-in scripts are: <literal>tpcb-like</literal>,
|
Available built-in scripts are: <literal>tpcb-like</literal>,
|
||||||
<literal>simple-update</literal> and <literal>select-only</literal>.
|
<literal>simple-update</literal> and <literal>select-only</literal>.
|
||||||
Unambiguous prefixes of built-in names are accepted.
|
Unambiguous prefixes of built-in names are accepted.
|
||||||
With special name <literal>list</literal>, show the list of built-in scripts
|
With the special name <literal>list</literal>, show the list of built-in scripts
|
||||||
and exit immediately.
|
and exit immediately.
|
||||||
</para>
|
</para>
|
||||||
|
<para>
|
||||||
|
Optionally, write an integer weight after <literal>@</literal> to
|
||||||
|
adjust the probability of selecting this script versus other ones.
|
||||||
|
The default weight is 1.
|
||||||
|
See below for details.
|
||||||
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -408,10 +412,16 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
|
|||||||
<term><option>--file=</option><replaceable>filename[@weight]</replaceable></term>
|
<term><option>--file=</option><replaceable>filename[@weight]</replaceable></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Add a transaction script read from <replaceable>filename</replaceable> to
|
Add a transaction script read from <replaceable>filename</replaceable>
|
||||||
the list of executed scripts.
|
to the list of scripts to be executed.
|
||||||
An optional integer weight after <literal>@</literal> allows to adjust the
|
</para>
|
||||||
probability of drawing the test.
|
<para>
|
||||||
|
Optionally, write an integer weight after <literal>@</literal> 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 <literal>@</literal>
|
||||||
|
character, append a weight so that there is no ambiguity, for
|
||||||
|
example <literal>filen@me@1</literal>.)
|
||||||
See below for details.
|
See below for details.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
@ -816,10 +826,10 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
|
|||||||
<para>
|
<para>
|
||||||
<application>pgbench</application> executes test scripts chosen randomly
|
<application>pgbench</application> executes test scripts chosen randomly
|
||||||
from a specified list.
|
from a specified list.
|
||||||
They include built-in scripts with <option>-b</option> and
|
The scripts may include built-in scripts specified with <option>-b</option>
|
||||||
user-provided custom scripts with <option>-f</option>.
|
and user-provided scripts specified with <option>-f</option>.
|
||||||
Each script may be given a relative weight specified after a
|
Each script may be given a relative weight specified after an
|
||||||
<literal>@</literal> so as to change its drawing probability.
|
<literal>@</literal> so as to change its selection probability.
|
||||||
The default weight is <literal>1</literal>.
|
The default weight is <literal>1</literal>.
|
||||||
Scripts with a weight of <literal>0</literal> are ignored.
|
Scripts with a weight of <literal>0</literal> are ignored.
|
||||||
</para>
|
</para>
|
||||||
|
Loading…
Reference in New Issue
Block a user