1 /*-------------------------------------------------------------------------
4 * POSTGRES heap access method definitions.
7 * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * $PostgreSQL: pgsql/src/include/access/heapam.h,v 1.141 2009/01/01 17:23:56 momjian Exp $
12 *-------------------------------------------------------------------------
17 #include "access/htup.h"
18 #include "access/sdir.h"
19 #include "access/skey.h"
20 #include "access/xlog.h"
21 #include "nodes/primnodes.h"
22 #include "storage/bufpage.h"
23 #include "storage/lock.h"
24 #include "utils/relcache.h"
25 #include "utils/snapshot.h"
28 /* "options" flag bits for heap_insert */
29 #define HEAP_INSERT_SKIP_WAL 0x0001
30 #define HEAP_INSERT_SKIP_FSM 0x0002
32 typedef struct BulkInsertStateData *BulkInsertState;
42 * function prototypes for heap access method
44 * heap_create, heap_create_with_catalog, and heap_drop_with_catalog
45 * are declared in catalog/heap.h
49 /* in heap/heapam.c */
50 extern Relation relation_open(Oid relationId, LOCKMODE lockmode);
51 extern Relation try_relation_open(Oid relationId, LOCKMODE lockmode);
52 extern Relation relation_open_nowait(Oid relationId, LOCKMODE lockmode);
53 extern Relation relation_openrv(const RangeVar *relation, LOCKMODE lockmode);
54 extern Relation try_relation_openrv(const RangeVar *relation, LOCKMODE lockmode);
55 extern void relation_close(Relation relation, LOCKMODE lockmode);
57 extern Relation heap_open(Oid relationId, LOCKMODE lockmode);
58 extern Relation heap_openrv(const RangeVar *relation, LOCKMODE lockmode);
59 extern Relation try_heap_openrv(const RangeVar *relation, LOCKMODE lockmode);
61 #define heap_close(r,l) relation_close(r,l)
63 /* struct definition appears in relscan.h */
64 typedef struct HeapScanDescData *HeapScanDesc;
68 * True iff the heap scan is valid.
70 #define HeapScanIsValid(scan) PointerIsValid(scan)
72 extern HeapScanDesc heap_beginscan(Relation relation, Snapshot snapshot,
73 int nkeys, ScanKey key);
74 extern HeapScanDesc heap_beginscan_strat(Relation relation, Snapshot snapshot,
75 int nkeys, ScanKey key,
76 bool allow_strat, bool allow_sync);
77 extern HeapScanDesc heap_beginscan_bm(Relation relation, Snapshot snapshot,
78 int nkeys, ScanKey key);
79 extern void heap_rescan(HeapScanDesc scan, ScanKey key);
80 extern void heap_endscan(HeapScanDesc scan);
81 extern HeapTuple heap_getnext(HeapScanDesc scan, ScanDirection direction);
83 extern bool heap_fetch(Relation relation, Snapshot snapshot,
84 HeapTuple tuple, Buffer *userbuf, bool keep_buf,
85 Relation stats_relation);
86 extern bool heap_hot_search_buffer(ItemPointer tid, Buffer buffer,
87 Snapshot snapshot, bool *all_dead);
88 extern bool heap_hot_search(ItemPointer tid, Relation relation,
89 Snapshot snapshot, bool *all_dead);
91 extern void heap_get_latest_tid(Relation relation, Snapshot snapshot,
93 extern void setLastTid(const ItemPointer tid);
95 extern BulkInsertState GetBulkInsertState(void);
96 extern void FreeBulkInsertState(BulkInsertState);
98 extern Oid heap_insert(Relation relation, HeapTuple tup, CommandId cid,
99 int options, BulkInsertState bistate);
100 extern HTSU_Result heap_delete(Relation relation, ItemPointer tid,
101 ItemPointer ctid, TransactionId *update_xmax,
102 CommandId cid, Snapshot crosscheck, bool wait);
103 extern HTSU_Result heap_update(Relation relation, ItemPointer otid,
105 ItemPointer ctid, TransactionId *update_xmax,
106 CommandId cid, Snapshot crosscheck, bool wait);
107 extern HTSU_Result heap_lock_tuple(Relation relation, HeapTuple tuple,
108 Buffer *buffer, ItemPointer ctid,
109 TransactionId *update_xmax, CommandId cid,
110 LockTupleMode mode, bool nowait);
111 extern void heap_inplace_update(Relation relation, HeapTuple tuple);
112 extern bool heap_freeze_tuple(HeapTupleHeader tuple, TransactionId cutoff_xid,
115 extern Oid simple_heap_insert(Relation relation, HeapTuple tup);
116 extern void simple_heap_delete(Relation relation, ItemPointer tid);
117 extern void simple_heap_update(Relation relation, ItemPointer otid,
120 extern void heap_markpos(HeapScanDesc scan);
121 extern void heap_restrpos(HeapScanDesc scan);
123 extern void heap_sync(Relation relation);
125 extern void heap_redo(XLogRecPtr lsn, XLogRecord *rptr);
126 extern void heap_desc(StringInfo buf, uint8 xl_info, char *rec);
127 extern void heap2_redo(XLogRecPtr lsn, XLogRecord *rptr);
128 extern void heap2_desc(StringInfo buf, uint8 xl_info, char *rec);
130 extern XLogRecPtr log_heap_move(Relation reln, Buffer oldbuf,
131 ItemPointerData from,
132 Buffer newbuf, HeapTuple newtup);
133 extern XLogRecPtr log_heap_clean(Relation reln, Buffer buffer,
134 OffsetNumber *redirected, int nredirected,
135 OffsetNumber *nowdead, int ndead,
136 OffsetNumber *nowunused, int nunused,
138 extern XLogRecPtr log_heap_freeze(Relation reln, Buffer buffer,
139 TransactionId cutoff_xid,
140 OffsetNumber *offsets, int offcnt);
141 extern XLogRecPtr log_newpage(RelFileNode *rnode, ForkNumber forkNum,
142 BlockNumber blk, Page page);
144 /* in heap/pruneheap.c */
145 extern void heap_page_prune_opt(Relation relation, Buffer buffer,
146 TransactionId OldestXmin);
147 extern int heap_page_prune(Relation relation, Buffer buffer,
148 TransactionId OldestXmin,
149 bool redirect_move, bool report_stats);
150 extern void heap_page_prune_execute(Buffer buffer,
151 OffsetNumber *redirected, int nredirected,
152 OffsetNumber *nowdead, int ndead,
153 OffsetNumber *nowunused, int nunused,
155 extern void heap_get_root_tuples(Page page, OffsetNumber *root_offsets);
157 /* in heap/syncscan.c */
158 extern void ss_report_location(Relation rel, BlockNumber location);
159 extern BlockNumber ss_get_location(Relation rel, BlockNumber relnblocks);
160 extern void SyncScanShmemInit(void);
161 extern Size SyncScanShmemSize(void);
163 #endif /* HEAPAM_H */