Would this addition to the documentation be ok ? I hope the english is not
too broken ..
From 8ea8c21413eeac8fbd37527e64820cbdca3a5d7a Mon Sep 17 00:00:00 2001
From: benoit <[email protected]>
Date: Mon, 22 Aug 2022 12:00:46 +0200
Subject: [PATCH] basic_archive parameter visibility doc patch
Module parameters are only visible from the pg_settings view once
the module is loaded. Since an archive module is loaded by the archiver
process, the parameters are never visible from the view. This patch
adds a note bout this in the basic_archive module and system views
documentation.
---
doc/src/sgml/basic-archive.sgml | 13 +++++++++++++
doc/src/sgml/system-views.sgml | 5 ++++-
2 files changed, 17 insertions(+), 1 deletion(-)
diff --git a/doc/src/sgml/basic-archive.sgml b/doc/src/sgml/basic-archive.sgml
index 0b650f17a8..65e70b795b 100644
--- a/doc/src/sgml/basic-archive.sgml
+++ b/doc/src/sgml/basic-archive.sgml
@@ -68,6 +68,19 @@ basic_archive.archive_directory = '/path/to/archive/directory'
to any archiving still in progress, but users should use extra caution when
doing so.
</para>
+
+ <para>
+ The archive module is loaded by the archiver process. Therefore, the
+ parameters defined in the module are not set outside this process and cannot
+ be seen from the <structname>pg_settings</structname> view or the
+ \dconfig meta-command.
+ These parameters values can be shown from the server's configuration
+ file(s) through the <structname>pg_file_settings</structname> view.
+ If you want to check the actual values applied by the archiver, you can
+ <command>LOAD</command> the module before reading
+ <structname>pg_settings</structname>. It's also possible to search
+ for the options directly with the <command>SHOW</command> command.
+ </para>
</sect2>
<sect2>
diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml
index 9728039e71..c8f0f3843c 100644
--- a/doc/src/sgml/system-views.sgml
+++ b/doc/src/sgml/system-views.sgml
@@ -3275,7 +3275,10 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<para>
This view does not display <link linkend="runtime-config-custom">customized options</link>
- until the extension module that defines them has been loaded.
+ until the extension module that defines them has been loaded. For instance,
+ since an archive module is loaded by the archiver process, its customized
+ options are not visible from other sessions, unless they load the module
+ themselves.
</para>
<para>
--
2.37.1
