begriffs open source - ai-pg/blob - full-docs/src/sgml/man3/dblink_error_message.3

   1 '\" t
   2 .\"     Title: dblink_error_message
   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_ERROR_MESSAGE" "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_error_message \- gets last error message on the named connection
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 dblink_error_message(text connname) returns text
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBdblink_error_message\fR
  40 fetches the most recent remote error message for a given connection\&.
  41 .SH "ARGUMENTS"
  42 .PP
  43 \fIconnname\fR
  44 .RS 4
  45 Name of the connection to use\&.
  46 .RE
  47 .SH "RETURN VALUE"
  48 .PP
  49 Returns last error message, or
  50 OK
  51 if there has been no error in this connection\&.
  52 .SH "NOTES"
  53 .PP
  54 When asynchronous queries are initiated by
  55 \fBdblink_send_query\fR, the error message associated with the connection might not get updated until the server\*(Aqs response message is consumed\&. This typically means that
  56 \fBdblink_is_busy\fR
  57 or
  58 \fBdblink_get_result\fR
  59 should be called prior to
  60 \fBdblink_error_message\fR, so that any error generated by the asynchronous query will be visible\&.
  61 .SH "EXAMPLES"
  62 .sp
  63 .if n \{\
  64 .RS 4
  65 .\}
  66 .nf
  67 SELECT dblink_error_message(\*(Aqdtest1\*(Aq);
  68 .fi
  69 .if n \{\
  70 .RE
  71 .\}