1PG_AUTOCTL(1) pg_auto_failover PG_AUTOCTL(1)
2
6 pg_autoctl - pg_autoctl
7 pg_autoctl - control a pg_auto_failover node
9
11 pg_autoctl provides the following commands:
12 pg_autoctl
14 + create Create a pg_auto_failover node, or formation
15 + drop Drop a pg_auto_failover node, or formation
16 + config Manages the pg_autoctl configuration
17 + show Show pg_auto_failover information
18 + enable Enable a feature on a formation
19 + disable Disable a feature on a formation
20 + get Get a pg_auto_failover node, or formation setting
21 + set Set a pg_auto_failover node, or formation setting
22 + perform Perform an action orchestrated by the monitor
23 activate Activate a Citus worker from the Citus coordinator
24 run Run the pg_autoctl service (monitor or keeper)
25 stop signal the pg_autoctl service for it to stop
26 reload signal the pg_autoctl for it to reload its configuration
27 status Display the current status of the pg_autoctl service
28 help print help message
29 version print pg_autoctl version
30 pg_autoctl create
32 monitor Initialize a pg_auto_failover monitor node
33 postgres Initialize a pg_auto_failover standalone postgres node
34 coordinator Initialize a pg_auto_failover citus coordinator node
35 worker Initialize a pg_auto_failover citus worker node
36 formation Create a new formation on the pg_auto_failover monitor
37 pg_autoctl drop
39 monitor Drop the pg_auto_failover monitor
40 node Drop a node from the pg_auto_failover monitor
41 formation Drop a formation on the pg_auto_failover monitor
42 pg_autoctl config
44 check Check pg_autoctl configuration
45 get Get the value of a given pg_autoctl configuration variable
46 set Set the value of a given pg_autoctl configuration variable
47 pg_autoctl show
49 uri Show the postgres uri to use to connect to pg_auto_failover nodes
50 events Prints monitor's state of nodes in a given formation and group
51 state Prints monitor's state of nodes in a given formation and group
52 settings Print replication settings for a formation from the monitor
53 standby-names Prints synchronous_standby_names for a given group
54 file List pg_autoctl internal files (config, state, pid)
55 systemd Print systemd service file for this node
56 pg_autoctl enable
58 secondary Enable secondary nodes on a formation
59 maintenance Enable Postgres maintenance mode on this node
60 ssl Enable SSL configuration on this node
61 monitor Enable a monitor for this node to be orchestrated from
62 pg_autoctl disable
64 secondary Disable secondary nodes on a formation
65 maintenance Disable Postgres maintenance mode on this node
66 ssl Disable SSL configuration on this node
67 monitor Disable the monitor for this node
68 pg_autoctl get
70 + node get a node property from the pg_auto_failover monitor
71 + formation get a formation property from the pg_auto_failover monitor
72 pg_autoctl get node
74 replication-quorum get replication-quorum property from the monitor
75 candidate-priority get candidate property from the monitor
76 pg_autoctl get formation
78 settings get replication settings for a formation from the monitor
79 number-sync-standbys get number_sync_standbys for a formation from the monitor
80 pg_autoctl set
82 + node set a node property on the monitor
83 + formation set a formation property on the monitor
84 pg_autoctl set node
86 metadata set metadata on the monitor
87 replication-quorum set replication-quorum property on the monitor
88 candidate-priority set candidate property on the monitor
89 pg_autoctl set formation
91 number-sync-standbys set number-sync-standbys for a formation on the monitor
92 pg_autoctl perform
94 failover Perform a failover for given formation and group
95 switchover Perform a switchover for given formation and group
96 promotion Perform a failover that promotes a target node
97
99 The pg_autoctl tool is the client tool provided by pg_auto_failover to
100 create and manage Postgres nodes and the pg_auto_failover monitor node.
101 The command is built with many sub-commands that each have their own
102 manual page.
103
105 To get the full recursive list of supported commands, use:
106 pg_autoctl help
108
110 To grab the version of pg_autoctl that you're using, use:
111 pg_autoctl --version
113 pg_autoctl version
114 A typical output would be:
116 pg_autoctl version 1.4.2
118 pg_autoctl extension version 1.4
119 compiled with PostgreSQL 12.3 on x86_64-apple-darwin16.7.0, compiled by Apple LLVM version 8.1.0 (clang-802.0.42), 64-bit
120 compatible with Postgres 10, 11, 12, and 13
121 The version is also available as a JSON document when using the --json
123 option:
124 pg_autoctl --version --json
126 pg_autoctl version --json
127 A typical JSON output would be:
129 {
131 "pg_autoctl": "1.4.2",
132 "pgautofailover": "1.4",
133 "pg_major": "12",
134 "pg_version": "12.3",
135 "pg_version_str": "PostgreSQL 12.3 on x86_64-apple-darwin16.7.0, compiled by Apple LLVM version 8.1.0 (clang-802.0.42), 64-bit",
136 "pg_version_num": 120003
137 }
138 This is for version 1.4.2 of pg_auto_failover. This particular version
140 of the pg_autoctl client tool has been compiled using libpq for Post‐
141 greSQL 12.3 and is compatible with Postgres 10, 11, 12, and 13.
142
144 PG_AUTOCTL_DEBUG
145 When this environment variable is set (to anything) then pg_autoctl
146 allows more commands. Use with care, this opens abilities to destroy
147 your production clusters.
148
150 Microsoft
151
153 Copyright (c) Microsoft Corporation. All rights reserved.
1542.0 Sep 13, 2023 PG_AUTOCTL(1)