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

<refentry id="SQL-PAUSECLUSTER">
 <indexterm zone="sql-pausecluster">
  <primary>PAUSE CLUSTER</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>PAUSE CLUSTER</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>PAUSE CLUSTER</refname>
  <refpurpose>pause the <productname>Postgres-XL</productname> cluster</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
PAUSE CLUSTER

</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>PAUSE CLUSTER </command> is a SQL command specific
   to <productname>Postgres-XL</productname> that pauses 
   cluster operation.
  </para>
  <para>
   Pause blocks any new transactions from starting and waits until
   existing transactions complete, then returns. Existing sessions 
   are still connected to Coordinators, it is just that any new statements
   will be held up and not be executed. 
   </para>

   <para>
   The session that paused the cluster can perform tasks exclusively on the 
   cluster. This is useful for maintenance tasks to resolve a problem, 
   restart a Datanode, manually failover a Datanode, etc. Applications will
   not receive error messages unless they themselves timeout, statement execution
   will just be briefly suspended.
   </para>
    
  <para>
   Once the DBA has completed whatever tasks were needed, the command <xref linkend="sql-unpausecluster"> can be used.
  </para>

 </refsect1>

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

</refentry>