blob: bf303b313e6eeca27fd207e8d80f1f79021978b1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
'\" t
.\" Title: dblink_disconnect
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 16.3 Documentation
.\" Source: PostgreSQL 16.3
.\" Language: English
.\"
.TH "DBLINK_DISCONNECT" "3" "2024" "PostgreSQL 16.3" "PostgreSQL 16.3 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
.\}
|
