diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 67de4150b8e..2a90d011db5 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -9600,13 +9600,14 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
Preset Options
- The following parameters
are read-only, and are determined
- when PostgreSQL is compiled or when it is
- installed. As such, they have been excluded from the sample
+ The following parameters
are read-only.
+ As such, they have been excluded from the sample
postgresql.conf file. These options report
various aspects of PostgreSQL behavior
that might be of interest to certain applications, particularly
administrative front-ends.
+ Most of them are determined when PostgreSQL
+ is compiled or when it is installed.
@@ -9651,10 +9652,11 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
- On Unix systems this parameter reports the permissions of the data
- directory defined by () at startup.
+ On Unix systems this parameter reports the permissions the data
+ directory (defined by )
+ had at server startup.
(On Microsoft Windows this parameter will always display
- 0700). See
+ 0700.) See
for more information.
@@ -9695,6 +9697,23 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
+
+ in_hot_standby (boolean)
+
+ in_hot_standby configuration parameter
+
+
+
+
+ Reports whether the server is currently in hot standby mode. When
+ this is on, all transactions are forced to be
+ read-only. Within a session, this can change only if the server is
+ promoted to be primary. See for more
+ information.
+
+
+
+
lc_collate (string)
diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml
index 19d7bd2b28f..04f75020e44 100644
--- a/doc/src/sgml/high-availability.sgml
+++ b/doc/src/sgml/high-availability.sgml
@@ -1859,8 +1859,11 @@ if (!triggered)
- Users will be able to tell whether their session is read-only by
- issuing SHOW transaction_read_only. In addition, a set of
+ Users can determine whether hot standby is currently active for their
+ session by issuing SHOW in_hot_standby.
+ (In server versions before 14, the in_hot_standby
+ parameter did not exist; a workable substitute method for older servers
+ is SHOW transaction_read_only.) In addition, a set of
functions () allow users to
access information about the standby server. These allow you to write
programs that are aware of the current state of the database. These
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index a5db58d4680..2bb3bf77e43 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -2150,6 +2150,7 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
server_encoding,
client_encoding,
application_name,
+ in_hot_standby,
is_superuser,
session_authorization,
DateStyle,
@@ -2162,7 +2163,10 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
standard_conforming_strings was not reported by releases
before 8.1;
IntervalStyle was not reported by releases before 8.4;
- application_name was not reported by releases before 9.0.)
+ application_name was not reported by releases before
+ 9.0;
+ in_hot_standby was not reported by releases before
+ 14.)
Note that
server_version,
server_encoding and
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 98b42bb2692..24f7b21ecbd 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1278,6 +1278,7 @@ SELCT 1/0;
server_encoding,
client_encoding,
application_name,
+ in_hot_standby,
is_superuser,
session_authorization,
DateStyle,
@@ -1290,7 +1291,10 @@ SELCT 1/0;
standard_conforming_strings was not reported by releases
before 8.1;
IntervalStyle was not reported by releases before 8.4;
- application_name was not reported by releases before 9.0.)
+ application_name was not reported by releases before
+ 9.0;
+ in_hot_standby was not reported by releases before
+ 14.)
Note that
server_version,
server_encoding and
diff --git a/src/backend/utils/misc/check_guc b/src/backend/utils/misc/check_guc
index 416a0875b6c..b171ef0e4ff 100755
--- a/src/backend/utils/misc/check_guc
+++ b/src/backend/utils/misc/check_guc
@@ -16,7 +16,7 @@
## if an option is valid but shows up in only one file (guc.c but not
## postgresql.conf.sample), it should be listed here so that it
## can be ignored
-INTENTIONALLY_NOT_INCLUDED="debug_deadlocks \
+INTENTIONALLY_NOT_INCLUDED="debug_deadlocks in_hot_standby \
is_superuser lc_collate lc_ctype lc_messages lc_monetary lc_numeric lc_time \
pre_auth_delay role seed server_encoding server_version server_version_num \
session_authorization trace_lock_oidmin trace_lock_table trace_locks trace_lwlocks \
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index 2779da8a693..383b7d0d710 100644
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -209,6 +209,7 @@ static bool check_cluster_name(char **newval, void **extra, GucSource source);
static const char *show_unix_socket_permissions(void);
static const char *show_log_file_mode(void);
static const char *show_data_directory_mode(void);
+static const char *show_in_hot_standby(void);
static bool check_backtrace_functions(char **newval, void **extra, GucSource source);
static void assign_backtrace_functions(const char *newval, void *extra);
static bool check_recovery_target_timeline(char **newval, void **extra, GucSource source);
@@ -610,6 +611,7 @@ static int wal_block_size;
static bool data_checksums;
static bool integer_datetimes;
static bool assert_enabled;
+static bool in_hot_standby;
static char *recovery_target_timeline_string;
static char *recovery_target_string;
static char *recovery_target_xid_string;
@@ -1844,6 +1846,17 @@ static struct config_bool ConfigureNamesBool[] =
NULL, NULL, NULL
},
+ {
+ {"in_hot_standby", PGC_INTERNAL, PRESET_OPTIONS,
+ gettext_noop("Shows whether hot standby is currently active."),
+ NULL,
+ GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
+ },
+ &in_hot_standby,
+ false,
+ NULL, NULL, show_in_hot_standby
+ },
+
{
{"allow_system_table_mods", PGC_SUSET, DEVELOPER_OPTIONS,
gettext_noop("Allows modifications of the structure of system tables."),
@@ -6248,6 +6261,14 @@ BeginReportingGUCOptions(void)
reporting_enabled = true;
+ /*
+ * Hack for in_hot_standby: initialize with the value we're about to send.
+ * (This could be out of date by the time we actually send it, in which
+ * case the next ReportChangedGUCOptions call will send a duplicate
+ * report.)
+ */
+ in_hot_standby = RecoveryInProgress();
+
/* Transmit initial values of interesting variables */
for (i = 0; i < num_guc_variables; i++)
{
@@ -6280,6 +6301,23 @@ ReportChangedGUCOptions(void)
if (!reporting_enabled)
return;
+ /*
+ * Since in_hot_standby isn't actually changed by normal GUC actions, we
+ * need a hack to check whether a new value needs to be reported to the
+ * client. For speed, we rely on the assumption that it can never
+ * transition from false to true.
+ */
+ if (in_hot_standby && !RecoveryInProgress())
+ {
+ struct config_generic *record;
+
+ record = find_option("in_hot_standby", false, ERROR);
+ Assert(record != NULL);
+ record->status |= GUC_NEEDS_REPORT;
+ report_needed = true;
+ in_hot_standby = false;
+ }
+
/* Quick exit if no values have been changed */
if (!report_needed)
return;
@@ -11773,6 +11811,18 @@ show_data_directory_mode(void)
return buf;
}
+static const char *
+show_in_hot_standby(void)
+{
+ /*
+ * We display the actual state based on shared memory, so that this GUC
+ * reports up-to-date state if examined intra-query. The underlying
+ * variable in_hot_standby changes only when we transmit a new value to
+ * the client.
+ */
+ return RecoveryInProgress() ? "on" : "off";
+}
+
/*
* We split the input string, where commas separate function names
* and certain whitespace chars are ignored, into a \0-separated (and