pg_autoctl set formation number-sync-standbys(1)

pg_autoctl set formation number-sync-standbys

Section 1 pg-auto-failover-cli bookworm source

Description

PG_AUTOCTL SET FORMATION NUMBER-SYNC-STANDBYS

NAME

pg_autoctl set formation number-sync-standbys - pg_autoctl set formation number-sync-standbys

pg_autoctl set formation number-sync-standbys - set number_sync_standbys for a formation from the monitor

SYNOPSIS

This command set a pg_autoctl replication settings for number sync standbys:

usage: pg_autoctl set formation number-sync-standbys [ --pgdata ] [ --json ] [ --formation ] <number_sync_standbys>

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

DESCRIPTION

The pg_auto_failover monitor ensures that at least N+1 candidate standby nodes are registered when number-sync-standbys is N. This means that to be able to run the following command, at least 3 standby nodes with a non-zero candidate priority must be registered to the monitor:

$ pg_autoctl set formation number-sync-standbys 2

See also pg_autoctl show settings for the full list of replication settings.

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.

--json

Output JSON formatted data.

--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.

AUTHOR

Microsoft