pg_autoctl show settings(1)

pg_autoctl show settings

Section 1 pg-auto-failover-cli bookworm source

Description

PG_AUTOCTL SHOW SETTINGS

NAME

pg_autoctl show settings - pg_autoctl show settings

pg_autoctl show settings - Print replication settings for a formation from the monitor

SYNOPSIS

This command allows to review all the replication settings of a given formation (defaults to 'default' as usual):

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

--pgdata path to data directory
--monitor pg_auto_failover Monitor Postgres URL
--json output data in the JSON format
--formation pg_auto_failover formation

DESCRIPTION

See also pg_autoctl get formation settings which is a synonym.

The output contains setting and values that apply at different contexts, as shown here with a formation of four nodes, where node_4 is not participating in the replication quorum and also not a candidate for failover:

Three replication settings context are listed:

	1.		The "formation" context contains a single entry, the value of number_sync_standbys for the target formation.
	2.		The "primary" context contains one entry per group of Postgres nodes in the formation, and shows the current value of the synchronous_standby_names Postgres setting as computed by the monitor. It should match what's currently set on the primary node unless while applying a change, as shown by the primary being in the APPLY_SETTING state.
	3.		The "node" context contains two entry per nodes, one line shows the replication quorum setting of nodes, and another line shows the candidate priority of nodes.

This command gives an overview of all the settings that apply to the current formation.

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.

--monitor

Postgres URI used to connect to the monitor. Must use the autoctl_node username and target the pg_auto_failover database name. It is possible to show the Postgres URI from the monitor node using the command pg_autoctl show uri.

Defaults to the value of the environment variable PG_AUTOCTL_MONITOR.

--formation

Show the current replication settings for the given formation. Defaults to the default formation.

--json

Output a JSON formatted data instead of a table formatted list.

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

AUTHOR

Microsoft