Skip to content

Commit 330410e

Browse files
committed
Fix comments related to table AMs
Incorrect function names were referenced. As this fixes some portions of tableam.h, that is mentioned in the docs as something to look at when implementing a table AM, backpatch down to 12 where this has been introduced. Author: Hironobu Suzuki Discussion: https://postgr.es/m/8fe6d672-28dd-3f1d-7aed-ac2f6d599d3f@interdb.jp Backpatch-through: 12
1 parent d3b642a commit 330410e

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

src/backend/access/heap/heapam.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1676,9 +1676,9 @@ heap_get_latest_tid(TableScanDesc sscan,
16761676
TransactionId priorXmax;
16771677

16781678
/*
1679-
* table_get_latest_tid verified that the passed in tid is valid. Assume
1680-
* that t_ctid links are valid however - there shouldn't be invalid ones
1681-
* in the table.
1679+
* table_tuple_get_latest_tid() verified that the passed in tid is valid.
1680+
* Assume that t_ctid links are valid however - there shouldn't be invalid
1681+
* ones in the table.
16821682
*/
16831683
Assert(ItemPointerIsValid(tid));
16841684

src/include/access/tableam.h

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -984,12 +984,12 @@ table_index_fetch_end(struct IndexFetchTableData *scan)
984984
* that tuple. Index AMs can use that to avoid returning that tid in future
985985
* searches.
986986
*
987-
* The difference between this function and table_fetch_row_version is that
988-
* this function returns the currently visible version of a row if the AM
989-
* supports storing multiple row versions reachable via a single index entry
990-
* (like heap's HOT). Whereas table_fetch_row_version only evaluates the
991-
* tuple exactly at `tid`. Outside of index entry ->table tuple lookups,
992-
* table_tuple_fetch_row_version is what's usually needed.
987+
* The difference between this function and table_tuple_fetch_row_version()
988+
* is that this function returns the currently visible version of a row if
989+
* the AM supports storing multiple row versions reachable via a single index
990+
* entry (like heap's HOT). Whereas table_tuple_fetch_row_version() only
991+
* evaluates the tuple exactly at `tid`. Outside of index entry ->table tuple
992+
* lookups, table_tuple_fetch_row_version() is what's usually needed.
993993
*/
994994
static inline bool
995995
table_index_fetch_tuple(struct IndexFetchTableData *scan,
@@ -1043,8 +1043,9 @@ table_tuple_fetch_row_version(Relation rel,
10431043
/*
10441044
* Verify that `tid` is a potentially valid tuple identifier. That doesn't
10451045
* mean that the pointed to row needs to exist or be visible, but that
1046-
* attempting to fetch the row (e.g. with table_get_latest_tid() or
1047-
* table_fetch_row_version()) should not error out if called with that tid.
1046+
* attempting to fetch the row (e.g. with table_tuple_get_latest_tid() or
1047+
* table_tuple_fetch_row_version()) should not error out if called with that
1048+
* tid.
10481049
*
10491050
* `scan` needs to have been started via table_beginscan().
10501051
*/
@@ -1177,8 +1178,8 @@ table_tuple_complete_speculative(Relation rel, TupleTableSlot *slot,
11771178
/*
11781179
* Insert multiple tuples into a table.
11791180
*
1180-
* This is like table_insert(), but inserts multiple tuples in one
1181-
* operation. That's often faster than calling table_insert() in a loop,
1181+
* This is like table_tuple_insert(), but inserts multiple tuples in one
1182+
* operation. That's often faster than calling table_tuple_insert() in a loop,
11821183
* because e.g. the AM can reduce WAL logging and page locking overhead.
11831184
*
11841185
* Except for taking `nslots` tuples as input, as an array of TupleTableSlots

0 commit comments

Comments
 (0)