PostgreSQL Source Code  git master
pg_amproc.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_amproc.h
4  * definition of the "access method procedure" system catalog (pg_amproc)
5  *
6  * The amproc table identifies support procedures associated with index
7  * operator families and classes. These procedures can't be listed in pg_amop
8  * since they are not the implementation of any indexable operator.
9  *
10  * The primary key for this table is <amprocfamily, amproclefttype,
11  * amprocrighttype, amprocnum>. The "default" support functions for a
12  * particular opclass within the family are those with amproclefttype =
13  * amprocrighttype = opclass's opcintype. These are the ones loaded into the
14  * relcache for an index and typically used for internal index operations.
15  * Other support functions are typically used to handle cross-type indexable
16  * operators with oprleft/oprright matching the entry's amproclefttype and
17  * amprocrighttype. The exact behavior depends on the index AM, however, and
18  * some don't pay attention to non-default functions at all.
19  *
20  *
21  * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
22  * Portions Copyright (c) 1994, Regents of the University of California
23  *
24  * src/include/catalog/pg_amproc.h
25  *
26  * NOTES
27  * The Catalog.pm module reads this file and derives schema
28  * information.
29  *
30  *-------------------------------------------------------------------------
31  */
32 #ifndef PG_AMPROC_H
33 #define PG_AMPROC_H
34 
35 #include "catalog/genbki.h"
36 #include "catalog/pg_amproc_d.h"
37 
38 /* ----------------
39  * pg_amproc definition. cpp turns this into
40  * typedef struct FormData_pg_amproc
41  * ----------------
42  */
43 CATALOG(pg_amproc,2603,AccessMethodProcedureRelationId)
44 {
45  /* the index opfamily this entry is for */
46  Oid amprocfamily BKI_LOOKUP(pg_opfamily);
47 
48  /* procedure's left input data type */
49  Oid amproclefttype BKI_LOOKUP(pg_type);
50 
51  /* procedure's right input data type */
52  Oid amprocrighttype BKI_LOOKUP(pg_type);
53 
54  /* support procedure index */
55  int16 amprocnum;
56 
57  /* OID of the proc */
58  regproc amproc BKI_LOOKUP(pg_proc);
60 
61 /* ----------------
62  * Form_pg_amproc corresponds to a pointer to a tuple with
63  * the format of pg_amproc relation.
64  * ----------------
65  */
67 
68 #endif /* PG_AMPROC_H */
signed short int16
Definition: c.h:312
FormData_pg_amproc * Form_pg_amproc
Definition: pg_amproc.h:66
unsigned int Oid
Definition: postgres_ext.h:31
#define BKI_LOOKUP(catalog)
Definition: genbki.h:38
FormData_pg_amproc
Definition: pg_amproc.h:59
Oid regproc
Definition: c.h:471
CATALOG(pg_amproc, 2603, AccessMethodProcedureRelationId)
Definition: pg_amproc.h:43