diff options
author | Michael Paquier <michael@paquier.xyz> | 2024-10-29 15:35:19 +0900 |
---|---|---|
committer | Michael Paquier <michael@paquier.xyz> | 2024-10-29 15:35:19 +0900 |
commit | 14440d3b07af2241460eb268811cf54f8eee365f (patch) | |
tree | e601bd8b611438940955d4487368438df3e59057 /src/backend/commands/tablecmds.c | |
parent | 75f09cc460a3a1780df1dcd102f46e59779f9903 (diff) | |
download | postgresql-14440d3b07af2241460eb268811cf54f8eee365f.tar.gz postgresql-14440d3b07af2241460eb268811cf54f8eee365f.zip |
doc: Add better description for rewrite functions in event triggers
There are two functions that can be used in event triggers to get more
details about a rewrite happening on a relation. Both had a limited
documentation:
- pg_event_trigger_table_rewrite_reason() and
pg_event_trigger_table_rewrite_oid() were not mentioned in the main
event trigger section in the paragraph dedicated to the event
table_rewrite.
- pg_event_trigger_table_rewrite_reason() returns an integer which is a
bitmap of the reasons why a rewrite happens. There was no explanation
about the meaning of these values, forcing the reader to look at the
code to find out that these are defined in event_trigger.h.
While on it, let's add a comment in event_trigger.h where the
AT_REWRITE_* are defined, telling to update the documentation when
these values are changed.
Backpatch down to 13 as a consequence of 1ad23335f36b, where this area
of the documentation has been heavily reworked.
Author: Greg Sabino Mullane
Discussion: https://postgr.es/m/CAKAnmmL+Z6j-C8dAx1tVrnBmZJu+BSoc68WSg3sR+CVNjBCqbw@mail.gmail.com
Backpatch-through: 13
Diffstat (limited to 'src/backend/commands/tablecmds.c')
0 files changed, 0 insertions, 0 deletions