Add a berief general comment on BTScanInsertData's nextkey and backward

From: Yugo Nagata <nagata(at)sraoss(dot)co(dot)jp>
To: Pgsql Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Add a berief general comment on BTScanInsertData's nextkey and backward
Date: 2025-11-18 07:28:01
Message-ID: 20251118162801.27cb13408cb3c9dd3a72cf7d@sraoss.co.jp
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

While reading the nbtree codes, I noticed that the comments on
BTScanInsertData no longer describes the meaning of the nextkey and
backward fields. The comment curently only says:

* See comments in _bt_first for an explanation of the nextkey and backward
* fields.

Detailed comments used to exit here, but they were removed by
c9c0589fda0e, I guess, because the semantic changed when
the optimazation for backward scans was introduced. However, having
a brief, general description here is still useful for readers.

I've attached a patch that adds the following comment:

+ * nextkey determines how the scankey's boundary is interpreted, and backward
+ * indicates a backward scan. See comments in _bt_first for a more detailed
+ * explanation of these fields.

What do think?

Regards,
Yugo Nagata

--
Yugo Nagata <nagata(at)sraoss(dot)co(dot)jp>

Attachment Content-Type Size
add_brief_general_comment_on_BTScanInsertData_nextkey.patch text/x-diff 813 bytes

Browse pgsql-hackers by date

  From Date Subject
Next Message Akshay Joshi 2025-11-18 08:03:10 Re: [PATCH] Add pg_get_database_ddl() function to reconstruct CREATE DATABASE statement
Previous Message jian he 2025-11-18 07:22:09 Re: misleading error message in DefineIndex