summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/dblink_disconnect.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man3/dblink_disconnect.3')
-rw-r--r--doc/src/sgml/man3/dblink_disconnect.374
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/src/sgml/man3/dblink_disconnect.3 b/doc/src/sgml/man3/dblink_disconnect.3
new file mode 100644
index 0000000..55a77c6
--- /dev/null
+++ b/doc/src/sgml/man3/dblink_disconnect.3
@@ -0,0 +1,74 @@
+'\" t
+.\" Title: dblink_disconnect
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.5 Documentation
+.\" Source: PostgreSQL 15.5
+.\" Language: English
+.\"
+.TH "DBLINK_DISCONNECT" "3" "2023" "PostgreSQL 15.5" "PostgreSQL 15.5 Documentation"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+dblink_disconnect \- closes a persistent connection to a remote database
+.SH "SYNOPSIS"
+.sp
+.nf
+dblink_disconnect() returns text
+dblink_disconnect(text connname) returns text
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBdblink_disconnect()\fR
+closes a connection previously opened by
+\fBdblink_connect()\fR\&. The form with no arguments closes an unnamed connection\&.
+.SH "ARGUMENTS"
+.PP
+\fIconnname\fR
+.RS 4
+The name of a named connection to be closed\&.
+.RE
+.SH "RETURN VALUE"
+.PP
+Returns status, which is always
+OK
+(since any error causes the function to throw an error instead of returning)\&.
+.SH "EXAMPLES"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+SELECT dblink_disconnect();
+ dblink_disconnect
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+ OK
+(1 row)
+
+SELECT dblink_disconnect(\*(Aqmyconn\*(Aq);
+ dblink_disconnect
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+ OK
+(1 row)
+.fi
+.if n \{\
+.RE
+.\}