postgresql/src/include/commands
Michael Paquier bca802600c 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:21 +09:00
..
alter.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
async.h Send NOTIFY signals during CommitTransaction. 2021-09-14 17:18:25 -04:00
cluster.h Refactor option handling of CLUSTER, REINDEX and VACUUM 2021-01-18 14:03:10 +09:00
collationcmds.h Revert per-index collation version tracking feature. 2021-05-07 21:10:11 +12:00
comment.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
conversioncmds.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
copy.h Initial pgindent and pgperltidy run for v14. 2021-05-12 13:14:10 -04:00
copyfrom_internal.h Initial pgindent and pgperltidy run for v14. 2021-05-12 13:14:10 -04:00
createas.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
dbcommands.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
dbcommands_xlog.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
defrem.h Initial pgindent and pgperltidy run for v14. 2021-05-12 13:14:10 -04:00
discard.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
event_trigger.h doc: Add better description for rewrite functions in event triggers 2024-10-29 15:35:21 +09:00
explain.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
extension.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
lockcmds.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
matview.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
policy.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
portalcmds.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
prepare.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
proclang.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
progress.h Split backend status and progress related functionality out of pgstat.c. 2021-04-03 11:42:52 -07:00
publicationcmds.h Invalidate all partitions for a partitioned table in publication. 2021-09-22 08:13:37 +05:30
schemacmds.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
seclabel.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
sequence.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
subscriptioncmds.h Allow multiple xacts during table sync in logical replication. 2021-02-12 07:41:51 +05:30
tablecmds.h Fix toast rewrites in logical decoding. 2021-08-25 10:10:50 +05:30
tablespace.h Allow "in place" tablespaces. 2022-07-27 07:55:13 +02:00
trigger.h Fix ENABLE/DISABLE TRIGGER to handle recursion correctly 2022-08-05 09:47:11 +02:00
typecmds.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
user.h Phase 2 of pgindent updates. 2017-06-21 15:19:25 -04:00
vacuum.h Don't overlook indexes during parallel VACUUM. 2021-11-02 12:06:16 -07:00
variable.h Update copyright for 2021 2021-01-02 13:06:25 -05:00
view.h Update copyright for 2021 2021-01-02 13:06:25 -05:00