Skip to content

Add RecoveryStopsHook for extensions to handle custom WAL records #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 24, 2025
Merged

Add RecoveryStopsHook for extensions to handle custom WAL records #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/backend/access/transam/xlogrecovery.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2567,8 +2567,28 @@ recoveryStopsBefore(XLogReaderState *record)
return true;
}

/* Check RecoveryStopsHook for custom records */
if (RmgrIdIsCustom(XLogRecGetRmid(record)) && (RecoveryStopsBeforeHook != NULL))
{
stopsHere = RecoveryStopsBeforeHook(record, &recordXid, &recordXtime);

if (stopsHere)
{
recoveryStopAfter = false;
recoveryStopXid = recordXid;
recoveryStopLSN = InvalidXLogRecPtr;
recoveryStopTime = recordXtime;
recoveryStopName[0] = '\0';

ereport(LOG,
(errmsg("recovery stopping by hook before transaction %u, time %s",
recoveryStopXid,
timestamptz_to_str(recoveryStopTime))));
return true;
}
}
/* Otherwise we only consider stopping before COMMIT or ABORT records. */
if (XLogRecGetRmid(record) != RM_XACT_ID)
else if (XLogRecGetRmid(record) != RM_XACT_ID)
return false;

xact_info = XLogRecGetInfo(record) & XLOG_XACT_OPMASK;
Expand Down Expand Up @@ -4506,6 +4526,8 @@ GetXLogReplayRecPtr(TimeLineID *replayTLI)

GetReplayXlogPtrHookType GetReplayXlogPtrHook = NULL;

RecoveryStopsBeforeHookType RecoveryStopsBeforeHook = NULL;

/*
* Get effective latest redo apply position.
*
Expand Down
10 changes: 10 additions & 0 deletions src/include/access/xlogrecovery.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ typedef enum RecoveryPauseState

typedef XLogRecPtr (*GetReplayXlogPtrHookType) (void);

typedef bool (*RecoveryStopsBeforeHookType) (XLogReaderState *record,
TransactionId *recordXid,
TimestampTz *recordXtime);

/* User-settable GUC parameters */
extern PGDLLIMPORT bool recoveryTargetInclusive;
extern PGDLLIMPORT int recoveryTargetAction;
Expand Down Expand Up @@ -81,6 +85,12 @@ extern PGDLLIMPORT bool StandbyMode;
/* Hook for extensions to tune replay xlog pointer */
extern PGDLLIMPORT GetReplayXlogPtrHookType GetReplayXlogPtrHook;

/*
* Hook for extensions to be able to decides to stop applying the WAL files
* based on custom WAL records.
*/
extern PGDLLIMPORT RecoveryStopsBeforeHookType RecoveryStopsBeforeHook;

extern Size XLogRecoveryShmemSize(void);
extern void XLogRecoveryShmemInit(void);

Expand Down