diff options
author | Joe Conway <mail@joeconway.com> | 2016-02-17 09:12:06 -0800 |
---|---|---|
committer | Joe Conway <mail@joeconway.com> | 2016-02-17 09:12:06 -0800 |
commit | a5c43b886942e96ec5c745041f2d6a50c3205147 (patch) | |
tree | b7d1967286366131bc65d34457fb0ba91ec710b8 /doc/src | |
parent | f1f5ec1efafe74ca45e24e0bf3371b1d6985c8ee (diff) |
Add new system view, pg_config
Move and refactor the underlying code for the pg_config client
application to src/common in support of sharing it with a new
system information SRF called pg_config() which makes the same
information available via SQL. Additionally wrap the SRF with a
new system view, as called pg_config.
Patch by me with extensive input and review by Michael Paquier
and additional review by Alvaro Herrera.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/catalogs.sgml | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 412c8450ba4..d77e99988ff 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -7350,6 +7350,11 @@ </row> <row> + <entry><link linkend="view-pg-config"><structname>pg_config</structname></link></entry> + <entry>compile-time configuration parameters</entry> + </row> + + <row> <entry><link linkend="view-pg-cursors"><structname>pg_cursors</structname></link></entry> <entry>open cursors</entry> </row> @@ -7609,6 +7614,53 @@ </para> </sect1> + <sect1 id="view-pg-config"> + <title><structname>pg_config</structname></title> + + <indexterm zone="view-pg-config"> + <primary>pg_config</primary> + </indexterm> + + <para> + The view <structname>pg_config</structname> describes the + compile-time configuration parameters of the currently installed + version of <productname>PostgreSQL</>. It is intended, for example, to + be used by software packages that want to interface to + <productname>PostgreSQL</> to facilitate finding the required header + files and libraries. It provides the same basic information as the + <xref linkend="app-pgconfig"> <productname>PostgreSQL</> Client + Application. + </para> + + <table> + <title><structname>pg_config</> Columns</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Name</entry> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry><structfield>name</structfield></entry> + <entry><type>text</type></entry> + <entry>The parameter name</entry> + </row> + + <row> + <entry><structfield>setting</structfield></entry> + <entry><type>text</type></entry> + <entry>The parameter value</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + <sect1 id="view-pg-cursors"> <title><structname>pg_cursors</structname></title> |