Skip to content

Commit 24f0e39

Browse files
committed
docs: Fix omissions related to configurable TOAST compression.
Previously, the default_toast_compression GUC was not documented, and neither was pg_dump's new --no-toast-compression option. Justin Pryzby and Robert Haas Discussion: http://postgr.es/m/[email protected]
1 parent 226e2be commit 24f0e39

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

doc/src/sgml/config.sgml

+22
Original file line numberDiff line numberDiff line change
@@ -8108,6 +8108,28 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
81088108
</listitem>
81098109
</varlistentry>
81108110

8111+
<varlistentry id="guc-default-toast-compression" xreflabel="default_toast_compression">
8112+
<term><varname>default_toast_compression</varname> (<type>string</type>)
8113+
<indexterm>
8114+
<primary><varname>default_toast_compression</varname> configuration parameter</primary>
8115+
</indexterm>
8116+
</term>
8117+
<listitem>
8118+
<para>
8119+
This variable sets the default
8120+
<link linkend="storage-toast">TOAST</link>
8121+
compression method for columns of newly-created tables. The
8122+
<command>CREATE TABLE</command> statement can override this default
8123+
by specifying the <literal>COMPRESSION</literal> column option.
8124+
8125+
The supported compression methods are <literal>pglz</literal> and
8126+
(if configured at the time <productname>PostgreSQL</productname> was
8127+
built) <literal>lz4</literal>.
8128+
The default is <literal>pglz</literal>.
8129+
</para>
8130+
</listitem>
8131+
</varlistentry>
8132+
81118133
<varlistentry id="guc-default-tablespace" xreflabel="default_tablespace">
81128134
<term><varname>default_tablespace</varname> (<type>string</type>)
81138135
<indexterm>

doc/src/sgml/ref/pg_dump.sgml

+12
Original file line numberDiff line numberDiff line change
@@ -931,6 +931,18 @@ PostgreSQL documentation
931931
</listitem>
932932
</varlistentry>
933933

934+
<varlistentry>
935+
<term><option>--no-toast-compression</option></term>
936+
<listitem>
937+
<para>
938+
Do not output commands to set <acronym>TOAST</acronym> compression
939+
methods.
940+
With this option, all objects will be created using whichever
941+
compression method is the default during restore.
942+
</para>
943+
</listitem>
944+
</varlistentry>
945+
934946
<varlistentry>
935947
<term><option>--no-unlogged-table-data</option></term>
936948
<listitem>

0 commit comments

Comments
 (0)