pgsql: doc: Add better description for rewrite functions in event trigg

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Add better description for rewrite functions in event trigg
Date: 2024-10-29 06:35:49
Message-ID: E1t5fpW-002y57-8j@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

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

Branch
------
REL_16_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/a1b859c6893af2314fa29f8ac3c8bc8f3ad418e5

Modified Files
--------------
doc/src/sgml/event-trigger.sgml | 5 +++++
doc/src/sgml/func.sgml | 8 ++++++--
src/include/commands/event_trigger.h | 6 ++++++
3 files changed, 17 insertions(+), 2 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Eisentraut 2024-10-29 09:33:32 pgsql: Add missing FATAL => 'all' to a use warnings in Perl
Previous Message Amit Kapila 2024-10-29 04:05:08 Re: pgsql: Change the default value of the streaming option to 'parallel'.