File: pg_autoctl_get_formation_settings.rst

package info (click to toggle)
pg-auto-failover 2.0-2
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 5,156 kB
  • sloc: ansic: 58,245; python: 5,501; sql: 3,171; makefile: 593; sh: 35
file content (158 lines) | stat: -rw-r--r-- 4,551 bytes parent folder | download | duplicates (2)
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
.. _pg_autoctl_get_formation_settings:

pg_autoctl get formation settings
=================================

pg_autoctl get formation settings - get replication settings for a formation from the monitor

Synopsis
--------

This command prints a ``pg_autoctl`` replication settings::

  usage: pg_autoctl get formation settings  [ --pgdata ] [ --json ] [ --formation ]

  --pgdata      path to data directory
  --json        output data in the JSON format
  --formation   pg_auto_failover formation

Description
-----------

See also :ref:`pg_autoctl_show_settings` which is a synonym.

Options
-------

--pgdata

  Location of the Postgres node being managed locally. Defaults to the
  environment variable ``PGDATA``. Use ``--monitor`` to connect to a monitor
  from anywhere, rather than the monitor URI used by a local Postgres node
  managed with ``pg_autoctl``.

--json

  Output JSON formatted data.

--formation

  Show replication settings for given formation. Defaults to ``default``.

Environment
-----------

PGDATA

  Postgres directory location. Can be used instead of the ``--pgdata``
  option.

PG_AUTOCTL_MONITOR

  Postgres URI to connect to the monitor node, can be used instead of the
  ``--monitor`` option.

XDG_CONFIG_HOME

  The pg_autoctl command stores its configuration files in the standard
  place XDG_CONFIG_HOME. See the `XDG Base Directory Specification`__.

  __ https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
  
XDG_DATA_HOME

  The pg_autoctl command stores its internal states files in the standard
  place XDG_DATA_HOME, which defaults to ``~/.local/share``. See the `XDG
  Base Directory Specification`__.

  __ https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

  
Examples
--------

::

   $ pg_autoctl get formation settings
     Context |    Name |                   Setting | Value
   ----------+---------+---------------------------+-------------------------------------------------------------
   formation | default |      number_sync_standbys | 1
     primary |   node1 | synchronous_standby_names | 'ANY 1 (pgautofailover_standby_2, pgautofailover_standby_3)'
        node |   node1 |        candidate priority | 50
        node |   node2 |        candidate priority | 50
        node |   node3 |        candidate priority | 50
        node |   node1 |        replication quorum | true
        node |   node2 |        replication quorum | true
        node |   node3 |        replication quorum | true

   $ pg_autoctl get formation settings --json
   {
       "nodes": [
           {
               "value": "true",
               "context": "node",
               "node_id": 1,
               "setting": "replication quorum",
               "group_id": 0,
               "nodename": "node1"
           },
           {
               "value": "true",
               "context": "node",
               "node_id": 2,
               "setting": "replication quorum",
               "group_id": 0,
               "nodename": "node2"
           },
           {
               "value": "true",
               "context": "node",
               "node_id": 3,
               "setting": "replication quorum",
               "group_id": 0,
               "nodename": "node3"
           },
           {
               "value": "50",
               "context": "node",
               "node_id": 1,
               "setting": "candidate priority",
               "group_id": 0,
               "nodename": "node1"
           },
           {
               "value": "50",
               "context": "node",
               "node_id": 2,
               "setting": "candidate priority",
               "group_id": 0,
               "nodename": "node2"
           },
           {
               "value": "50",
               "context": "node",
               "node_id": 3,
               "setting": "candidate priority",
               "group_id": 0,
               "nodename": "node3"
           }
       ],
       "primary": [
           {
               "value": "'ANY 1 (pgautofailover_standby_2, pgautofailover_standby_3)'",
               "context": "primary",
               "node_id": 1,
               "setting": "synchronous_standby_names",
               "group_id": 0,
               "nodename": "node1"
           }
       ],
       "formation": {
           "value": "1",
           "context": "formation",
           "node_id": null,
           "setting": "number_sync_standbys",
           "group_id": null,
           "nodename": "default"
       }
   }