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

   1 '\" t
   2 .\"     Title: dblink_is_busy
   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_IS_BUSY" "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_is_busy \- checks if connection is busy with an async query
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 dblink_is_busy(text connname) returns int
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBdblink_is_busy\fR
  40 tests whether an async query is in progress\&.
  41 .SH "ARGUMENTS"
  42 .PP
  43 \fIconnname\fR
  44 .RS 4
  45 Name of the connection to check\&.
  46 .RE
  47 .SH "RETURN VALUE"
  48 .PP
  49 Returns 1 if connection is busy, 0 if it is not busy\&. If this function returns 0, it is guaranteed that
  50 \fBdblink_get_result\fR
  51 will not block\&.
  52 .SH "EXAMPLES"
  53 .sp
  54 .if n \{\
  55 .RS 4
  56 .\}
  57 .nf
  58 SELECT dblink_is_busy(\*(Aqdtest1\*(Aq);
  59 .fi
  60 .if n \{\
  61 .RE
  62 .\}