PostgreSQL Source Code  git master
tableamapi.c File Reference
#include "postgres.h"
#include "access/heapam.h"
#include "access/htup_details.h"
#include "access/tableam.h"
#include "access/xact.h"
#include "catalog/pg_am.h"
#include "catalog/pg_proc.h"
#include "commands/defrem.h"
#include "miscadmin.h"
#include "utils/fmgroids.h"
#include "utils/guc_hooks.h"
#include "utils/memutils.h"
#include "utils/syscache.h"
Include dependency graph for tableamapi.c:

Go to the source code of this file.

Functions

const TableAmRoutineGetTableAmRoutine (Oid amhandler)
 
bool check_default_table_access_method (char **newval, void **extra, GucSource source)
 

Function Documentation

◆ check_default_table_access_method()

bool check_default_table_access_method ( char **  newval,
void **  extra,
GucSource  source 
)

Definition at line 112 of file tableamapi.c.

113 {
114  if (**newval == '\0')
115  {
116  GUC_check_errdetail("%s cannot be empty.",
117  "default_table_access_method");
118  return false;
119  }
120 
121  if (strlen(*newval) >= NAMEDATALEN)
122  {
123  GUC_check_errdetail("%s is too long (maximum %d characters).",
124  "default_table_access_method", NAMEDATALEN - 1);
125  return false;
126  }
127 
128  /*
129  * If we aren't inside a transaction, or not connected to a database, we
130  * cannot do the catalog access necessary to verify the method. Must
131  * accept the value on faith.
132  */
134  {
135  if (!OidIsValid(get_table_am_oid(*newval, true)))
136  {
137  /*
138  * When source == PGC_S_TEST, don't throw a hard error for a
139  * nonexistent table access method, only a NOTICE. See comments in
140  * guc.h.
141  */
142  if (source == PGC_S_TEST)
143  {
144  ereport(NOTICE,
145  (errcode(ERRCODE_UNDEFINED_OBJECT),
146  errmsg("table access method \"%s\" does not exist",
147  *newval)));
148  }
149  else
150  {
151  GUC_check_errdetail("Table access method \"%s\" does not exist.",
152  *newval);
153  return false;
154  }
155  }
156  }
157 
158  return true;
159 }
Oid get_table_am_oid(const char *amname, bool missing_ok)
Definition: amcmds.c:173
#define OidIsValid(objectId)
Definition: c.h:711
int errcode(int sqlerrcode)
Definition: elog.c:695
int errmsg(const char *fmt,...)
Definition: elog.c:906
#define NOTICE
Definition: elog.h:31
#define ereport(elevel,...)
Definition: elog.h:145
Oid MyDatabaseId
Definition: globals.c:89
#define newval
#define GUC_check_errdetail
Definition: guc.h:434
@ PGC_S_TEST
Definition: guc.h:121
#define NAMEDATALEN
static rewind_source * source
Definition: pg_rewind.c:81
#define InvalidOid
Definition: postgres_ext.h:36
bool IsTransactionState(void)
Definition: xact.c:377

References ereport, errcode(), errmsg(), get_table_am_oid(), GUC_check_errdetail, InvalidOid, IsTransactionState(), MyDatabaseId, NAMEDATALEN, newval, NOTICE, OidIsValid, PGC_S_TEST, and source.

◆ GetTableAmRoutine()

const TableAmRoutine* GetTableAmRoutine ( Oid  amhandler)

Definition at line 35 of file tableamapi.c.

36 {
37  Datum datum;
38  const TableAmRoutine *routine;
39 
40  datum = OidFunctionCall0(amhandler);
41  routine = (TableAmRoutine *) DatumGetPointer(datum);
42 
43  if (routine == NULL || !IsA(routine, TableAmRoutine))
44  elog(ERROR, "table access method handler %u did not return a TableAmRoutine struct",
45  amhandler);
46 
47  /*
48  * Assert that all required callbacks are present. That makes it a bit
49  * easier to keep AMs up to date, e.g. when forward porting them to a new
50  * major version.
51  */
52  Assert(routine->scan_begin != NULL);
53  Assert(routine->scan_end != NULL);
54  Assert(routine->scan_rescan != NULL);
55  Assert(routine->scan_getnextslot != NULL);
56 
57  Assert(routine->parallelscan_estimate != NULL);
58  Assert(routine->parallelscan_initialize != NULL);
59  Assert(routine->parallelscan_reinitialize != NULL);
60 
61  Assert(routine->index_fetch_begin != NULL);
62  Assert(routine->index_fetch_reset != NULL);
63  Assert(routine->index_fetch_end != NULL);
64  Assert(routine->index_fetch_tuple != NULL);
65 
66  Assert(routine->tuple_fetch_row_version != NULL);
67  Assert(routine->tuple_tid_valid != NULL);
68  Assert(routine->tuple_get_latest_tid != NULL);
69  Assert(routine->tuple_satisfies_snapshot != NULL);
70  Assert(routine->index_delete_tuples != NULL);
71 
72  Assert(routine->tuple_insert != NULL);
73 
74  /*
75  * Could be made optional, but would require throwing error during
76  * parse-analysis.
77  */
78  Assert(routine->tuple_insert_speculative != NULL);
79  Assert(routine->tuple_complete_speculative != NULL);
80 
81  Assert(routine->multi_insert != NULL);
82  Assert(routine->tuple_delete != NULL);
83  Assert(routine->tuple_update != NULL);
84  Assert(routine->tuple_lock != NULL);
85 
86  Assert(routine->relation_set_new_filelocator != NULL);
88  Assert(routine->relation_copy_data != NULL);
89  Assert(routine->relation_copy_for_cluster != NULL);
90  Assert(routine->relation_vacuum != NULL);
91  Assert(routine->scan_analyze_next_block != NULL);
92  Assert(routine->scan_analyze_next_tuple != NULL);
93  Assert(routine->index_build_range_scan != NULL);
94  Assert(routine->index_validate_scan != NULL);
95 
96  Assert(routine->relation_size != NULL);
97  Assert(routine->relation_needs_toast_table != NULL);
98 
99  Assert(routine->relation_estimate_size != NULL);
100 
101  /* optional, but one callback implies presence of the other */
102  Assert((routine->scan_bitmap_next_block == NULL) ==
103  (routine->scan_bitmap_next_tuple == NULL));
104  Assert(routine->scan_sample_next_block != NULL);
105  Assert(routine->scan_sample_next_tuple != NULL);
106 
107  return routine;
108 }
#define ERROR
Definition: elog.h:35
#define OidFunctionCall0(functionId)
Definition: fmgr.h:678
Assert(fmt[strlen(fmt) - 1] !='\n')
#define IsA(nodeptr, _type_)
Definition: nodes.h:168
uintptr_t Datum
Definition: postgres.h:412
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:660
Size(* parallelscan_initialize)(Relation rel, ParallelTableScanDesc pscan)
Definition: tableam.h:376
void(* relation_copy_data)(Relation rel, const RelFileLocator *newrlocator)
Definition: tableam.h:600
bool(* scan_sample_next_tuple)(TableScanDesc scan, struct SampleScanState *scanstate, TupleTableSlot *slot)
Definition: tableam.h:849
void(* index_fetch_reset)(struct IndexFetchTableData *data)
Definition: tableam.h:406
void(* tuple_complete_speculative)(Relation rel, TupleTableSlot *slot, uint32 specToken, bool succeeded)
Definition: tableam.h:500
bool(* scan_bitmap_next_tuple)(TableScanDesc scan, struct TBMIterateResult *tbmres, TupleTableSlot *slot)
Definition: tableam.h:804
void(* parallelscan_reinitialize)(Relation rel, ParallelTableScanDesc pscan)
Definition: tableam.h:383
void(* tuple_get_latest_tid)(TableScanDesc scan, ItemPointer tid)
Definition: tableam.h:465
struct IndexFetchTableData *(* index_fetch_begin)(Relation rel)
Definition: tableam.h:400
bool(* scan_analyze_next_block)(TableScanDesc scan, BlockNumber blockno, BufferAccessStrategy bstrategy)
Definition: tableam.h:651
void(* relation_estimate_size)(Relation rel, int32 *attr_widths, BlockNumber *pages, double *tuples, double *allvisfrac)
Definition: tableam.h:749
double(* index_build_range_scan)(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, bool allow_sync, bool anyvisible, bool progress, BlockNumber start_blockno, BlockNumber numblocks, IndexBuildCallback callback, void *callback_state, TableScanDesc scan)
Definition: tableam.h:670
TableScanDesc(* scan_begin)(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key, ParallelTableScanDesc pscan, uint32 flags)
Definition: tableam.h:304
bool(* relation_needs_toast_table)(Relation rel)
Definition: tableam.h:713
bool(* tuple_tid_valid)(TableScanDesc scan, ItemPointer tid)
Definition: tableam.h:458
void(* multi_insert)(Relation rel, TupleTableSlot **slots, int nslots, CommandId cid, int options, struct BulkInsertStateData *bistate)
Definition: tableam.h:506
TM_Result(* tuple_update)(Relation rel, ItemPointer otid, TupleTableSlot *slot, CommandId cid, Snapshot snapshot, Snapshot crosscheck, bool wait, TM_FailureData *tmfd, LockTupleMode *lockmode, bool *update_indexes)
Definition: tableam.h:520
void(* scan_end)(TableScanDesc scan)
Definition: tableam.h:314
uint64(* relation_size)(Relation rel, ForkNumber forkNumber)
Definition: tableam.h:703
TM_Result(* tuple_lock)(Relation rel, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, CommandId cid, LockTupleMode mode, LockWaitPolicy wait_policy, uint8 flags, TM_FailureData *tmfd)
Definition: tableam.h:532
bool(* scan_sample_next_block)(TableScanDesc scan, struct SampleScanState *scanstate)
Definition: tableam.h:833
void(* relation_copy_for_cluster)(Relation NewTable, Relation OldTable, Relation OldIndex, bool use_sort, TransactionId OldestXmin, TransactionId *xid_cutoff, MultiXactId *multi_cutoff, double *num_tuples, double *tups_vacuumed, double *tups_recently_dead)
Definition: tableam.h:604
void(* relation_nontransactional_truncate)(Relation rel)
Definition: tableam.h:592
void(* tuple_insert)(Relation rel, TupleTableSlot *slot, CommandId cid, int options, struct BulkInsertStateData *bistate)
Definition: tableam.h:487
void(* scan_rescan)(TableScanDesc scan, struct ScanKeyData *key, bool set_params, bool allow_strat, bool allow_sync, bool allow_pagemode)
Definition: tableam.h:320
bool(* tuple_fetch_row_version)(Relation rel, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot)
Definition: tableam.h:450
void(* relation_vacuum)(Relation rel, struct VacuumParams *params, BufferAccessStrategy bstrategy)
Definition: tableam.h:630
Size(* parallelscan_estimate)(Relation rel)
Definition: tableam.h:369
void(* relation_set_new_filelocator)(Relation rel, const RelFileLocator *newrlocator, char persistence, TransactionId *freezeXid, MultiXactId *minmulti)
Definition: tableam.h:578
bool(* scan_analyze_next_tuple)(TableScanDesc scan, TransactionId OldestXmin, double *liverows, double *deadrows, TupleTableSlot *slot)
Definition: tableam.h:663
TransactionId(* index_delete_tuples)(Relation rel, TM_IndexDeleteOp *delstate)
Definition: tableam.h:477
void(* index_fetch_end)(struct IndexFetchTableData *data)
Definition: tableam.h:411
bool(* index_fetch_tuple)(struct IndexFetchTableData *scan, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, bool *call_again, bool *all_dead)
Definition: tableam.h:433
void(* tuple_insert_speculative)(Relation rel, TupleTableSlot *slot, CommandId cid, int options, struct BulkInsertStateData *bistate, uint32 specToken)
Definition: tableam.h:492
TM_Result(* tuple_delete)(Relation rel, ItemPointer tid, CommandId cid, Snapshot snapshot, Snapshot crosscheck, bool wait, TM_FailureData *tmfd, bool changingPart)
Definition: tableam.h:510
bool(* scan_bitmap_next_block)(TableScanDesc scan, struct TBMIterateResult *tbmres)
Definition: tableam.h:790
void(* index_validate_scan)(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:683
bool(* scan_getnextslot)(TableScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
Definition: tableam.h:327
bool(* tuple_satisfies_snapshot)(Relation rel, TupleTableSlot *slot, Snapshot snapshot)
Definition: tableam.h:472

References Assert(), DatumGetPointer(), elog(), ERROR, TableAmRoutine::index_build_range_scan, TableAmRoutine::index_delete_tuples, TableAmRoutine::index_fetch_begin, TableAmRoutine::index_fetch_end, TableAmRoutine::index_fetch_reset, TableAmRoutine::index_fetch_tuple, TableAmRoutine::index_validate_scan, IsA, TableAmRoutine::multi_insert, OidFunctionCall0, TableAmRoutine::parallelscan_estimate, TableAmRoutine::parallelscan_initialize, TableAmRoutine::parallelscan_reinitialize, TableAmRoutine::relation_copy_data, TableAmRoutine::relation_copy_for_cluster, TableAmRoutine::relation_estimate_size, TableAmRoutine::relation_needs_toast_table, TableAmRoutine::relation_nontransactional_truncate, TableAmRoutine::relation_set_new_filelocator, TableAmRoutine::relation_size, TableAmRoutine::relation_vacuum, TableAmRoutine::scan_analyze_next_block, TableAmRoutine::scan_analyze_next_tuple, TableAmRoutine::scan_begin, TableAmRoutine::scan_bitmap_next_block, TableAmRoutine::scan_bitmap_next_tuple, TableAmRoutine::scan_end, TableAmRoutine::scan_getnextslot, TableAmRoutine::scan_rescan, TableAmRoutine::scan_sample_next_block, TableAmRoutine::scan_sample_next_tuple, TableAmRoutine::tuple_complete_speculative, TableAmRoutine::tuple_delete, TableAmRoutine::tuple_fetch_row_version, TableAmRoutine::tuple_get_latest_tid, TableAmRoutine::tuple_insert, TableAmRoutine::tuple_insert_speculative, TableAmRoutine::tuple_lock, TableAmRoutine::tuple_satisfies_snapshot, TableAmRoutine::tuple_tid_valid, and TableAmRoutine::tuple_update.

Referenced by InitTableAmRoutine().