mirror of
https://github.com/postgres/postgres.git
synced 2025-07-28 23:42:10 +03:00
Improve design and implementation of pg_file_settings view.
As first committed, this view reported on the file contents as they were at the last SIGHUP event. That's not as useful as reporting on the current contents, and what's more, it didn't work right on Windows unless the current session had serviced at least one SIGHUP. Therefore, arrange to re-read the files when pg_show_all_settings() is called. This requires only minor refactoring so that we can pass changeVal = false to set_config_option() so that it won't actually apply any changes locally. In addition, add error reporting so that errors that would prevent the configuration files from being loaded, or would prevent individual settings from being applied, are visible directly in the view. This makes the view usable for pre-testing whether edits made in the config files will have the desired effect, before one actually issues a SIGHUP. I also added an "applied" column so that it's easy to identify entries that are superseded by later entries; this was the main use-case for the original design, but it seemed unnecessarily hard to use for that. Also fix a 9.4.1 regression that allowed multiple entries for a PGC_POSTMASTER variable to cause bogus complaints in the postmaster log. (The issue here was that commitbf007a27ac
unintentionally reverted3e3f65973a
, which suppressed any duplicate entries within ParseConfigFp. However, since the original coding of the pg_file_settings view depended on such suppression *not* happening, we couldn't have fixed this issue now without first doing something with pg_file_settings. Now we suppress duplicates by marking them "ignored" within ProcessConfigFileInternal, which doesn't hide them in the view.) Lesser changes include: Drive the view directly off the ConfigVariable list, instead of making a basically-equivalent second copy of the data. There's no longer any need to hang onto the data permanently, anyway. Convert show_all_file_settings() to do its work in one call and return a tuplestore; this avoids risks associated with assuming that the GUC state will hold still over the course of query execution. (I think there were probably latent bugs here, though you might need something like a cursor on the view to expose them.) Arrange to run SIGHUP processing in a short-lived memory context, to forestall process-lifespan memory leaks. (There is one known leak in this code, in ProcessConfigDirectory; it seems minor enough to not be worth back-patching a specific fix for.) Remove mistaken assignment to ConfigFileLineno that caused line counting after an include_dir directive to be completely wrong. Add missed failure check in AlterSystemSetConfigFile(). We don't really expect ParseConfigFp() to fail, but that's not an excuse for not checking.
This commit is contained in:
@ -7626,7 +7626,7 @@
|
||||
|
||||
<row>
|
||||
<entry><link linkend="view-pg-file-settings"><structname>pg_file_settings</structname></link></entry>
|
||||
<entry>file location of parameter settings</entry>
|
||||
<entry>summary of configuration file contents</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
@ -8007,13 +8007,26 @@
|
||||
</indexterm>
|
||||
|
||||
<para>
|
||||
The view <structname>pg_file_settings</structname> provides the file
|
||||
name, line number and value of all parameters which are set through
|
||||
configuration files.
|
||||
In contrast to <structname>pg_settings</structname>, a row is provided for
|
||||
each occurrence of the parameter across all configuration files. This is helpful
|
||||
for discovering why one value may have been used in preference to another
|
||||
when the parameters were loaded.
|
||||
The view <structname>pg_file_settings</structname> provides a summary of
|
||||
the contents of the server's configuration file(s). A row appears in
|
||||
this view for each <quote>name = value</> entry appearing in the files,
|
||||
with annotations indicating whether the value could be applied
|
||||
successfully. Additional row(s) may appear for problems not linked to
|
||||
a <quote>name = value</> entry, such as syntax errors in the files.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This view is helpful for checking whether planned changes in the
|
||||
configuration files will work, or for diagnosing a previous failure.
|
||||
Note that this view reports on the <emphasis>current</> contents of the
|
||||
files, not on what was last applied by the server. (The
|
||||
<link linkend="view-pg-settings"><structname>pg_settings</structname></link>
|
||||
view is usually sufficient to determine that.)
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The <structname>pg_file_settings</structname> view can be read only by
|
||||
superusers.
|
||||
</para>
|
||||
|
||||
<table>
|
||||
@ -8031,43 +8044,64 @@
|
||||
<row>
|
||||
<entry><structfield>sourcefile</structfield></entry>
|
||||
<entry><structfield>text</structfield></entry>
|
||||
<entry>Path to and name of the configration file</entry>
|
||||
<entry>Full pathname of the configuration file</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>sourceline</structfield></entry>
|
||||
<entry><structfield>integer</structfield></entry>
|
||||
<entry>
|
||||
Line number within the configuration file where the value was set
|
||||
Line number within the configuration file where the entry appears
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>seqno</structfield></entry>
|
||||
<entry><structfield>integer</structfield></entry>
|
||||
<entry>Order in which the setting was loaded</entry>
|
||||
<entry>Order in which the entries are processed (1..<replaceable>n</>)</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>name</structfield></entry>
|
||||
<entry><structfield>text</structfield></entry>
|
||||
<entry>Run-time configuration parameter name</entry>
|
||||
<entry>Configuration parameter name</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>setting</structfield></entry>
|
||||
<entry><structfield>text</structfield></entry>
|
||||
<entry>value of the parameter</entry>
|
||||
<entry>Value to be assigned to the parameter</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>applied</structfield></entry>
|
||||
<entry><structfield>boolean</structfield></entry>
|
||||
<entry>True if the value can be applied successfully</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><structfield>error</structfield></entry>
|
||||
<entry><structfield>text</structfield></entry>
|
||||
<entry>If not null, an error message indicating why this entry could
|
||||
not be applied</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
See <xref linkend="config-setting"> for more information about the various
|
||||
ways to change these parameters.
|
||||
If the configuration file contains syntax errors or invalid parameter
|
||||
names, the server will not attempt to apply any settings from it, and
|
||||
therefore all the <structfield>applied</> fields will read as false.
|
||||
In such a case there will be one or more rows with
|
||||
non-null <structfield>error</structfield> fields indicating the
|
||||
problem(s). Otherwise, individual settings will be applied if possible.
|
||||
If an individual setting cannot be applied (e.g., invalid value, or the
|
||||
setting cannot be changed after server start) it will have an appropriate
|
||||
message in the <structfield>error</structfield> field. Another way that
|
||||
an entry might have <structfield>applied</> = false is that it is
|
||||
overridden by a later entry for the same parameter name; this case is not
|
||||
considered an error so nothing appears in
|
||||
the <structfield>error</structfield> field.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The <structname>pg_file_settings</structname> view cannot be modified
|
||||
directly as it represents information, as read in at server start or
|
||||
reload time, about all parameter settings across all configuration files.
|
||||
See <xref linkend="config-setting"> for more information about the various
|
||||
ways to change run-time parameters.
|
||||
</para>
|
||||
|
||||
</sect1>
|
||||
|
@ -175,6 +175,14 @@ shared_buffers = 128MB
|
||||
effect in the same way. Settings in <filename>postgresql.auto.conf</>
|
||||
override those in <filename>postgresql.conf</>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The system view
|
||||
<link linkend="view-pg-file-settings"><structname>pg_file_settings</structname></link>
|
||||
can be helpful for pre-testing changes to the configuration file, or for
|
||||
diagnosing problems if a <systemitem>SIGHUP</> signal did not have the
|
||||
desired effects.
|
||||
</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="config-setting-sql-command-interaction">
|
||||
|
@ -6,8 +6,8 @@
|
||||
|
||||
<note>
|
||||
<title>Release Date</title>
|
||||
<para>AS OF 2015-06-01</para>
|
||||
<simpara>2015-XX-XX</simpara>
|
||||
<simpara>2015-??-??</simpara>
|
||||
<simpara>Current as of 2015-06-01</simpara>
|
||||
</note>
|
||||
|
||||
<sect2>
|
||||
@ -23,6 +23,7 @@
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
... to be filled in ...
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
@ -480,10 +481,10 @@
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
Add function and view <link
|
||||
linkend="view-pg-file-settings"><function>pg_file_settings</></>
|
||||
to show the source of <acronym>GUC</> values set in configuration
|
||||
files (Sawada Masahiko)
|
||||
Add system view <link
|
||||
linkend="view-pg-file-settings"><structname>pg_file_settings</></>
|
||||
to show the contents of the server's configuration files
|
||||
(Sawada Masahiko)
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
@ -503,7 +504,7 @@
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This removes the setting from <filename>postgresql.auto.conf</>.
|
||||
This command removes the setting from <filename>postgresql.auto.conf</>.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
|
Reference in New Issue
Block a user