PG_AUTOCTL_DISABLE_SECONDARY(1)

📦
version 2.1 · 2 versions
, in fedora 43, fedora 44

✨ pg_autoctl disable secondary ✨

okay bestie, welcome to the manual page for pg_autoctl disable secondary 💖 this is part of the pg_auto_failover family (man page name pg_autoctl disable secondary, if you're keeping receipts), and yes, it does exactly what it says on the tin: it turns the secondary feature OFF for a formation. 🎀

🌸 NAME 🌸

pg_autoctl disable secondary — literally just pg_autoctl disable secondary, and also: Disable secondary nodes on a formation. That's the whole vibe. 🦋

✨ SYNOPSIS ✨

so here's the tea, bestie: this feature makes the MOST sense when you're running the Enterprise Edition of pg_auto_failover, because that edition is fully compatible with Citus formations. 👑

  • When secondaries are disabled, the Citus workers creation policy is to assign a primary node and then a standby node for each group.
  • When secondary is disabled, the Citus workers creation policy is to assign only the primary nodes.

no cap, that's the whole difference. periodt. 💅

usage: pg_autoctl disable secondary  [ --pgdata --formation ]

--pgdata      path to data directory
--formation   Formation to disable secondary on

💖 OPTIONS 💖

  • --pgdata — where the Postgres node you're managing locally actually lives. It defaults to the environment variable PGDATA. And psst, if you wanna reach a monitor from anywhere instead of using the monitor URI that a local Postgres node managed with pg_autoctl would use, go use --monitor. 🫶
  • --formation — the target formation where you're turning the secondary feature off. that's it, that's the option. ✨

🌈 ENVIRONMENT 🌈

  • PGDATA — the Postgres directory location. You can use this instead of the --pgdata option. 🍓
  • PG_AUTOCTL_MONITOR — a Postgres URI to connect to the monitor node. You can use this 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. ⭐

👑 AUTHOR 👑

Microsoft

Copyright (c) Microsoft Corporation. All rights reserved.

ok that's the whole page bestie, no notes, you ate 💅

and a lil sign-off from me to you: this is pg_auto_failover version 2.1, dated Jan 18, 2025. go disable some secondaries, main character. 💖🦋🌸

📦 where this page comes from