aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/postgres-fdw.sgml23
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index 468724e94ef..627bb5ab5cc 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -779,7 +779,8 @@ OPTIONS (ADD password_required 'false');
<varlistentry>
<term><function>postgres_fdw_get_connections(
IN check_conn boolean DEFAULT false, OUT server_name text,
- OUT valid boolean, OUT used_in_xact boolean, OUT closed boolean)
+ OUT user_name text, OUT valid boolean, OUT used_in_xact boolean,
+ OUT closed boolean)
returns setof record</function></term>
<listitem>
<para>
@@ -806,10 +807,12 @@ OPTIONS (ADD password_required 'false');
<para>
Example usage of the function:
<screen>
- server_name | valid | used_in_xact | closed
--------------+-------+--------------+--------
- loopback1 | t | t |
- loopback2 | f | t |
+postgres=# SELECT * FROM postgres_fdw_get_connections(true);
+ server_name | user_name | valid | used_in_xact | closed
+-------------+-----------+-------+--------------+--------
+ loopback1 | postgres | t | t | f
+ loopback2 | public | t | t | f
+ loopback3 | | f | t | f
</screen>
The output columns are described in
<xref linkend="postgres-fdw-get-connections-columns"/>.
@@ -837,6 +840,16 @@ OPTIONS (ADD password_required 'false');
</entry>
</row>
<row>
+ <entry><structfield>user_name</structfield></entry>
+ <entry><type>text</type></entry>
+ <entry>
+ Name of the local user mapped to the foreign server of this
+ connection, or <literal>public</literal> if a public mapping is used.
+ If the user mapping is dropped but the connection remains open
+ (i.e., marked as invalid), this will be <literal>NULL</literal>.
+ </entry>
+ </row>
+ <row>
<entry><structfield>valid</structfield></entry>
<entry><type>boolean</type></entry>
<entry>