Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2103955

Browse files
committed
tableam: comment improvements.
Author: Brad DeJong Discussion: https://postgr.es/m/CAJnrtnxDYOQFsDfWz2iri0T_fFL2ZbbzgCOE=4yaMcszgcsf4A@mail.gmail.com Backpatch: 12-
1 parent 1c1602b commit 2103955

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

src/include/access/tableam.h

+17-18
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ typedef struct TableAmRoutine
294294
*
295295
* *all_dead, if all_dead is not NULL, should be set to true by
296296
* index_fetch_tuple iff it is guaranteed that no backend needs to see
297-
* that tuple. Index AMs can use that do avoid returning that tid in
297+
* that tuple. Index AMs can use that to avoid returning that tid in
298298
* future searches.
299299
*/
300300
bool (*index_fetch_tuple) (struct IndexFetchTableData *scan,
@@ -482,9 +482,9 @@ typedef struct TableAmRoutine
482482
double *tups_recently_dead);
483483

484484
/*
485-
* React to VACUUM command on the relation. The VACUUM might be user
486-
* triggered or by autovacuum. The specific actions performed by the AM
487-
* will depend heavily on the individual AM.
485+
* React to VACUUM command on the relation. The VACUUM can be
486+
* triggered by a user or by autovacuum. The specific actions
487+
* performed by the AM will depend heavily on the individual AM.
488488
*
489489
* On entry a transaction is already established, and the relation is
490490
* locked with a ShareUpdateExclusive lock.
@@ -661,7 +661,7 @@ typedef struct TableAmRoutine
661661
* false if the sample scan is finished, true otherwise. `scan` was
662662
* started via table_beginscan_sampling().
663663
*
664-
* Typically this will first determine the target block by call the
664+
* Typically this will first determine the target block by calling the
665665
* TsmRoutine's NextSampleBlock() callback if not NULL, or alternatively
666666
* perform a sequential scan over all blocks. The determined block is
667667
* then typically read and pinned.
@@ -679,7 +679,7 @@ typedef struct TableAmRoutine
679679
*
680680
* Currently it is required to implement this interface, as there's no
681681
* alternative way (contrary e.g. to bitmap scans) to implement sample
682-
* scans. If infeasible to implement the AM may raise an error.
682+
* scans. If infeasible to implement, the AM may raise an error.
683683
*/
684684
bool (*scan_sample_next_block) (TableScanDesc scan,
685685
struct SampleScanState *scanstate);
@@ -1084,18 +1084,18 @@ table_compute_xid_horizon_for_tuples(Relation rel,
10841084
/*
10851085
* Insert a tuple from a slot into table AM routine.
10861086
*
1087-
* The options bitmask allows to specify options that allow to change the
1088-
* behaviour of the AM. Several options might be ignored by AMs not supporting
1089-
* them.
1087+
* The options bitmask allows the caller to specify options that may change the
1088+
* behaviour of the AM. The AM will ignore options that it does not support.
10901089
*
10911090
* If the TABLE_INSERT_SKIP_WAL option is specified, the new tuple doesn't
10921091
* need to be logged to WAL, even for a non-temp relation. It is the AMs
10931092
* choice whether this optimization is supported.
10941093
*
10951094
* If the TABLE_INSERT_SKIP_FSM option is specified, AMs are free to not reuse
10961095
* free space in the relation. This can save some cycles when we know the
1097-
* relation is new and doesn't contain useful amounts of free space. It's
1098-
* commonly passed directly to RelationGetBufferForTuple, see for more info.
1096+
* relation is new and doesn't contain useful amounts of free space.
1097+
* TABLE_INSERT_SKIP_FSM is commonly passed directly to
1098+
* RelationGetBufferForTuple. See that method for more information.
10991099
*
11001100
* TABLE_INSERT_FROZEN should only be specified for inserts into
11011101
* relfilenodes created during the current subtransaction and when
@@ -1111,7 +1111,6 @@ table_compute_xid_horizon_for_tuples(Relation rel,
11111111
* Note that most of these options will be applied when inserting into the
11121112
* heap's TOAST table, too, if the tuple requires any out-of-line data.
11131113
*
1114-
*
11151114
* The BulkInsertState object (if any; bistate can be NULL for default
11161115
* behavior) is also just passed through to RelationGetBufferForTuple. If
11171116
* `bistate` is provided, table_finish_bulk_insert() needs to be called.
@@ -1383,13 +1382,13 @@ table_relation_copy_data(Relation rel, const RelFileNode *newrnode)
13831382
* Additional Input parameters:
13841383
* - use_sort - if true, the table contents are sorted appropriate for
13851384
* `OldIndex`; if false and OldIndex is not InvalidOid, the data is copied
1386-
* in that index's order; if false and OidIndex is InvalidOid, no sorting is
1385+
* in that index's order; if false and OldIndex is InvalidOid, no sorting is
13871386
* performed
1388-
* - OidIndex - see use_sort
1387+
* - OldIndex - see use_sort
13891388
* - OldestXmin - computed by vacuum_set_xid_limits(), even when
13901389
* not needed for the relation's AM
1391-
* - *xid_cutoff - dito
1392-
* - *multi_cutoff - dito
1390+
* - *xid_cutoff - ditto
1391+
* - *multi_cutoff - ditto
13931392
*
13941393
* Output parameters:
13951394
* - *xid_cutoff - rel's new relfrozenxid value, may be invalid
@@ -1416,10 +1415,10 @@ table_relation_copy_for_cluster(Relation OldTable, Relation NewTable,
14161415
}
14171416

14181417
/*
1419-
* Perform VACUUM on the relation. The VACUUM can be user-triggered or by
1418+
* Perform VACUUM on the relation. The VACUUM can be triggered by a user or by
14201419
* autovacuum. The specific actions performed by the AM will depend heavily on
14211420
* the individual AM.
1422-
1421+
*
14231422
* On entry a transaction needs to already been established, and the
14241423
* table is locked with a ShareUpdateExclusive lock.
14251424
*

0 commit comments

Comments
 (0)