summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas Munro <tmunro@postgresql.org>2023-05-15 10:31:14 +1200
committerThomas Munro <tmunro@postgresql.org>2023-05-15 10:31:14 +1200
commit319bae9a8da66678d80d862440e54cebc7b1cc24 (patch)
tree95120095ef209574cc915734034571d957e28466 /doc
parent4d5105a684ba20bf6a98e6ae48224fe93382c040 (diff)
downloadpostgresql-319bae9a8da66678d80d862440e54cebc7b1cc24.tar.gz
Rename io_direct to debug_io_direct.
Give the new GUC introduced by d4e71df6 a name that is clearly not intended for mainstream use quite yet. Future proposals would drop the prefix only after adding infrastructure to make it efficient. Having the switch in the tree sooner is good because it might lead to new discoveries about the hazards awaiting us on a wide range of systems, but that name was too enticing and could lead to cross-version confusion in future, per complaints from Noah and Justin. Suggested-by: Noah Misch <noah@leadboat.com> Reviewed-by: Noah Misch <noah@leadboat.com> Reviewed-by: Justin Pryzby <pryzby@telsasoft.com> (the idea, not the patch) Reviewed-by: Tom Lane <tgl@sss.pgh.pa.us> (ditto) Discussion: https://postgr.es/m/20230430041106.GA2268796%40rfd.leadboat.com
Diffstat (limited to 'doc')
-rw-r--r--doc/src/sgml/config.sgml64
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 909a3f28c7..2073bafa1f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -11160,6 +11160,38 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</listitem>
</varlistentry>
+ <varlistentry id="guc-debug-io-direct" xreflabel="debug_io_direct">
+ <term><varname>debug_io_direct</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>debug_io_direct</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Ask the kernel to minimize caching effects for relation data and WAL
+ files using <literal>O_DIRECT</literal> (most Unix-like systems),
+ <literal>F_NOCACHE</literal> (macOS) or
+ <literal>FILE_FLAG_NO_BUFFERING</literal> (Windows).
+ </para>
+ <para>
+ May be set to an empty string (the default) to disable use of direct
+ I/O, or a comma-separated list of operations that should use direct I/O.
+ The valid options are <literal>data</literal> for
+ main data files, <literal>wal</literal> for WAL files, and
+ <literal>wal_init</literal> for WAL files when being initially
+ allocated.
+ </para>
+ <para>
+ Some operating systems and file systems do not support direct I/O, so
+ non-default settings may be rejected at startup or cause errors.
+ </para>
+ <para>
+ Currently this feature reduces performance, and is intended for
+ developer testing only.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry id="guc-debug-parallel-query" xreflabel="debug_parallel_query">
<term><varname>debug_parallel_query</varname> (<type>enum</type>)
<indexterm>
@@ -11221,38 +11253,6 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</listitem>
</varlistentry>
- <varlistentry id="guc-io-direct" xreflabel="io_direct">
- <term><varname>io_direct</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>io_direct</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Ask the kernel to minimize caching effects for relation data and WAL
- files using <literal>O_DIRECT</literal> (most Unix-like systems),
- <literal>F_NOCACHE</literal> (macOS) or
- <literal>FILE_FLAG_NO_BUFFERING</literal> (Windows).
- </para>
- <para>
- May be set to an empty string (the default) to disable use of direct
- I/O, or a comma-separated list of operations that should use direct I/O.
- The valid options are <literal>data</literal> for
- main data files, <literal>wal</literal> for WAL files, and
- <literal>wal_init</literal> for WAL files when being initially
- allocated.
- </para>
- <para>
- Some operating systems and file systems do not support direct I/O, so
- non-default settings may be rejected at startup or cause errors.
- </para>
- <para>
- Currently this feature reduces performance, and is intended for
- developer testing only.
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry id="guc-post-auth-delay" xreflabel="post_auth_delay">
<term><varname>post_auth_delay</varname> (<type>integer</type>)
<indexterm>