summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFujii Masao2021-01-18 15:56:10 +0000
committerFujii Masao2021-01-19 06:04:58 +0000
commitee79a548e746da9a99df0cac70a3ddc095f2829a (patch)
treed83c68223c67b00444c38ad4a4f47549c305062d
parented43677e20369040ca4e50c698010c39d5ac0f47 (diff)
doc: Add note about the server name of postgres_fdw_get_connections() returns.
Previously the document didn't mention the case where postgres_fdw_get_connections() returns NULL in server_name column. Users might be confused about why NULL was returned. This commit adds the note that, in postgres_fdw_get_connections(), the server name of an invalid connection will be NULL if the server is dropped. Suggested-by: Zhijie Hou Author: Bharath Rupireddy Reviewed-by: Zhijie Hou, Fujii Masao Discussion: https://postgr.es/m/e7ddd14e96444fce88e47a709c196537@G08CNEXMBPEKD05.g08.fujitsu.local
-rw-r--r--doc/src/sgml/postgres-fdw.sgml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index 6a91926da83..9adc8d12a9d 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -493,7 +493,9 @@ OPTIONS (ADD password_required 'false');
each connection is valid or not. <literal>false</literal> is returned
if the foreign server connection is used in the current local
transaction but its foreign server or user mapping is changed or
- dropped, and then such invalid connection will be closed at
+ dropped (Note that server name of an invalid connection will be
+ <literal>NULL</literal> if the server is dropped),
+ and then such invalid connection will be closed at
the end of that transaction. <literal>true</literal> is returned
otherwise. If there are no open connections, no record is returned.
Example usage of the function: