summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/html/view-pg-file-settings.html
blob: 037f82e8d4874451ba8670a20c54208ce2b8581c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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>51.69. 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 V1.79.1" /><link rel="prev" href="view-pg-cursors.html" title="51.68. pg_cursors" /><link rel="next" href="view-pg-group.html" title="51.70. pg_group" /></head><body id="docContent" class="container-fluid col-10"><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">51.69. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_file_settings</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="view-pg-cursors.html" title="51.68. pg_cursors">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="catalogs.html" title="Chapter 51. System Catalogs">Up</a></td><th width="60%" align="center">Chapter 51. System Catalogs</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="view-pg-group.html" title="51.70. pg_group">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="VIEW-PG-FILE-SETTINGS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">51.69. <code class="structname">pg_file_settings</code></h2></div></div></div><a id="id-1.10.4.71.2" class="indexterm"></a><p>
   The view <code class="structname">pg_file_settings</code> provides a summary of
   the contents of the server's configuration file(s).  A row appears in
   this view for each <span class="quote"><span class="quote">name = value</span></span> 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 <span class="quote"><span class="quote">name = value</span></span> entry, such as syntax errors in the files.
  </p><p>
   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 <span class="emphasis"><em>current</em></span> contents of the
   files, not on what was last applied by the server.  (The
   <a class="link" href="view-pg-settings.html" title="51.85. pg_settings"><code class="structname">pg_settings</code></a>
   view is usually sufficient to determine that.)
  </p><p>
   By default, the <code class="structname">pg_file_settings</code> view can be read
   only by superusers.
  </p><div class="table" id="id-1.10.4.71.6"><p class="title"><strong>Table 51.70. <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">
       Column Type
      </p>
      <p>
       Description
      </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">sourcefile</code> <code class="type">text</code>
      </p>
      <p>
       Full path name of the configuration file
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">sourceline</code> <code class="type">int4</code>
      </p>
      <p>
       Line number within the configuration file where the entry appears
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">seqno</code> <code class="type">int4</code>
      </p>
      <p>
       Order in which the entries are processed (1..<em class="replaceable"><code>n</code></em>)
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">name</code> <code class="type">text</code>
      </p>
      <p>
       Configuration parameter name
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">setting</code> <code class="type">text</code>
      </p>
      <p>
       Value to be assigned to the parameter
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">applied</code> <code class="type">bool</code>
      </p>
      <p>
       True if the value can be applied successfully
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">error</code> <code class="type">text</code>
      </p>
      <p>
       If not null, an error message indicating why this entry could
       not be applied
      </p></td></tr></tbody></table></div></div><br class="table-break" /><p>
   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 <code class="structfield">applied</code> fields will read as false.
   In such a case there will be one or more rows with
   non-null <code class="structfield">error</code> 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 <code class="structfield">error</code> field.  Another way that
   an entry might have <code class="structfield">applied</code> = 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 <code class="structfield">error</code> field.
  </p><p>
   See <a class="xref" href="config-setting.html" title="19.1. Setting Parameters">Section 19.1</a> for more information about the various
   ways to change run-time parameters.
  </p></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="view-pg-cursors.html" title="51.68. pg_cursors">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="catalogs.html" title="Chapter 51. System Catalogs">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="view-pg-group.html" title="51.70. pg_group">Next</a></td></tr><tr><td width="40%" align="left" valign="top">51.68. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_cursors</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 51.70. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_group</code></td></tr></table></div></body></html>