begriffs open source - ai-pg/blob - full-docs/src/sgml/html/view-pg-file-settings.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>53.8. pg_file_settings</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="view-pg-cursors.html" title="53.7. pg_cursors" /><link rel="next" href="view-pg-group.html" title="53.9. pg_group" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">53.8. <code class="structname">pg_file_settings</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="view-pg-cursors.html" title="53.7. pg_cursors">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="views.html" title="Chapter 53. System Views">Up</a></td><th width="60%" align="center">Chapter 53. System Views</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="view-pg-group.html" title="53.9. pg_group">Next</a></td></tr></table><hr /></div><div class="sect1" id="VIEW-PG-FILE-SETTINGS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">53.8. <code class="structname">pg_file_settings</code> <a href="#VIEW-PG-FILE-SETTINGS" class="id_link">#</a></h2></div></div></div><a id="id-1.10.5.12.2" class="indexterm"></a><p>
   3    The view <code class="structname">pg_file_settings</code> provides a summary of
   4    the contents of the server's configuration file(s).  A row appears in
   5    this view for each <span class="quote">“<span class="quote">name = value</span>”</span> entry appearing in the files,
   6    with annotations indicating whether the value could be applied
   7    successfully.  Additional row(s) may appear for problems not linked to
   8    a <span class="quote">“<span class="quote">name = value</span>”</span> entry, such as syntax errors in the files.
   9   </p><p>
  10    This view is helpful for checking whether planned changes in the
  11    configuration files will work, or for diagnosing a previous failure.
  12    Note that this view reports on the <span class="emphasis"><em>current</em></span> contents of the
  13    files, not on what was last applied by the server.  (The
  14    <a class="link" href="view-pg-settings.html" title="53.25. pg_settings"><code class="structname">pg_settings</code></a>
  15    view is usually sufficient to determine that.)
  16   </p><p>
  17    By default, the <code class="structname">pg_file_settings</code> view can be read
  18    only by superusers.
  19   </p><div class="table" id="id-1.10.5.12.6"><p class="title"><strong>Table 53.8. <code class="structname">pg_file_settings</code> Columns</strong></p><div class="table-contents"><table class="table" summary="pg_file_settings Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">
  20        Column Type
  21       </p>
  22       <p>
  23        Description
  24       </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
  25        <code class="structfield">sourcefile</code> <code class="type">text</code>
  26       </p>
  27       <p>
  28        Full path name of the configuration file
  29       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  30        <code class="structfield">sourceline</code> <code class="type">int4</code>
  31       </p>
  32       <p>
  33        Line number within the configuration file where the entry appears
  34       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  35        <code class="structfield">seqno</code> <code class="type">int4</code>
  36       </p>
  37       <p>
  38        Order in which the entries are processed (1..<em class="replaceable"><code>n</code></em>)
  39       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  40        <code class="structfield">name</code> <code class="type">text</code>
  41       </p>
  42       <p>
  43        Configuration parameter name
  44       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  45        <code class="structfield">setting</code> <code class="type">text</code>
  46       </p>
  47       <p>
  48        Value to be assigned to the parameter
  49       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  50        <code class="structfield">applied</code> <code class="type">bool</code>
  51       </p>
  52       <p>
  53        True if the value can be applied successfully
  54       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  55        <code class="structfield">error</code> <code class="type">text</code>
  56       </p>
  57       <p>
  58        If not null, an error message indicating why this entry could
  59        not be applied
  60       </p></td></tr></tbody></table></div></div><br class="table-break" /><p>
  61    If the configuration file contains syntax errors or invalid parameter
  62    names, the server will not attempt to apply any settings from it, and
  63    therefore all the <code class="structfield">applied</code> fields will read as false.
  64    In such a case there will be one or more rows with
  65    non-null <code class="structfield">error</code> fields indicating the
  66    problem(s).  Otherwise, individual settings will be applied if possible.
  67    If an individual setting cannot be applied (e.g., invalid value, or the
  68    setting cannot be changed after server start) it will have an appropriate
  69    message in the <code class="structfield">error</code> field.  Another way that
  70    an entry might have <code class="structfield">applied</code> = false is that it is
  71    overridden by a later entry for the same parameter name; this case is not
  72    considered an error so nothing appears in
  73    the <code class="structfield">error</code> field.
  74   </p><p>
  75    See <a class="xref" href="config-setting.html" title="19.1. Setting Parameters">Section 19.1</a> for more information about the various
  76    ways to change run-time parameters.
  77   </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="view-pg-cursors.html" title="53.7. pg_cursors">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="views.html" title="Chapter 53. System Views">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="view-pg-group.html" title="53.9. pg_group">Next</a></td></tr><tr><td width="40%" align="left" valign="top">53.7. <code class="structname">pg_cursors</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 53.9. <code class="structname">pg_group</code></td></tr></table></div></body></html>