commit 0fe8e91f90f80c2a4c19ee371079410bd1b3a414 Author: Mikhail Gribkov Commit: Mikhail Gribkov [PATCH v1_а_NF] Add GUC for temporarily disabling event triggers In order to troubleshoot misbehaving or buggy event triggers, the documented advice is to enter single-user mode. In an attempt to reduce the number of situations where single-user mode is required for non-extraordinary maintenance, this GUC allows to temporarily suspending event triggers. This was extracted from a larger patchset which aimed at supporting event triggers on login events. The very this version (_a) is a back-porting of an extracted patch to the login event fork. The GUC patch is curerntly supported by Daniel Gustafsson in this thread: https://www.postgresql.org/message-id/9140106E-F9BF-4D85-8FC8-F2D3C094A6D9%40yesql.se diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 24b1624bad..ddb70a4adc 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -9381,6 +9381,25 @@ SET XML OPTION { DOCUMENT | CONTENT }; + + ignore_event_trigger (enum) + + ignore_event_trigger + configuration parameter + + + + + Allows to temporarily disable event triggers from executing in order + to troubleshoot and repair faulty event triggers. The default value + is none, with which all event triggers are enabled. + When set to all then all event triggers will be + disabled. Only superusers and users with the appropriate + SET privilege can change this setting. + + + + diff --git a/doc/src/sgml/ref/create_event_trigger.sgml b/doc/src/sgml/ref/create_event_trigger.sgml index 22c8119198..f6922c3de3 100644 --- a/doc/src/sgml/ref/create_event_trigger.sgml +++ b/doc/src/sgml/ref/create_event_trigger.sgml @@ -123,7 +123,9 @@ CREATE EVENT TRIGGER name Event triggers are disabled in single-user mode (see ). If an erroneous event trigger disables the database so much that you can't even drop the trigger, restart in - single-user mode and you'll be able to do that. + single-user mode and you'll be able to do that. Event triggers can also be + temporarily disabled for such troubleshooting, see + . diff --git a/src/backend/commands/event_trigger.c b/src/backend/commands/event_trigger.c index 6971a5474a..ce6b089ee1 100644 --- a/src/backend/commands/event_trigger.c +++ b/src/backend/commands/event_trigger.c @@ -76,6 +76,9 @@ typedef struct EventTriggerQueryState static EventTriggerQueryState *currentEventTriggerState = NULL; +/* GUC parameter */ +int ignore_event_trigger = IGNORE_EVENT_TRIGGER_NONE; + /* Support for dropped objects */ typedef struct SQLDropObject { @@ -104,6 +107,7 @@ static void validate_table_rewrite_tags(const char *filtervar, List *taglist); static void EventTriggerInvoke(List *fn_oid_list, EventTriggerData *trigdata); static const char *stringify_grant_objtype(ObjectType objtype); static const char *stringify_adefprivs_objtype(ObjectType objtype); +static bool ignore_event_trigger_check(EventTriggerEvent event); /* * Create an event trigger. @@ -670,8 +674,11 @@ EventTriggerDDLCommandStart(Node *parsetree) * wherein event triggers are disabled. (Or we could implement * heapscan-and-sort logic for that case, but having disaster recovery * scenarios depend on code that's otherwise untested isn't appetizing.) + * + * Additionally, event triggers can be disabled with a superuser-only GUC + * to make fixing database easier as per 1 above. */ - if (!IsUnderPostmaster) + if (!IsUnderPostmaster || ignore_event_trigger_check(EVT_DDLCommandStart)) return; runlist = EventTriggerCommonSetup(parsetree, @@ -705,9 +712,9 @@ EventTriggerDDLCommandEnd(Node *parsetree) /* * See EventTriggerDDLCommandStart for a discussion about why event - * triggers are disabled in single user mode. + * triggers are disabled in single user mode or via GUC. */ - if (!IsUnderPostmaster) + if (!IsUnderPostmaster || ignore_event_trigger_check(EVT_DDLCommandEnd)) return; /* @@ -753,9 +760,9 @@ EventTriggerSQLDrop(Node *parsetree) /* * See EventTriggerDDLCommandStart for a discussion about why event - * triggers are disabled in single user mode. + * triggers are disabled in single user mode or via a GUC. */ - if (!IsUnderPostmaster) + if (!IsUnderPostmaster || ignore_event_trigger_check(EVT_SQLDrop)) return; /* @@ -825,7 +832,7 @@ EventTriggerOnLogin(void) * See EventTriggerDDLCommandStart for a discussion about why event * triggers are disabled in single user mode. */ - if (!IsUnderPostmaster || !OidIsValid(MyDatabaseId)) + if (!IsUnderPostmaster || !OidIsValid(MyDatabaseId) || ignore_event_trigger_check(EVT_Login)) return; StartTransactionCommand(); @@ -864,9 +871,9 @@ EventTriggerTableRewrite(Node *parsetree, Oid tableOid, int reason) /* * See EventTriggerDDLCommandStart for a discussion about why event - * triggers are disabled in single user mode. + * triggers are disabled in single user mode or via a GUC. */ - if (!IsUnderPostmaster) + if (!IsUnderPostmaster || ignore_event_trigger_check(EVT_TableRewrite)) return; /* @@ -2228,3 +2235,22 @@ stringify_adefprivs_objtype(ObjectType objtype) return "???"; /* keep compiler quiet */ } + + +/* + * Checks whether the specified event is ignored by the ignore_event_trigger + * GUC or not. Currently, the GUC only supports ignoring all or nothing but + * that might change so the function takes an event to aid that. + */ +static bool +ignore_event_trigger_check(EventTriggerEvent event) +{ + (void) event; /* unused parameter */ + + if (ignore_event_trigger == IGNORE_EVENT_TRIGGER_ALL) + return true; + + /* IGNORE_EVENT_TRIGGER_NONE */ + return false; + +} diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index 349dd6a537..12f65c2f5b 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -36,6 +36,7 @@ #include "catalog/namespace.h" #include "catalog/storage.h" #include "commands/async.h" +#include "commands/event_trigger.h" #include "commands/tablespace.h" #include "commands/trigger.h" #include "commands/user.h" @@ -446,6 +447,12 @@ static const struct config_enum_entry wal_compression_options[] = { {NULL, 0, false} }; +static const struct config_enum_entry ignore_event_trigger_options[] = { + {"none", IGNORE_EVENT_TRIGGER_NONE, false}, + {"all", IGNORE_EVENT_TRIGGER_ALL, false}, + {NULL, 0, false} +}; + /* * Options for enum values stored in other modules */ @@ -4724,6 +4731,16 @@ struct config_enum ConfigureNamesEnum[] = NULL, NULL, NULL }, + { + {"ignore_event_trigger", PGC_SUSET, CLIENT_CONN_STATEMENT, + gettext_noop("Disable event triggers for the duration of the session."), + NULL + }, + &ignore_event_trigger, + IGNORE_EVENT_TRIGGER_NONE, ignore_event_trigger_options, + NULL, NULL, NULL + }, + { {"wal_level", PGC_POSTMASTER, WAL_SETTINGS, gettext_noop("Sets the level of information written to the WAL."), diff --git a/src/include/commands/event_trigger.h b/src/include/commands/event_trigger.h index c9efee59bf..7144b67761 100644 --- a/src/include/commands/event_trigger.h +++ b/src/include/commands/event_trigger.h @@ -29,6 +29,14 @@ typedef struct EventTriggerData CommandTag tag; } EventTriggerData; +typedef enum ignore_event_trigger_events +{ + IGNORE_EVENT_TRIGGER_NONE, + IGNORE_EVENT_TRIGGER_ALL +} IgnoreEventTriggersEvents; + +extern PGDLLIMPORT int ignore_event_trigger; + #define AT_REWRITE_ALTER_PERSISTENCE 0x01 #define AT_REWRITE_DEFAULT_VAL 0x02 #define AT_REWRITE_COLUMN_REWRITE 0x04 diff --git a/src/test/regress/expected/event_trigger.out b/src/test/regress/expected/event_trigger.out index 433f5f6e95..2fc75e44ea 100644 --- a/src/test/regress/expected/event_trigger.out +++ b/src/test/regress/expected/event_trigger.out @@ -614,6 +614,27 @@ SELECT DROP EVENT TRIGGER start_rls_command; DROP EVENT TRIGGER end_rls_command; DROP EVENT TRIGGER sql_drop_command; +-- Check the GUC for disabling event triggers +CREATE FUNCTION test_event_trigger_guc() RETURNS event_trigger +LANGUAGE plpgsql AS $$ +DECLARE + obj record; +BEGIN + FOR obj IN SELECT * FROM pg_event_trigger_dropped_objects() + LOOP + RAISE NOTICE '% dropped %', tg_tag, obj.object_type; + END LOOP; +END; +$$; +CREATE EVENT TRIGGER test_event_trigger_guc + ON sql_drop + WHEN TAG IN ('DROP POLICY') EXECUTE FUNCTION test_event_trigger_guc(); +CREATE POLICY pguc ON event_trigger_test USING (FALSE); +DROP POLICY pguc ON event_trigger_test; +NOTICE: DROP POLICY dropped policy +SET ignore_event_trigger = 'all'; +CREATE POLICY pguc ON event_trigger_test USING (FALSE); +DROP POLICY pguc ON event_trigger_test; -- Login event triggers CREATE TABLE user_logins(id serial, who text); GRANT SELECT ON user_logins TO public; diff --git a/src/test/regress/sql/event_trigger.sql b/src/test/regress/sql/event_trigger.sql index 3371ee07c4..dfc835c913 100644 --- a/src/test/regress/sql/event_trigger.sql +++ b/src/test/regress/sql/event_trigger.sql @@ -472,6 +472,28 @@ DROP EVENT TRIGGER start_rls_command; DROP EVENT TRIGGER end_rls_command; DROP EVENT TRIGGER sql_drop_command; +-- Check the GUC for disabling event triggers +CREATE FUNCTION test_event_trigger_guc() RETURNS event_trigger +LANGUAGE plpgsql AS $$ +DECLARE + obj record; +BEGIN + FOR obj IN SELECT * FROM pg_event_trigger_dropped_objects() + LOOP + RAISE NOTICE '% dropped %', tg_tag, obj.object_type; + END LOOP; +END; +$$; +CREATE EVENT TRIGGER test_event_trigger_guc + ON sql_drop + WHEN TAG IN ('DROP POLICY') EXECUTE FUNCTION test_event_trigger_guc(); + +CREATE POLICY pguc ON event_trigger_test USING (FALSE); +DROP POLICY pguc ON event_trigger_test; +SET ignore_event_trigger = 'all'; +CREATE POLICY pguc ON event_trigger_test USING (FALSE); +DROP POLICY pguc ON event_trigger_test; + -- Login event triggers CREATE TABLE user_logins(id serial, who text); GRANT SELECT ON user_logins TO public;