PG_AUTOCTL_GET_FORMATION_SETTINGS(1)

💖 PG_AUTOCTL_GET_FORMATION_SETTINGS(1) 💖

okay bestie, this is the pg_auto_failover manual page, and we're doing pg_autoctl get formation settings today. no cap.

---

✨ NAME ✨

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 pg_autoctl show settings which is a synonym. literally the same thing, just wearing a different outfit 💅

---

👑 OPTIONS 👑

• --pgdata — where the Postgres node being managed locally lives. 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. for the girlies who pipe things into jq ✨
• --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.
• 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.

---

🦋 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

and now the glow-up version, with --json:

$ 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"
    }
}

---

💜 AUTHOR 💜

Microsoft

---

⭐ COPYRIGHT ⭐

Copyright (c) Microsoft Corporation. All rights reserved.

---

and that's the whole page, bestie 🫶 this was pg_auto_failover version 2.1, dated Jan 18, 2025, and yeah — PG_AUTOCTL G...TION SETTINGS(1) is just the header doing its little truncation thing, iconic honestly 💅✨