summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Korotkov <akorotkov@postgresql.org>2022-07-20 15:44:44 +0300
committerAlexander Korotkov <akorotkov@postgresql.org>2022-07-20 15:49:37 +0300
commitf77ff083350eb5a2625a4dbfca61d15b66c4918b (patch)
tree3d91b6397c39d46680d4474621c90a0cb6d42f88
parentbcedd8f5fce0b69970cf0cee7bca560833d05869 (diff)
Document the ability to specify TableAM for pgbench
Upcoming custom Table Access Methods (TableAM) need benchmarking. Despite pgbench doesn't have an explicit option for TableAM specification, one can specify it using PGOPTION environmental variable. The present commit documents this way to specify TableAM for pgbench. Discussion: https://postgr.es/m/CAC77N6ih%3DLbhZQXV76grEsaVQkBL464Y2Foqq9o%3Df4UBfEOfEQ%40mail.gmail.com Author: Michel Pelletier, Alexander Korotkov Reviewed-by: Justin Pryzby, Mason Sharp, Michael Paquier
-rw-r--r--doc/src/sgml/config.sgml2
-rw-r--r--doc/src/sgml/ref/pgbench.sgml16
2 files changed, 17 insertions, 1 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 37fd80388c0..e2d728e0c4f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -317,7 +317,7 @@ UPDATE pg_settings SET setting = reset_val WHERE name = 'configuration_parameter
</sect2>
- <sect2>
+ <sect2 id="config-setting-shell">
<title>Parameter Interaction via the Shell</title>
<para>
diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml
index 2acf55c2acd..1a1be489e7e 100644
--- a/doc/src/sgml/ref/pgbench.sgml
+++ b/doc/src/sgml/ref/pgbench.sgml
@@ -2888,6 +2888,22 @@ statement latencies in milliseconds, failures and retries:
</refsect2>
<refsect2>
+ <title>Table Access Methods</title>
+
+ <para>
+ You may specify the <link linkend="tableam">Table Access Method</link>
+ for the pgbench tables. The environment variable <envar>PGOPTIONS</envar>
+ specifies database configuration options that are passed to PostgreSQL via
+ the command line (See <xref linkend="config-setting-shell"/>).
+ For example, a hypothetical default Table Access Method for the tables that
+ pgbench creates called <literal>wuzza</literal> can be specified with:
+<programlisting>
+PGOPTIONS='-c default_table_access_method=wuzza'
+</programlisting>
+ </para>
+ </refsect2>
+
+ <refsect2>
<title>Good Practices</title>
<para>