PG_AUTOCTL GET FORMATION SETTINGS(1)

💅 pg_autoctl get formation settings — a manual page, but make it cute

Okay so bestie, you've stumbled into the pg_autoctl get formation settings manual — it lives in the pg_auto_failover section 1 of your man pages, and it is literally the vibe check for your replication settings. ✨

---

🌸 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. iykyk 🫶

---

🎀 OPTIONS 🎀

• --pgdata — where the Postgres node you're managing locally lives. Defaults to the environment variable PGDATA. And btw: use --monitor if you wanna connect to a monitor from literally anywhere, instead of the monitor URI that a local Postgres node managed with pg_autoctl would use. 🌈
• --json — Output JSON formatted data. that's it, that's the whole thing, and it slays 💅
• --formation — Show replication settings for the 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 🔥

okay bestie, watch this — default human-readable mode:

$ 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 same energy but JSON, for the girlies who pipe things into jq:

$ 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 little icon was brought to you by version 2.2, dated Apr 07, 2025, from the pg_auto_failover crew. go forth and check those settings. periodt. 💅✨🦋