blob: 5485e70ec4b052be74367f470cfaf6221c51ec0e (
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<refentry id="SQL-ALTERNODE">
<indexterm zone="sql-alternode">
<primary>ALTER NODE</primary>
</indexterm>
<refmeta>
<refentrytitle>ALTER NODE</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ALTER NODE</refname>
<refpurpose>alter a cluster node</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
ALTER NODE <replaceable class="parameter">nodename</replaceable> WITH
(
[ TYPE = <replaceable class="parameter">nodetype</replaceable>,]
[ HOST = <replaceable class="parameter">hostname</replaceable>,]
[ PORT = <replaceable class="parameter">portnum</replaceable>,]
[ PRIMARY [ = <replaceable class="parameter">boolean</replaceable>],]
[ PREFERRED [ = <replaceable class="parameter">boolean</replaceable> ] ]
)
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>ALTER NODE</command> is a new SQL command specific
to <productname>Postgres-XL</productname> that modifies
cluster node information in catalog pgxc_node.
</para>
<para>
Node connection that has been modified does not guarantee that connection
information cached in the pooler is updated accordingly.
</para>
<para>
<command>ALTER NODE</command> only runs on the local node where it is launched.
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><replaceable class="parameter">nodename</replaceable></term>
<listitem>
<para>
The name of the selected cluster node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TYPE</literal></term>
<listitem>
<para>
The type of the cluster node. It is possible to specify
a Coordinator node or a Datanode node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>PRIMARY</literal></term>
<listitem>
<para>
Defines if the cluster node is used as a primary node for replicated
write operations. A <replaceable class="parameter">boolean</replaceable>
value can be specified. In case no value is specified, <literal>PRIMARY</literal>
acts like <literal>true</>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>PREFERRED</literal></term>
<listitem>
<para>
Defines if the cluster node is used as a preferred node for replicated
read operations. A <replaceable class="parameter">boolean</replaceable>
value can be specified. In case no value is specified, <literal>PREFERRED</literal>
acts like <literal>true</>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">nodetype</replaceable></term>
<listitem>
<para>
The node type for given cluster node. Possible values are:
'coordinator' for a Coordinator node and 'datanode' for a
Datanode node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">hostname</replaceable></term>
<listitem>
<para>
The hostname or IP used to connect to the cluster node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">portnum</replaceable></term>
<listitem>
<para>
The port number used to connect to the cluster node.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
A Datanode can be modified as <literal>PRIMARY</literal> and
as <literal>PREFERRED</literal> as many times as necessary.
</para>
<para>
A node type cannot be modified.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Modify a Coordinator node located on local machine to use port 6543.
<programlisting>
ALTER NODE coord_node WITH (PORT = 6543, HOST = 'localhost');
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
<command>ALTER NODE</command> does not conform to the <acronym>
SQL</acronym> standards, it is a Postgres-XL specific command.
</para>
</refsect1>
</refentry>
|