postgresql/src/include/access/genam.h

/*-------------------------------------------------------------------------
 *
 * genam.h--
 *	  POSTGRES general access method definitions.
 *
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 * $Id: genam.h,v 1.8 1997/09/07 04:55:48 momjian Exp $
 *
 *-------------------------------------------------------------------------
 */
#ifndef GENAM_H
#define GENAM_H

#include <access/sdir.h>
#include <access/funcindex.h>
#include <access/relscan.h>
#include <access/itup.h>

/* ----------------
 *		generalized index_ interface routines
 * ----------------
 */
extern Relation index_open(Oid relationId);
extern Relation index_openr(char *relationName);
extern void		index_close(Relation relation);
extern InsertIndexResult
index_insert(Relation relation,
			 Datum * datum, char *nulls,
			 ItemPointer heap_t_ctid,
			 Relation heapRel);
extern void		index_delete(Relation relation, ItemPointer indexItem);
extern IndexScanDesc
index_beginscan(Relation relation, bool scanFromEnd,
				uint16 numberOfKeys, ScanKey key);
extern void		index_rescan(IndexScanDesc scan, bool scanFromEnd, ScanKey key);
extern void		index_endscan(IndexScanDesc scan);
extern RetrieveIndexResult
index_getnext(IndexScanDesc scan,
			  ScanDirection direction);
extern RegProcedure
index_getprocid(Relation irel, AttrNumber attnum,
				uint16 procnum);
extern Datum
GetIndexValue(HeapTuple tuple, TupleDesc hTupDesc,
			  int attOff, AttrNumber attrNums[], FuncIndexInfo * fInfo,
			  bool * attNull, Buffer buffer);

/* in genam.c */
extern IndexScanDesc
RelationGetIndexScan(Relation relation, bool scanFromEnd,
					 uint16 numberOfKeys, ScanKey key);
extern void		IndexScanMarkPosition(IndexScanDesc scan);
extern void		IndexScanRestorePosition(IndexScanDesc scan);

#endif							/* GENAM_H */