database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-02 11:44:50 +03:00
Code

Fix comments related to table AMs

Browse Source 
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
This commit is contained in:
Michael Paquier 2020-07-14 13:17:34 +09:00
parent d3b642ad99
commit 330410ecad
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/backend/access/heap/heapam.c
View File

@ -1676,9 +1676,9 @@ heap_get_latest_tid(TableScanDesc sscan,
TransactionId priorXmax; TransactionId priorXmax;
/* /*
* table_get_latest_tid verified that the passed in tid is valid. Assume * table_tuple_get_latest_tid() verified that the passed in tid is valid.
* that t_ctid links are valid however - there shouldn't be invalid ones * Assume that t_ctid links are valid however - there shouldn't be invalid
* in the table. * ones in the table.
*/ */
Assert(ItemPointerIsValid(tid)); Assert(ItemPointerIsValid(tid));

21
src/include/access/tableam.h
View File

@ -984,12 +984,12 @@ table_index_fetch_end(struct IndexFetchTableData *scan)
* that tuple. Index AMs can use that to avoid returning that tid in future * that tuple. Index AMs can use that to avoid returning that tid in future
* searches. * searches.
* *
* The difference between this function and table_fetch_row_version is that * The difference between this function and table_tuple_fetch_row_version()
* this function returns the currently visible version of a row if the AM * is that this function returns the currently visible version of a row if
* supports storing multiple row versions reachable via a single index entry * the AM supports storing multiple row versions reachable via a single index
* (like heap's HOT). Whereas table_fetch_row_version only evaluates the * entry (like heap's HOT). Whereas table_tuple_fetch_row_version() only
* tuple exactly at `tid`. Outside of index entry ->table tuple lookups, * evaluates the tuple exactly at `tid`. Outside of index entry ->table tuple
* table_tuple_fetch_row_version is what's usually needed. * lookups, table_tuple_fetch_row_version() is what's usually needed.
*/ */
static inline bool static inline bool
table_index_fetch_tuple(struct IndexFetchTableData *scan, table_index_fetch_tuple(struct IndexFetchTableData *scan,
@ -1043,8 +1043,9 @@ table_tuple_fetch_row_version(Relation rel,
/* /*
* Verify that `tid` is a potentially valid tuple identifier. That doesn't * Verify that `tid` is a potentially valid tuple identifier. That doesn't
* mean that the pointed to row needs to exist or be visible, but that * mean that the pointed to row needs to exist or be visible, but that
* attempting to fetch the row (e.g. with table_get_latest_tid() or * attempting to fetch the row (e.g. with table_tuple_get_latest_tid() or
* table_fetch_row_version()) should not error out if called with that tid. * table_tuple_fetch_row_version()) should not error out if called with that
* tid.
* *
* `scan` needs to have been started via table_beginscan(). * `scan` needs to have been started via table_beginscan().
*/ */
@ -1177,8 +1178,8 @@ table_tuple_complete_speculative(Relation rel, TupleTableSlot *slot,
/* /*
* Insert multiple tuples into a table. * Insert multiple tuples into a table.
* *
* This is like table_insert(), but inserts multiple tuples in one * This is like table_tuple_insert(), but inserts multiple tuples in one
* operation. That's often faster than calling table_insert() in a loop, * operation. That's often faster than calling table_tuple_insert() in a loop,
* because e.g. the AM can reduce WAL logging and page locking overhead. * because e.g. the AM can reduce WAL logging and page locking overhead.
* *
* Except for taking `nslots` tuples as input, as an array of TupleTableSlots * Except for taking `nslots` tuples as input, as an array of TupleTableSlots