From 50ba65e73325cf55fedb3e1f14673d816726923b Mon Sep 17 00:00:00 2001 From: Robert Haas Date: Thu, 20 Mar 2025 13:47:55 -0400 Subject: [PATCH] Add an additional hook for EXPLAIN option validation. Commit c65bc2e1d14a2d4daed7c1921ac518f2c5ac3d17 made it possible for loadable modules to add EXPLAIN options. Normally, any necessary validation can be performed by the hook function passed to RegisterExtensionExplainOption, but if a loadable module wants to sanity check options against each other, that needs to be done after the entire options list has been processed. So, add an additional hook for that purpose. Author: Sami Imseih Reviewed-by: Robert Haas Reviewed-by: Andrei Lepikhov Reviewed-by: Tom Lane Discussion: http://postgr.es/m/CAA5RZ0vOcJF91O2e5AQN+V6guMNLMhJx83dxALf-iUZ-hLGO_Q@mail.gmail.com --- src/backend/commands/explain_state.c | 7 +++++++ src/include/commands/explain_state.h | 5 +++++ 2 files changed, 12 insertions(+) diff --git a/src/backend/commands/explain_state.c b/src/backend/commands/explain_state.c index 1d4be3c18ac..60d98d63a62 100644 --- a/src/backend/commands/explain_state.c +++ b/src/backend/commands/explain_state.c @@ -37,6 +37,9 @@ #include "commands/explain.h" #include "commands/explain_state.h" +/* Hook to perform additional EXPLAIN options validation */ +explain_validate_options_hook_type explain_validate_options_hook = NULL; + typedef struct { const char *option_name; @@ -196,6 +199,10 @@ ParseExplainOptionList(ExplainState *es, List *options, ParseState *pstate) /* if the summary was not set explicitly, set default value */ es->summary = (summary_set) ? es->summary : es->analyze; + + /* plugin specific option validation */ + if (explain_validate_options_hook) + (*explain_validate_options_hook) (es, options, pstate); } /* diff --git a/src/include/commands/explain_state.h b/src/include/commands/explain_state.h index 925097492b9..32728f5d1a1 100644 --- a/src/include/commands/explain_state.h +++ b/src/include/commands/explain_state.h @@ -78,6 +78,11 @@ typedef struct ExplainState typedef void (*ExplainOptionHandler) (ExplainState *, DefElem *, ParseState *); +/* Hook to perform additional EXPLAIN options validation */ +typedef void (*explain_validate_options_hook_type) (struct ExplainState *es, List *options, + ParseState *pstate); +extern PGDLLIMPORT explain_validate_options_hook_type explain_validate_options_hook; + extern ExplainState *NewExplainState(void); extern void ParseExplainOptionList(ExplainState *es, List *options, ParseState *pstate);