Thread: outdated comment in table_tuple_update definition

Hello

I noticed that the comment for the table_tuple_update function (src/include/access/tableam.h) describes the
update_indexesparameter as boolean:
 

 *  update_indexes - in success cases this is set to true if new index entries
 *        are required for this tuple
 
Although this parameter is an enum of three values.

I found that the parameter type was changed by commit 19d8e23 (Ignore BRIN indexes when checking for HOT updates), but
thecomment was not updated. Looks like oversight.
 

  *  update_indexes - in successful cases, used to determine which index types
  *      require new index entries for this tuple

Something like this?

regards, Sergei

On Fri, Feb 7, 2025 at 3:08 AM Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > On 6 Feb 2025, at 20:00, Sergei Kornilov <sk@zsrv.org> wrote:
>
> > I found that the parameter type was changed by commit 19d8e23 (Ignore BRIN indexes when checking for HOT updates),
butthe comment was not updated. Looks like oversight. 
>
> I agree with your analysis, unless objected to I'll apply the attached in
> shortly to update the documentation.

+ *  update_indexes - in successful cases this indicates the index types
+ * which require new index entries for this tuple

AFAIK, summarising indexes may not necessarily always need a new
entry. So the following sentence looks more accurate
 in successful cases, this indicates the types of indexes (summarising
vs non-summarising) which need an update based on this tuple. The text
in the parenthese would clarify "index types", but if it's too
verbose, it may be omitted.

--
Best Wishes,
Ashutosh Bapat