blob: 6da0f67010cb4d3ae93ee2c805021f64833e6cec (
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
|
'\" t
.\" Title: dblink_is_busy
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 15.6 Documentation
.\" Source: PostgreSQL 15.6
.\" Language: English
.\"
.TH "DBLINK_IS_BUSY" "3" "2024" "PostgreSQL 15.6" "PostgreSQL 15.6 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_is_busy \- checks if connection is busy with an async query
.SH "SYNOPSIS"
.sp
.nf
dblink_is_busy(text connname) returns int
.fi
.SH "DESCRIPTION"
.PP
\fBdblink_is_busy\fR
tests whether an async query is in progress\&.
.SH "ARGUMENTS"
.PP
\fIconnname\fR
.RS 4
Name of the connection to check\&.
.RE
.SH "RETURN VALUE"
.PP
Returns 1 if connection is busy, 0 if it is not busy\&. If this function returns 0, it is guaranteed that
\fBdblink_get_result\fR
will not block\&.
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
SELECT dblink_is_busy(\*(Aqdtest1\*(Aq);
.fi
.if n \{\
.RE
.\}
|
