summaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/create_nodegroup.sgml
blob: f5955dda86d8bbf38f2224af0bc2490e47bd6edf (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

<refentry id="SQL-CREATENODEGROUP">
 <indexterm zone="sql-createnodegroup">
  <primary>CREATE NODE GROUP</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>CREATE NODE GROUP</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>CREATE NODE GROUP</refname>
  <refpurpose>create a group of cluster nodes</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
CREATE NODE GROUP <replaceable class="parameter">groupname</replaceable>
WITH ( <replaceable class="parameter">nodename</replaceable> [, ... ] )

</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>CREATE NODE GROUP</command> is a SQL command specific
   to <productname>Postgres-XL</productname> that creates
   node group information in catalog table pgxc_group.
  </para>

  <para>
   <command>CREATE NODE</command> only runs on the local node where it is launched.
  </para>

 </refsect1>

 <refsect1>
  <title>Parameters</title>

    <variablelist>
     <varlistentry>
      <term><replaceable class="parameter">groupname</replaceable></term>
      <listitem>
       <para>
        The name of the selected cluster node group.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">nodename</replaceable></term>
      <listitem>
       <para>
        The name of a cluster node.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
 </refsect1>

 <refsect1>
  <title>Notes</title>
  <para>
   A group of nodes works as an alias for node lists when defining tables on
   sub-clusters. Only Datanodes can be included in node groups.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   Create a cluster node group made of nodes called Datanode1, Datanode2.
<programlisting>
CREATE NODE GROUP cluster_group WITH Datanode1, Datanode2;
</programlisting>
  </para>

 </refsect1>

 <refsect1>
  <title>Compatibility</title>
  <para>
   <command>CREATE NODE GROUP</command> does not conform to the <acronym>
   SQL</acronym> standards, it is a <productname>Postgres-XL</productname> specific command.
  </para>
 </refsect1>

</refentry>