ALTER NODE

Updated on 2025-09-22 GMT+08:00

View PDF

Description

Changes the definition of an existing cluster node.

Precautions

ALTER NODE is an API of the cluster management tool and is used to manage clusters. Only administrators have the permission to use this API. You are advised not to use this API, because doing so affects the cluster.

Syntax

    
     
       
       ALTER NODE nodename WITH
  (
    [ TYPE = nodetype,]
    [ HOST = hostname,]
    [ PORT = portnum,]
    [ HOST1 = 'hostname',]
    [ PORT1 = portnum,]
    [ HOSTPRIMARY [ = boolean ],]
    [ PRIMARY [ = boolean ],]
    [ PREFERRED [ = boolean ],]
    [ SCTP_PORT = portnum,]
    [ CONTROL_PORT = portnum,]
    [ SCTP_PORT1 = portnum,]
    [ CONTROL_PORT1 = portnum, ]
    [ NODEIS_CENTRAL [ = boolean ],]
    [ NODEIS_ACTIVE [= boolean] ]
  );

      

    
   

Click to enlarge

NOTE:

The port whose number is specified by PORT is used for internal communications between nodes. Unlike the port connecting to an external client, it can be queried in the pgxc_node table.

Parameters

nodename
Node name.

Value range: a string. It must comply with the naming convention.
TYPE = nodetype
Specifies the type of a node.

Value range:
- 'coordinator'
- 'datanode'
HOST = hostname
Specifies the host name or IP address of a node.
PORT = portnum
Specifies the port number of the primary node to which a node is bound.
HOST1 = hostname
Specifies the name or IP address of the standby node corresponding to a node.
PORT1 = portnum
Specifies the port number of the standby node to which a node is bound.
HOSTPRIMARY
Specifies whether the host name or IP address is the primary one.

Value range:
- true
- false (default value)
PRIMARY = boolean
Specifies whether the node is a primary node or not. A primary node allows read/write operations. A non-primary node allows only read operations.

Value range:
- true
- false (default value)
PREFERRED = boolean
Specifies whether the node is a preferred node for read operations.

Value range:
- true
- false (default value)
SCTP_PORT = portnum
Specifies the port used by the TCP proxy communications library of the primary node to listen on the data transmission channel. TCP is used to listen on connections.

CONTROL_PORT = portnum
Specifies the port used by the TCP proxy communications library of the primary node to listen on the control transmission channel. The TCP protocol is used to listen on connections.
SCTP_PORT1 = portnum
Specifies the port used by the TCP proxy communications library of the standby node to listen on the data transmission channel. TCP is used to listen on connections.
CONTROL_PORT 1= portnum
Specifies the port used by the TCP proxy communications library of the standby node to listen on the control transmission channel. The TCP protocol is used to listen on connections.
NODEIS_CENTRAL
Specifies whether the current node is a central control node. It is used only for CNs and is invalid for DNs.
- true
- false (default value)
NODEIS_ACTIVE
Specifies whether the current node is normal. It is used to mark whether the CN is removed and is invalid for DNs.
- true
- false (default value)
NOTE:

If there are multiple CNs, cluster nodes are created only on the currently connected CNs and will not be synchronized to other CNs. Cluster nodes must be created on all CNs. To delete a cluster node, you only need to connect to one CN. If a cluster node is created on only one CN, to delete the cluster node, you need to define the current CN name and delete the cluster node on the current CN. For details, see DROP NODE.

Examples

-- Create cluster nodes on all CNs.
gaussdb=#CREATE NODE datanode1 WITH(
   TYPE = datanode,
   PREFERRED = false
);

-- Query the initial cluster DN status.
gaussdb=#SELECT node_name, nodeis_preferred FROM pgxc_node WHERE node_type = 'D' ORDER BY 1;
 node_name | nodeis_preferred
-----------+------------------
 datanode1 | f
 datanode2 | f
(2 rows)

-- Set datanode1 as the preferred DN.
gaussdb=#ALTER NODE datanode1 WITH(preferred = true);

-- Query the cluster DN status after the change.
gaussdb=#SELECT node_name, nodeis_preferred FROM pgxc_node WHERE node_type = 'D' ORDER BY 1;
 node_name | nodeis_preferred
-----------+------------------
 datanode1 | t
 datanode2 | f
(2 rows)

-- Connect to only one CN to delete cluster nodes.
gaussdb=#DROP NODE datanode1;