'\" t
.\"     Title: pgpool_adm_pcp_pool_status
.\"    Author: The Pgpool Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2023
.\"    Manual: pgpool-II 4.3.7 Documentation
.\"    Source: pgpool-II 4.3.7
.\"  Language: English
.\"
.TH "PGPOOL_ADM_PCP_POOL_STATUS" "3" "2023" "pgpool-II 4.3.7" "pgpool-II 4.3.7 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"
pgpool_adm_pcp_pool_status \- a function to retrieves parameters in pgpool\&.conf\&.
.SH "SYNOPSIS"
.HP \w'pcp_pool_status\ returns\ record('u
.BI "pcp_pool_status returns record(text\ " "host" ", integer\ " "port" ", text\ " "username" ", text\ " "password" ", out\ " "item\ text" ", out\ " "value\ text" ", out\ " "description\ text" ");"
.HP \w'pcp_pool_status\ returns\ record('u
.BI "pcp_pool_status returns record(text\ " "pcp_server" ", out\ " "item\ text" ", out\ " "value\ text" ", out\ " "description\ text" ");"
.SH "DESCRIPTION"
.PP
\fBpcp_pool_status\fR
retrieves parameters in pgpool\&.conf\&.
.SH "ARGUMENTS"
.PP
.PP
\fIpcp_server\fR
.RS 4
The foreign server name for pcp server\&.
.RE
.PP
\fBOther arguments \fR
.RS 4
See
\fBpcp_common_options\fR(1)\&.
.RE
.SH "EXAMPLE"
.PP
Here is an example output:
.sp
.if n \{\
.RS 4
.\}
.nf
    test=# SELECT * FROM pcp_pool_status(host => \*(Aqlocalhost\*(Aq, port => 11001, username => \*(Aqt\-ishii\*(Aq, password => \*(Aqt\-ishii\*(Aq) WHERE item ~ \*(Aqbackend\&.*0\*(Aq;
    item           |                     value                      |          description
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    backend_hostname0       | /tmp                                           | backend #0 hostname
    backend_port0           | 11002                                          | backend #0 port number
    backend_weight0         | 0\&.500000                                       | weight of backend #0
    backend_data_directory0 | /home/t\-ishii/work/pgpool\-II/current/aaa/data0 | data directory for backend #0
    backend_status0         | 2                                              | status of backend #0
    backend_flag0           | ALLOW_TO_FAILOVER                              | backend #0 flag
    (6 rows)
   
.fi
.if n \{\
.RE
.\}
.sp