begriffs open source - ai-pg/blob - full-docs/man3/dblink_disconnect.3

   1 '\" t
   2 .\"     Title: dblink_disconnect
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "DBLINK_DISCONNECT" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 dblink_disconnect \- closes a persistent connection to a remote database
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 dblink_disconnect() returns text
  36 dblink_disconnect(text connname) returns text
  37 .fi
  38 .SH "DESCRIPTION"
  39 .PP
  40 \fBdblink_disconnect()\fR
  41 closes a connection previously opened by
  42 \fBdblink_connect()\fR\&. The form with no arguments closes an unnamed connection\&.
  43 .SH "ARGUMENTS"
  44 .PP
  45 \fIconnname\fR
  46 .RS 4
  47 The name of a named connection to be closed\&.
  48 .RE
  49 .SH "RETURN VALUE"
  50 .PP
  51 Returns status, which is always
  52 OK
  53 (since any error causes the function to throw an error instead of returning)\&.
  54 .SH "EXAMPLES"
  55 .sp
  56 .if n \{\
  57 .RS 4
  58 .\}
  59 .nf
  60 SELECT dblink_disconnect();
  61  dblink_disconnect
  62 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
  63  OK
  64 (1 row)
  65
  66 SELECT dblink_disconnect(\*(Aqmyconn\*(Aq);
  67  dblink_disconnect
  68 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
  69  OK
  70 (1 row)
  71 .fi
  72 .if n \{\
  73 .RE
  74 .\}