'\" t
.\"     Title: pgpool_adm_pcp_node_info
.\"    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_NODE_INFO" "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_node_info \- a function to display the information on the given node ID
.SH "SYNOPSIS"
.HP \w'pcp_node_info\ returns\ record('u
.BI "pcp_node_info returns record(integer\ " "node_id" ", text\ " "host" ", integer\ " "port" ", text\ " "username" ", text\ " "password" ", out\ " "status\ text" ", out\ " "pg_status\ text" ", out\ " "weight\ float4" ", out\ " "role\ text" ", out\ " "pg_role\ text" ", out\ " "replication_delay\ bigint" ", out\ " "replication_state\ text" ", out\ " "replication_sync_state\ text" ", out\ " "last_status_change\ timestamp" ");"
.HP \w'pcp_node_info\ returns\ record('u
.BI "pcp_node_info returns record(integer\ " "node_id" ", text\ " "pcp_server" ", out\ " "status\ text" ", out\ " "pg_status\ text" ", out\ " "weight\ float4" ", out\ " "role\ text" ", out\ " "pg_role\ text" ", out\ " "replication_delay\ bigint" ", out\ " "replication_state\ text" ", out\ " "replication_sync_state\ text" ", out\ " "last_status_change\ timestamp" ");"
.SH "DESCRIPTION"
.PP
\fBpcp_node_info\fR
displays the information on the given node ID\&.
.SH "ARGUMENTS"
.PP
.PP
\fInode_id\fR
.RS 4
The index of backend node to get information of\&.
.RE
.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_node_info(node_id => 1, host => \*(Aq\*(Aq, port => 11001, username => \*(Aqt\-ishii\*(Aq, password => \*(Aqt\-ishii\*(Aq);
 host | port  |      status       | pg_status | weight |  role   | pg_role | replication_delay | replication_state | replication_sync_state | last_status_change  
\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 /tmp | 11003 | Connection in use | up        |    0\&.5 | Standby | standby |                 0 | streaming         | async                  | 2021\-02\-27 15:10:19
(1 row)
   
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
\fIrole\fR,
\fIreplication_delay\fR,
\fIlast_status_change\fR
out parameters are new from
Pgpool\-II
4\&.0\&. If you have already installed pre\-4\&.0 pgpool_adm extension, you can upgrade to the new one by using ALTER EXTENSION SQL command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
     ALTER EXTENSION pgpool_adm UPDATE;
    
.fi
.if n \{\
.RE
.\}
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
\fIreplication_state\fR
and
\fIreplication_sync_state\fR
out parameters are new from
Pgpool\-II
4\&.1\&. If you have already installed pre\-4\&.1 pgpool_adm extension, you can upgrade to the new one by using ALTER EXTENSION SQL command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
     ALTER EXTENSION pgpool_adm UPDATE;
    
.fi
.if n \{\
.RE
.\}
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
\fIpg_status\fR,
\fIpg_role\fR
out parameters are new from
Pgpool\-II
4\&.3\&. If you have already installed pre\-4\&.2 pgpool_adm extension, you can upgrade to the new one by using ALTER EXTENSION SQL command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
     ALTER EXTENSION pgpool_adm UPDATE;
    
.fi
.if n \{\
.RE
.\}
.sp .5v
.RE