mirror of
https://github.com/zebrajr/postgres.git
synced 2025-12-07 12:20:31 +01:00
c891e05f26
external projects, we should be careful about what parts of the GiST API are considered implementation details, and which are part of the public API. Therefore, I've moved internal-only declarations into gist_private.h -- future backward-incompatible changes to gist.h should be made with care, to avoid needlessly breaking external GiST extensions. Also did some related header cleanup: remove some unnecessary #includes from gist.h, and remove some unused definitions: isAttByVal(), _gistdump(), and GISTNStrategies.
111 lines
3.0 KiB
C
111 lines
3.0 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* gist.h
|
|
* The public API for GiST indexes. This API is exposed to
|
|
* individuals implementing GiST indexes, so backward-incompatible
|
|
* changes should be made with care.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* $PostgreSQL: pgsql/src/include/access/gist.h,v 1.46 2005/05/17 03:34:18 neilc Exp $
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef GIST_H
|
|
#define GIST_H
|
|
|
|
#include "storage/bufpage.h"
|
|
#include "storage/off.h"
|
|
#include "utils/rel.h"
|
|
|
|
/*
|
|
* amproc indexes for GiST indexes.
|
|
*/
|
|
#define GIST_CONSISTENT_PROC 1
|
|
#define GIST_UNION_PROC 2
|
|
#define GIST_COMPRESS_PROC 3
|
|
#define GIST_DECOMPRESS_PROC 4
|
|
#define GIST_PENALTY_PROC 5
|
|
#define GIST_PICKSPLIT_PROC 6
|
|
#define GIST_EQUAL_PROC 7
|
|
#define GISTNProcs 7
|
|
|
|
/*
|
|
* Page opaque data in a GiST index page.
|
|
*/
|
|
#define F_LEAF (1 << 0)
|
|
|
|
typedef struct GISTPageOpaqueData
|
|
{
|
|
uint32 flags;
|
|
} GISTPageOpaqueData;
|
|
|
|
typedef GISTPageOpaqueData *GISTPageOpaque;
|
|
|
|
/*
|
|
* This is the Split Vector to be returned by the PickSplit method.
|
|
*/
|
|
typedef struct GIST_SPLITVEC
|
|
{
|
|
OffsetNumber *spl_left; /* array of entries that go left */
|
|
int spl_nleft; /* size of this array */
|
|
Datum spl_ldatum; /* Union of keys in spl_left */
|
|
Datum spl_lattr[INDEX_MAX_KEYS]; /* Union of subkeys in
|
|
* spl_left */
|
|
int spl_lattrsize[INDEX_MAX_KEYS];
|
|
bool spl_lisnull[INDEX_MAX_KEYS];
|
|
|
|
OffsetNumber *spl_right; /* array of entries that go right */
|
|
int spl_nright; /* size of the array */
|
|
Datum spl_rdatum; /* Union of keys in spl_right */
|
|
Datum spl_rattr[INDEX_MAX_KEYS]; /* Union of subkeys in
|
|
* spl_right */
|
|
int spl_rattrsize[INDEX_MAX_KEYS];
|
|
bool spl_risnull[INDEX_MAX_KEYS];
|
|
|
|
int *spl_idgrp;
|
|
int *spl_ngrp; /* number in each group */
|
|
char *spl_grpflag; /* flags of each group */
|
|
} GIST_SPLITVEC;
|
|
|
|
/*
|
|
* An entry on a GiST node. Contains the key, as well as its own
|
|
* location (rel,page,offset) which can supply the matching pointer.
|
|
* The size of the key is in bytes, and leafkey is a flag to tell us
|
|
* if the entry is in a leaf node.
|
|
*/
|
|
typedef struct GISTENTRY
|
|
{
|
|
Datum key;
|
|
Relation rel;
|
|
Page page;
|
|
OffsetNumber offset;
|
|
int bytes;
|
|
bool leafkey;
|
|
} GISTENTRY;
|
|
|
|
#define GIST_LEAF(entry) (((GISTPageOpaque) PageGetSpecialPointer((entry)->page))->flags & F_LEAF)
|
|
|
|
/*
|
|
* Vector of GISTENTRY structs; user-defined methods union and pick
|
|
* split takes it as one of their arguments
|
|
*/
|
|
typedef struct
|
|
{
|
|
int32 n; /* number of elements */
|
|
GISTENTRY vector[1];
|
|
} GistEntryVector;
|
|
|
|
#define GEVHDRSZ (offsetof(GistEntryVector, vector[0]))
|
|
|
|
/*
|
|
* macro to initialize a GISTENTRY
|
|
*/
|
|
#define gistentryinit(e, k, r, pg, o, b, l) \
|
|
do { (e).key = (k); (e).rel = (r); (e).page = (pg); \
|
|
(e).offset = (o); (e).bytes = (b); (e).leafkey = (l); } while (0)
|
|
|
|
#endif /* GIST_H */
|