'\" t
.\"     Title: pgpool_adm_pcp_detach_node
.\"    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_DETACH_NODE" "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_detach_node \- a function to detach given node ID
.SH "SYNOPSIS"
.HP \w'pcp_detach_node\ returns\ record('u
.BI "pcp_detach_node returns record(integer\ " "node_id" ", boolean\ " "gracefully" ", text\ " "host" ", integer\ " "port" ", text\ " "username" ", text\ " "password" ", out\ " "node_detached\ boolean" ");"
.HP \w'pcp_detach_node\ returns\ record('u
.BI "pcp_detach_node returns record(integer\ " "node_id" ", boolean\ " "gracefully" ", text\ " "pcp_server" ", out\ " "node_detached\ boolean" ");"
.SH "DESCRIPTION"
.PP
\fBpcp_detach_node\fR
detaches a node from
Pgpool\-II\&.
.SH "ARGUMENTS"
.PP
.PP
\fInode_id\fR
.RS 4
The index of backend node to detach\&.
.RE
.PP
\fIgracefully\fR
.RS 4
If true, wait for all session of
pgpool\-II
terminates\&.
.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_detach_node(node_id => 1, gracefully => \*(Aqfalse\*(Aq, host => \*(Aqlocalhost\*(Aq, port => 11001, username => \*(Aqt\-ishii\*(Aq, password => \*(Aqt\-ishii\*(Aq);
    node_detached
    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
    t
    (1 row)
   
.fi
.if n \{\
.RE
.\}
.sp