postgresql/src/include/commands
Michael Paquier 14440d3b07 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 1ad23335f3, 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
2024-10-29 15:35:19 +09:00
..
alter.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
async.h Apply PGDLLIMPORT markings broadly. 2022-04-08 08:16:38 -04:00
cluster.h Remove "recheck" argument from check_index_is_clusterable() 2022-04-13 15:32:35 +09:00
collationcmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
comment.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
conversioncmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
copy.h Add header matching mode to COPY FROM 2022-03-30 09:02:31 +02:00
copyfrom_internal.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
createas.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
dbcommands.h Database-level collation version tracking 2022-02-14 08:27:26 +01:00
dbcommands_xlog.h Add new block-by-block strategy for CREATE DATABASE. 2022-03-29 11:48:36 -04:00
defrem.h Fix CREATE DATABASE so we can pg_upgrade DBs with OIDs above 2^31. 2022-11-04 10:39:52 -04:00
discard.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
event_trigger.h doc: Add better description for rewrite functions in event triggers 2024-10-29 15:35:19 +09:00
explain.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
extension.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
lockcmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
matview.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
policy.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
portalcmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
prepare.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
proclang.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
progress.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
publicationcmds.h Pre-beta mechanical code beautification. 2022-05-12 15:17:30 -04:00
schemacmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
seclabel.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
sequence.h Revert "Logical decoding of sequences" 2022-04-07 20:06:36 +02:00
subscriptioncmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
tablecmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
tablespace.h Apply PGDLLIMPORT markings broadly. 2022-04-08 08:16:38 -04:00
trigger.h Fix concurrent update issues with MERGE. 2023-03-13 10:23:42 +00:00
typecmds.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
user.h Apply PGDLLIMPORT markings broadly. 2022-04-08 08:16:38 -04:00
vacuum.h Apply PGDLLIMPORT markings broadly. 2022-04-08 08:16:38 -04:00
variable.h Update copyright for 2022 2022-01-07 19:04:57 -05:00
view.h Update copyright for 2022 2022-01-07 19:04:57 -05:00