PG_AUTOCTL_CONFIG_CHECK(1)

✨ NAME ✨

ok so bestie, this is pg_autoctl config check — literally the vibe-check command for your pg_autoctl setup 💅

pg_autoctl config check — it checks your pg_autoctl configuration. that's it, that's the whole job 🫶

---

🌸 SYNOPSIS 🌸

this command runs a very basic list of sanity checks on a pg_autoctl node setup, no cap:

usage: pg_autoctl config check  [ --pgdata ] [ --json ]

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

---

🎀 OPTIONS 🎀

• --pgdata — where the Postgres node that's being managed locally lives. defaults to the environment variable PGDATA. and like, use --monitor to connect to a monitor from literally anywhere, instead of the monitor URI that a local Postgres node managed with pg_autoctl is using. iykyk ✨
• --json — outputs the data in JSON format. iconic, honestly. 🦋

---

🧚 ENVIRONMENT 🧚

• PGDATA — Postgres directory location. you can use this instead of the --pgdata option. slay.
• PG_AUTOCTL_MONITOR — Postgres URI to connect to the monitor node, can be used instead of the --monitor option. periodt.
• 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 💖

ok watch this, main character energy:

$ pg_autoctl config check --pgdata node1
18:37:27 63749 INFO  Postgres setup for PGDATA "/Users/dim/dev/MS/pg_auto_failover/tmux/node1" is ok, running with PID 5501 and port 99698
18:37:27 63749 INFO  Connection to local Postgres ok, using "port=5501 dbname=demo host=/tmp"
18:37:27 63749 INFO  Postgres configuration settings required for pg_auto_failover are ok
18:37:27 63749 WARN  Postgres 12.1 does not support replication slots on a standby node
18:37:27 63749 INFO  Connection to monitor ok, using "postgres://autoctl_node@localhost:5500/pg_auto_failover?sslmode=prefer"
18:37:27 63749 INFO  Monitor is running version "1.5.0.1", as expected
pgdata:                /Users/dim/dev/MS/pg_auto_failover/tmux/node1
pg_ctl:                /Applications/Postgres.app/Contents/Versions/12/bin/pg_ctl
pg_version:            12.3
pghost:                /tmp
pgport:                5501
proxyport:             0
pid:                   99698
is in recovery:        no
Control Version:       1201
Catalog Version:       201909212
System Identifier:     6941034382470571312
Latest checkpoint LSN: 0/6000098
Postmaster status:     ready

like, look at all those INFOs just vibing 🍓 (and one lil WARN, we don't talk about her 💀)

---

👑 AUTHOR 👑

Microsoft

---

⭐ COPYRIGHT ⭐

Copyright (c) Microsoft Corporation. All rights reserved.

---

no cap, that's the whole page. go check your config bestie, you got this 🫶✨

this was pg_autoctl config check from the pg_auto_failover manual, version 2.1, dated Jan 18, 2025 — mwah, take care of her 💅💖