.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "PG_AUTOCTL SHOW SETTINGS" "1" "Nov 25, 2023" "2.1" "pg_auto_failover" .SH NAME pg_autoctl show settings \- pg_autoctl show settings .sp pg_autoctl show settings \- Print replication settings for a formation from the monitor .SH SYNOPSIS .sp This command allows to review all the replication settings of a given formation (defaults to \fI\(aqdefault\(aq\fP as usual): .INDENT 0.0 .INDENT 3.5 .sp .EX 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 .EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp See also \fI\%pg_autoctl get formation settings\fP which is a synonym. .sp The output contains setting and values that apply at different contexts, as shown here with a formation of four nodes, where \fBnode_4\fP is not participating in the replication quorum and also not a candidate for failover: .INDENT 0.0 .INDENT 3.5 .sp .EX $ pg_autoctl show settings Context | Name | Setting | Value \-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- formation | default | number_sync_standbys | 1 primary | node_1 | synchronous_standby_names | \(aqANY 1 (pgautofailover_standby_3, pgautofailover_standby_2)\(aq node | node_1 | replication quorum | true node | node_2 | replication quorum | true node | node_3 | replication quorum | true node | node_4 | replication quorum | false node | node_1 | candidate priority | 50 node | node_2 | candidate priority | 50 node | node_3 | candidate priority | 50 node | node_4 | candidate priority | 0 .EE .UNINDENT .UNINDENT .sp Three replication settings context are listed: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP 1. 3 The \fI\(dqformation\(dq\fP context contains a single entry, the value of \fBnumber_sync_standbys\fP for the target formation. .IP 2. 3 The \fI\(dqprimary\(dq\fP context contains one entry per group of Postgres nodes in the formation, and shows the current value of the \fBsynchronous_standby_names\fP Postgres setting as computed by the monitor. It should match what\(aqs currently set on the primary node unless while applying a change, as shown by the primary being in the APPLY_SETTING state. .IP 3. 3 The \fI\(dqnode\(dq\fP context contains two entry per nodes, one line shows the replication quorum setting of nodes, and another line shows the candidate priority of nodes. .UNINDENT .UNINDENT .UNINDENT .sp This command gives an overview of all the settings that apply to the current formation. .SH OPTIONS .INDENT 0.0 .TP .B \-\-pgdata Location of the Postgres node being managed locally. Defaults to the environment variable \fBPGDATA\fP\&. Use \fB\-\-monitor\fP to connect to a monitor from anywhere, rather than the monitor URI used by a local Postgres node managed with \fBpg_autoctl\fP\&. .TP .B \-\-monitor Postgres URI used to connect to the monitor. Must use the \fBautoctl_node\fP username and target the \fBpg_auto_failover\fP database name. It is possible to show the Postgres URI from the monitor node using the command \fI\%pg_autoctl show uri\fP\&. .sp Defaults to the value of the environment variable \fBPG_AUTOCTL_MONITOR\fP\&. .TP .B \-\-formation Show the current replication settings for the given formation. Defaults to the \fBdefault\fP formation. .TP .B \-\-json Output a JSON formatted data instead of a table formatted list. .UNINDENT .SH ENVIRONMENT .sp PGDATA .INDENT 0.0 .INDENT 3.5 Postgres directory location. Can be used instead of the \fB\-\-pgdata\fP option. .UNINDENT .UNINDENT .sp PG_AUTOCTL_MONITOR .INDENT 0.0 .INDENT 3.5 Postgres URI to connect to the monitor node, can be used instead of the \fB\-\-monitor\fP option. .UNINDENT .UNINDENT .sp XDG_CONFIG_HOME .INDENT 0.0 .INDENT 3.5 The pg_autoctl command stores its configuration files in the standard place XDG_CONFIG_HOME. See the \fI\%XDG Base Directory Specification\fP\&. .UNINDENT .UNINDENT .sp XDG_DATA_HOME .INDENT 0.0 .INDENT 3.5 The pg_autoctl command stores its internal states files in the standard place XDG_DATA_HOME, which defaults to \fB~/.local/share\fP\&. See the \fI\%XDG Base Directory Specification\fP\&. .UNINDENT .UNINDENT .SH EXAMPLES .INDENT 0.0 .INDENT 3.5 .sp .EX $ pg_autoctl show settings Context | Name | Setting | Value \-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- formation | default | number_sync_standbys | 1 primary | node1 | synchronous_standby_names | \(aqANY 1 (pgautofailover_standby_2, pgautofailover_standby_3)\(aq 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 .EE .UNINDENT .UNINDENT .SH AUTHOR Microsoft .SH COPYRIGHT Copyright (c) Microsoft Corporation. All rights reserved. .\" Generated by docutils manpage writer. .