PostgreSQL Source Code  git master
lsyscache.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * lsyscache.h
4  * Convenience routines for common queries in the system catalog cache.
5  *
6  * Portions Copyright (c) 1996-2019, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  * src/include/utils/lsyscache.h
10  *
11  *-------------------------------------------------------------------------
12  */
13 #ifndef LSYSCACHE_H
14 #define LSYSCACHE_H
15 
16 #include "access/attnum.h"
17 #include "access/htup.h"
18 #include "nodes/pg_list.h"
19 
20 /* Result list element for get_op_btree_interpretation */
21 typedef struct OpBtreeInterpretation
22 {
23  Oid opfamily_id; /* btree opfamily containing operator */
24  int strategy; /* its strategy number */
25  Oid oplefttype; /* declared left input datatype */
26  Oid oprighttype; /* declared right input datatype */
28 
29 /* I/O function selector for get_type_io_data */
30 typedef enum IOFuncSelector
31 {
37 
38 /* Flag bits for get_attstatsslot */
39 #define ATTSTATSSLOT_VALUES 0x01
40 #define ATTSTATSSLOT_NUMBERS 0x02
41 
42 /* Result struct for get_attstatsslot */
43 typedef struct AttStatsSlot
44 {
45  /* Always filled: */
46  Oid staop; /* Actual staop for the found slot */
47  Oid stacoll; /* Actual collation for the found slot */
48  /* Filled if ATTSTATSSLOT_VALUES is specified: */
49  Oid valuetype; /* Actual datatype of the values */
50  Datum *values; /* slot's "values" array, or NULL if none */
51  int nvalues; /* length of values[], or 0 */
52  /* Filled if ATTSTATSSLOT_NUMBERS is specified: */
53  float4 *numbers; /* slot's "numbers" array, or NULL if none */
54  int nnumbers; /* length of numbers[], or 0 */
55 
56  /* Remaining fields are private to get_attstatsslot/free_attstatsslot */
57  void *values_arr; /* palloc'd values array, if any */
58  void *numbers_arr; /* palloc'd numbers array, if any */
59 } AttStatsSlot;
60 
61 /* Hook for plugins to get control in get_attavgwidth() */
64 
65 extern bool op_in_opfamily(Oid opno, Oid opfamily);
66 extern int get_op_opfamily_strategy(Oid opno, Oid opfamily);
67 extern Oid get_op_opfamily_sortfamily(Oid opno, Oid opfamily);
68 extern void get_op_opfamily_properties(Oid opno, Oid opfamily, bool ordering_op,
69  int *strategy,
70  Oid *lefttype,
71  Oid *righttype);
72 extern Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype,
73  int16 strategy);
74 extern bool get_ordering_op_properties(Oid opno,
75  Oid *opfamily, Oid *opcintype, int16 *strategy);
76 extern Oid get_equality_op_for_ordering_op(Oid opno, bool *reverse);
77 extern Oid get_ordering_op_for_equality_op(Oid opno, bool use_lhs_type);
78 extern List *get_mergejoin_opfamilies(Oid opno);
79 extern bool get_compatible_hash_operators(Oid opno,
80  Oid *lhs_opno, Oid *rhs_opno);
81 extern bool get_op_hash_functions(Oid opno,
82  RegProcedure *lhs_procno, RegProcedure *rhs_procno);
84 extern bool equality_ops_are_compatible(Oid opno1, Oid opno2);
85 extern Oid get_opfamily_proc(Oid opfamily, Oid lefttype, Oid righttype,
86  int16 procnum);
87 extern char *get_attname(Oid relid, AttrNumber attnum, bool missing_ok);
88 extern AttrNumber get_attnum(Oid relid, const char *attname);
89 extern char get_attgenerated(Oid relid, AttrNumber attnum);
90 extern Oid get_atttype(Oid relid, AttrNumber attnum);
91 extern void get_atttypetypmodcoll(Oid relid, AttrNumber attnum,
92  Oid *typid, int32 *typmod, Oid *collid);
93 extern char *get_collation_name(Oid colloid);
94 extern bool get_collation_isdeterministic(Oid colloid);
95 extern char *get_constraint_name(Oid conoid);
96 extern char *get_language_name(Oid langoid, bool missing_ok);
97 extern Oid get_opclass_family(Oid opclass);
98 extern Oid get_opclass_input_type(Oid opclass);
99 extern bool get_opclass_opfamily_and_input_type(Oid opclass,
100  Oid *opfamily, Oid *opcintype);
101 extern RegProcedure get_opcode(Oid opno);
102 extern char *get_opname(Oid opno);
103 extern Oid get_op_rettype(Oid opno);
104 extern void op_input_types(Oid opno, Oid *lefttype, Oid *righttype);
105 extern bool op_mergejoinable(Oid opno, Oid inputtype);
106 extern bool op_hashjoinable(Oid opno, Oid inputtype);
107 extern bool op_strict(Oid opno);
108 extern char op_volatile(Oid opno);
109 extern Oid get_commutator(Oid opno);
110 extern Oid get_negator(Oid opno);
111 extern RegProcedure get_oprrest(Oid opno);
112 extern RegProcedure get_oprjoin(Oid opno);
113 extern char *get_func_name(Oid funcid);
114 extern Oid get_func_namespace(Oid funcid);
115 extern Oid get_func_rettype(Oid funcid);
116 extern int get_func_nargs(Oid funcid);
117 extern Oid get_func_signature(Oid funcid, Oid **argtypes, int *nargs);
118 extern Oid get_func_variadictype(Oid funcid);
119 extern bool get_func_retset(Oid funcid);
120 extern bool func_strict(Oid funcid);
121 extern char func_volatile(Oid funcid);
122 extern char func_parallel(Oid funcid);
123 extern char get_func_prokind(Oid funcid);
124 extern bool get_func_leakproof(Oid funcid);
125 extern RegProcedure get_func_support(Oid funcid);
126 extern Oid get_relname_relid(const char *relname, Oid relnamespace);
127 extern char *get_rel_name(Oid relid);
128 extern Oid get_rel_namespace(Oid relid);
129 extern Oid get_rel_type_id(Oid relid);
130 extern char get_rel_relkind(Oid relid);
131 extern bool get_rel_relispartition(Oid relid);
132 extern Oid get_rel_tablespace(Oid relid);
133 extern char get_rel_persistence(Oid relid);
134 extern Oid get_transform_fromsql(Oid typid, Oid langid, List *trftypes);
135 extern Oid get_transform_tosql(Oid typid, Oid langid, List *trftypes);
136 extern bool get_typisdefined(Oid typid);
137 extern int16 get_typlen(Oid typid);
138 extern bool get_typbyval(Oid typid);
139 extern void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval);
140 extern void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval,
141  char *typalign);
142 extern Oid getTypeIOParam(HeapTuple typeTuple);
143 extern void get_type_io_data(Oid typid,
144  IOFuncSelector which_func,
145  int16 *typlen,
146  bool *typbyval,
147  char *typalign,
148  char *typdelim,
149  Oid *typioparam,
150  Oid *func);
151 extern char get_typstorage(Oid typid);
152 extern Node *get_typdefault(Oid typid);
153 extern char get_typtype(Oid typid);
154 extern bool type_is_rowtype(Oid typid);
155 extern bool type_is_enum(Oid typid);
156 extern bool type_is_range(Oid typid);
157 extern void get_type_category_preferred(Oid typid,
158  char *typcategory,
159  bool *typispreferred);
160 extern Oid get_typ_typrelid(Oid typid);
161 extern Oid get_element_type(Oid typid);
162 extern Oid get_array_type(Oid typid);
163 extern Oid get_promoted_array_type(Oid typid);
164 extern Oid get_base_element_type(Oid typid);
165 extern void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam);
166 extern void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena);
167 extern void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam);
168 extern void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena);
169 extern Oid get_typmodin(Oid typid);
170 extern Oid get_typcollation(Oid typid);
171 extern bool type_is_collatable(Oid typid);
172 extern Oid getBaseType(Oid typid);
173 extern Oid getBaseTypeAndTypmod(Oid typid, int32 *typmod);
174 extern int32 get_typavgwidth(Oid typid, int32 typmod);
175 extern int32 get_attavgwidth(Oid relid, AttrNumber attnum);
176 extern bool get_attstatsslot(AttStatsSlot *sslot, HeapTuple statstuple,
177  int reqkind, Oid reqop, int flags);
178 extern void free_attstatsslot(AttStatsSlot *sslot);
179 extern char *get_namespace_name(Oid nspid);
180 extern char *get_namespace_name_or_temp(Oid nspid);
181 extern Oid get_range_subtype(Oid rangeOid);
182 extern Oid get_index_column_opclass(Oid index_oid, int attno);
183 
184 #define type_is_array(typid) (get_element_type(typid) != InvalidOid)
185 /* type_is_array_domain accepts both plain arrays and domains over arrays */
186 #define type_is_array_domain(typid) (get_base_element_type(typid) != InvalidOid)
187 
188 #define TypeIsToastable(typid) (get_typstorage(typid) != 'p')
189 
190 #endif /* LSYSCACHE_H */
signed short int16
Definition: c.h:346
Oid get_promoted_array_type(Oid typid)
Definition: lsyscache.c:2578
bool get_op_hash_functions(Oid opno, RegProcedure *lhs_procno, RegProcedure *rhs_procno)
Definition: lsyscache.c:507
Oid get_func_namespace(Oid funcid)
Definition: lsyscache.c:1434
Oid getBaseTypeAndTypmod(Oid typid, int32 *typmod)
Definition: lsyscache.c:2316
bool type_is_range(Oid typid)
Definition: lsyscache.c:2466
void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval, char *typalign)
Definition: lsyscache.c:2049
void op_input_types(Oid opno, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:1165
Oid get_atttype(Oid relid, AttrNumber attnum)
Definition: lsyscache.c:861
Oid get_equality_op_for_ordering_op(Oid opno, bool *reverse)
Definition: lsyscache.c:264
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition: lsyscache.c:2641
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1754
int nnumbers
Definition: lsyscache.h:54
int32 get_attavgwidth(Oid relid, AttrNumber attnum)
Definition: lsyscache.c:2870
bool get_ordering_op_properties(Oid opno, Oid *opfamily, Oid *opcintype, int16 *strategy)
Definition: lsyscache.c:204
void get_type_category_preferred(Oid typid, char *typcategory, bool *typispreferred)
Definition: lsyscache.c:2478
RegProcedure get_oprjoin(Oid opno)
Definition: lsyscache.c:1383
bool op_strict(Oid opno)
Definition: lsyscache.c:1279
regproc RegProcedure
Definition: c.h:512
Oid get_func_rettype(Oid funcid)
Definition: lsyscache.c:1457
char * get_func_name(Oid funcid)
Definition: lsyscache.c:1410
struct AttStatsSlot AttStatsSlot
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2674
char get_rel_relkind(Oid relid)
Definition: lsyscache.c:1805
Definition: nodes.h:525
void get_type_io_data(Oid typid, IOFuncSelector which_func, int16 *typlen, bool *typbyval, char *typalign, char *typdelim, Oid *typioparam, Oid *func)
Definition: lsyscache.c:2103
Oid get_rel_type_id(Oid relid)
Definition: lsyscache.c:1781
bool op_hashjoinable(Oid opno, Oid inputtype)
Definition: lsyscache.c:1244
IOFuncSelector
Definition: lsyscache.h:30
NameData relname
Definition: pg_class.h:35
unsigned int Oid
Definition: postgres_ext.h:31
Oid get_ordering_op_for_equality_op(Oid opno, bool use_lhs_type)
Definition: lsyscache.c:302
Oid get_op_opfamily_sortfamily(Oid opno, Oid opfamily)
Definition: lsyscache.c:105
#define PGDLLIMPORT
Definition: c.h:1272
signed int int32
Definition: c.h:347
Oid get_negator(Oid opno)
Definition: lsyscache.c:1335
bool equality_ops_are_compatible(Oid opno1, Oid opno2)
Definition: lsyscache.c:695
char get_attgenerated(Oid relid, AttrNumber attnum)
Definition: lsyscache.c:836
bool get_collation_isdeterministic(Oid colloid)
Definition: lsyscache.c:942
char typalign
Definition: pg_type.h:169
Oid get_array_type(Oid typid)
Definition: lsyscache.c:2554
char op_volatile(Oid opno)
Definition: lsyscache.c:1295
void * values_arr
Definition: lsyscache.h:57
struct OpBtreeInterpretation OpBtreeInterpretation
NameData attname
Definition: pg_attribute.h:40
Oid get_typmodin(Oid typid)
Definition: lsyscache.c:2773
bool op_mergejoinable(Oid opno, Oid inputtype)
Definition: lsyscache.c:1193
char func_volatile(Oid funcid)
Definition: lsyscache.c:1582
void get_op_opfamily_properties(Oid opno, Oid opfamily, bool ordering_op, int *strategy, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:133
Oid getTypeIOParam(HeapTuple typeTuple)
Definition: lsyscache.c:2081
char get_typtype(Oid typid)
Definition: lsyscache.c:2407
Oid get_rel_tablespace(Oid relid)
Definition: lsyscache.c:1856
Oid get_commutator(Oid opno)
Definition: lsyscache.c:1311
float4 * numbers
Definition: lsyscache.h:53
List * get_op_btree_interpretation(Oid opno)
Definition: lsyscache.c:598
bool get_attstatsslot(AttStatsSlot *sslot, HeapTuple statstuple, int reqkind, Oid reqop, int flags)
Definition: lsyscache.c:2942
char * get_opname(Oid opno)
Definition: lsyscache.c:1117
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3094
PGDLLIMPORT get_attavgwidth_hook_type get_attavgwidth_hook
Definition: lsyscache.c:50
Oid get_func_variadictype(Oid funcid)
Definition: lsyscache.c:1525
Oid get_op_rettype(Oid opno)
Definition: lsyscache.c:1140
AttrNumber get_attnum(Oid relid, const char *attname)
Definition: lsyscache.c:806
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1730
char * get_constraint_name(Oid conoid)
Definition: lsyscache.c:969
Oid get_element_type(Oid typid)
Definition: lsyscache.c:2526
RegProcedure get_oprrest(Oid opno)
Definition: lsyscache.c:1359
void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena)
Definition: lsyscache.c:2740
RegProcedure get_func_support(Oid funcid)
Definition: lsyscache.c:1660
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1687
char get_rel_persistence(Oid relid)
Definition: lsyscache.c:1880
void free_attstatsslot(AttStatsSlot *sslot)
Definition: lsyscache.c:3072
bool get_opclass_opfamily_and_input_type(Oid opclass, Oid *opfamily, Oid *opcintype)
Definition: lsyscache.c:1064
void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam)
Definition: lsyscache.c:2707
int get_op_opfamily_strategy(Oid opno, Oid opfamily)
Definition: lsyscache.c:80
Node * get_typdefault(Oid typid)
Definition: lsyscache.c:2226
float float4
Definition: c.h:491
Oid get_opfamily_proc(Oid opfamily, Oid lefttype, Oid righttype, int16 procnum)
Definition: lsyscache.c:744
Oid get_typ_typrelid(Oid typid)
Definition: lsyscache.c:2499
char func_parallel(Oid funcid)
Definition: lsyscache.c:1601
bool get_rel_relispartition(Oid relid)
Definition: lsyscache.c:1829
bool op_in_opfamily(Oid opno, Oid opfamily)
Definition: lsyscache.c:63
Oid get_transform_fromsql(Oid typid, Oid langid, List *trftypes)
Definition: lsyscache.c:1900
int32 get_typavgwidth(Oid typid, int32 typmod)
Definition: lsyscache.c:2356
uintptr_t Datum
Definition: postgres.h:367
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1092
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:163
int32(* get_attavgwidth_hook_type)(Oid relid, AttrNumber attnum)
Definition: lsyscache.h:62
bool get_func_retset(Oid funcid)
Definition: lsyscache.c:1544
Oid get_transform_tosql(Oid typid, Oid langid, List *trftypes)
Definition: lsyscache.c:1921
int16 attnum
Definition: pg_attribute.h:79
void get_atttypetypmodcoll(Oid relid, AttrNumber attnum, Oid *typid, int32 *typmod, Oid *collid)
Definition: lsyscache.c:891
Datum * values
Definition: lsyscache.h:50
Oid get_range_subtype(Oid rangeOid)
Definition: lsyscache.c:3135
char get_func_prokind(Oid funcid)
Definition: lsyscache.c:1620
bool get_typbyval(Oid typid)
Definition: lsyscache.c:2000
bool type_is_rowtype(Oid typid)
Definition: lsyscache.c:2433
List * get_mergejoin_opfamilies(Oid opno)
Definition: lsyscache.c:363
Oid get_index_column_opclass(Oid index_oid, int attno)
Definition: lsyscache.c:3164
Oid getBaseType(Oid typid)
Definition: lsyscache.c:2299
bool get_typisdefined(Oid typid)
Definition: lsyscache.c:1951
char get_typstorage(Oid typid)
Definition: lsyscache.c:2197
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2029
Oid get_opclass_family(Oid opclass)
Definition: lsyscache.c:1019
Oid get_opclass_input_type(Oid opclass)
Definition: lsyscache.c:1041
int get_func_nargs(Oid funcid)
Definition: lsyscache.c:1476
char * get_language_name(Oid langoid, bool missing_ok)
Definition: lsyscache.c:990
bool type_is_enum(Oid typid)
Definition: lsyscache.c:2456
char * get_namespace_name_or_temp(Oid nspid)
Definition: lsyscache.c:3118
void * numbers_arr
Definition: lsyscache.h:58
bool get_func_leakproof(Oid funcid)
Definition: lsyscache.c:1639
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:2823
Oid valuetype
Definition: lsyscache.h:49
bool func_strict(Oid funcid)
Definition: lsyscache.c:1563
char * get_attname(Oid relid, AttrNumber attnum, bool missing_ok)
Definition: lsyscache.c:775
char * get_collation_name(Oid colloid)
Definition: lsyscache.c:923
Definition: pg_list.h:50
int16 AttrNumber
Definition: attnum.h:21
Oid get_base_element_type(Oid typid)
Definition: lsyscache.c:2599
int16 get_typlen(Oid typid)
Definition: lsyscache.c:1975
Oid get_func_signature(Oid funcid, Oid **argtypes, int *nargs)
Definition: lsyscache.c:1498
bool type_is_collatable(Oid typid)
Definition: lsyscache.c:2848
bool get_compatible_hash_operators(Oid opno, Oid *lhs_opno, Oid *rhs_opno)
Definition: lsyscache.c:407