aboutsummaryrefslogtreecommitdiff
path: root/contrib/dblink/doc/connection
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/dblink/doc/connection')
-rw-r--r--contrib/dblink/doc/connection47
1 files changed, 47 insertions, 0 deletions
diff --git a/contrib/dblink/doc/connection b/contrib/dblink/doc/connection
index c3ce776fbcc..b06d74b6db5 100644
--- a/contrib/dblink/doc/connection
+++ b/contrib/dblink/doc/connection
@@ -26,6 +26,12 @@ Outputs
Returns status = "OK"
+Notes
+
+ Only superusers may use dblink_connect to create non-password
+ authenticated connections. If non-superusers need this capability,
+ use dblink_connect_u instead.
+
Example usage
select dblink_connect('dbname=postgres');
@@ -43,6 +49,47 @@ select dblink_connect('myconn','dbname=postgres');
==================================================================
Name
+dblink_connect_u -- Opens a persistent connection to a remote database
+
+Synopsis
+
+dblink_connect_u(text connstr)
+dblink_connect_u(text connname, text connstr)
+
+Inputs
+
+ connname
+ if 2 arguments are given, the first is used as a name for a persistent
+ connection
+
+ connstr
+
+ standard libpq format connection string,
+ e.g. "hostaddr=127.0.0.1 port=5432 dbname=mydb user=postgres password=mypasswd"
+
+ if only one argument is given, the connection is unnamed; only one unnamed
+ connection can exist at a time
+
+Outputs
+
+ Returns status = "OK"
+
+Notes
+
+ With dblink_connect_u, a non-superuser may connect to any database server
+ using any authentication method. If the authentication method specified
+ for a particular user does not require a password, impersonation and
+ therefore escalation of privileges may occur. For this reason,
+ dblink_connect_u is initially installed with all privileges revoked from
+ public. Privilege to these functions should be granted with care.
+
+Example usage
+
+
+
+==================================================================
+Name
+
dblink_disconnect -- Closes a persistent connection to a remote database
Synopsis