[PATCH] Add hint to wal_level errors for replication slots and pg_log_standby_snapshot

From: Joao Rito <joaovictor(dot)rito(at)gmail(dot)com>
To: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: [PATCH] Add hint to wal_level errors for replication slots and pg_log_standby_snapshot
Date: 2026-11-18 23:46:39
Message-ID: 20261118234639.520-1-joaovictor.rito@gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Two errors tell the user that wal_level must be at least "replica" but
give no hint on how to fix it. The similar errors for existing slots in
RestoreSlotFromDisk() already say:

Change "wal_level" to be "replica" or higher.

Add that hint to the error in CheckSlotRequirements() and to the one in
pg_log_standby_snapshot(). Since wal_level can only be changed at server
start, also tell the user to restart, using the wording of a hint in
xlogrecovery.c:

Restart the server after making the necessary configuration changes.

"replica" is enough for every caller of CheckSlotRequirements(),
including REPACK, which has its own check in
check_concurrent_repack_requirements() that also asks for "replica" or
higher.
---
Hi,

I may have missed something, so please correct me where I am wrong.

When wal_level is "minimal", two errors say that wal_level must be at least "replica", but give no hint on what to do:

ERROR: replication slots can only be used if "wal_level" >= "replica"
ERROR: pg_log_standby_snapshot() can only be used if "wal_level" >= "replica"

The errors for existing slots in RestoreSlotFromDisk() already have this hint:

HINT: Change "wal_level" to be "replica" or higher.

The attached patch adds that hint to the error in CheckSlotRequirements() and to the one in pg_log_standby_snapshot(). Because wal_level changes only at server start, I also added the sentence from a hint in xlogrecovery.c: "Restart the server after making the necessary configuration changes." The msgid of both errmsg lines does not change.

I looked at REPACK, which also reaches CheckSlotRequirements(). check_concurrent_repack_requirements() already requires "replica" or higher, so the hint is correct there too.

I tested on current master with --enable-cassert and --enable-tap-tests. With wal_level=minimal, both errors show the hint after the patch and not before. "make check" passed (243 tests), "make check" in src/test/recovery passed (695 tests), and pgindent shows no diff on the 2 files.

What I did not test: builds with --enable-nls and translations, meson, other platforms, an actual REPACK run, and the injection-point recovery tests that were skipped. I did not add a regression test, because I found no existing test that checks these messages, and a new TAP test seemed too heavy for this change.

Does this direction make sense? If the hint is redundant, or the wording should change, I am happy to adjust or drop the patch.

Thank you for your time.

src/backend/access/transam/xlogfuncs.c | 3 ++-
src/backend/replication/slot.c | 3 ++-
2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/backend/access/transam/xlogfuncs.c b/src/backend/access/transam/xlogfuncs.c
index 1f52bf7..4ec42c4 100644
--- a/src/backend/access/transam/xlogfuncs.c
+++ b/src/backend/access/transam/xlogfuncs.c
@@ -243,7 +243,8 @@ pg_log_standby_snapshot(PG_FUNCTION_ARGS)
if (!XLogStandbyInfoActive())
ereport(ERROR,
(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
- errmsg("pg_log_standby_snapshot() can only be used if \"wal_level\" >= \"replica\"")));
+ errmsg("pg_log_standby_snapshot() can only be used if \"wal_level\" >= \"replica\""),
+ errhint("Change \"wal_level\" to be \"replica\" or higher. Restart the server after making the necessary configuration changes.")));

recptr = LogStandbySnapshot();

diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c
index a311aee..64f4578 100644
--- a/src/backend/replication/slot.c
+++ b/src/backend/replication/slot.c
@@ -1690,7 +1690,8 @@ CheckSlotRequirements(bool repack)
if (wal_level < WAL_LEVEL_REPLICA)
ereport(ERROR,
(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
- errmsg("replication slots can only be used if \"wal_level\" >= \"replica\"")));
+ errmsg("replication slots can only be used if \"wal_level\" >= \"replica\""),
+ errhint("Change \"wal_level\" to be \"replica\" or higher. Restart the server after making the necessary configuration changes.")));
}

/*
--
2.39.5

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Chao Li 2026-11-18 23:51:07 Re: [PATCH] Reject duplicate SQL/JSON PASSING argument names
Previous Message Masahiko Sawada 2026-11-18 23:38:05 Re: reindexdb: Change quoting rule of --schema?