1 /*-------------------------------------------------------------------------
4 * Convenience routines for common queries in the system catalog cache.
6 * Portions Copyright (c) 1996-2012, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
9 * src/include/utils/lsyscache.h
11 *-------------------------------------------------------------------------
16 #include "access/attnum.h"
17 #include "access/htup.h"
18 #include "nodes/pg_list.h"
20 /* Result list element for get_op_btree_interpretation */
21 typedef struct OpBtreeInterpretation
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 */
27 } OpBtreeInterpretation;
29 /* I/O function selector for get_type_io_data */
30 typedef enum IOFuncSelector
38 /* Hook for plugins to get control in get_attavgwidth() */
39 typedef int32 (*get_attavgwidth_hook_type) (Oid relid, AttrNumber attnum);
40 extern PGDLLIMPORT get_attavgwidth_hook_type get_attavgwidth_hook;
42 extern bool op_in_opfamily(Oid opno, Oid opfamily);
43 extern int get_op_opfamily_strategy(Oid opno, Oid opfamily);
44 extern Oid get_op_opfamily_sortfamily(Oid opno, Oid opfamily);
45 extern void get_op_opfamily_properties(Oid opno, Oid opfamily, bool ordering_op,
49 extern Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype,
51 extern bool get_ordering_op_properties(Oid opno,
52 Oid *opfamily, Oid *opcintype, int16 *strategy);
53 extern bool get_sort_function_for_ordering_op(Oid opno, Oid *sortfunc,
54 bool *issupport, bool *reverse);
55 extern Oid get_equality_op_for_ordering_op(Oid opno, bool *reverse);
56 extern Oid get_ordering_op_for_equality_op(Oid opno, bool use_lhs_type);
57 extern List *get_mergejoin_opfamilies(Oid opno);
58 extern bool get_compatible_hash_operators(Oid opno,
59 Oid *lhs_opno, Oid *rhs_opno);
60 extern bool get_op_hash_functions(Oid opno,
61 RegProcedure *lhs_procno, RegProcedure *rhs_procno);
62 extern List *get_op_btree_interpretation(Oid opno);
63 extern bool equality_ops_are_compatible(Oid opno1, Oid opno2);
64 extern Oid get_opfamily_proc(Oid opfamily, Oid lefttype, Oid righttype,
66 extern char *get_attname(Oid relid, AttrNumber attnum);
67 extern char *get_relid_attribute_name(Oid relid, AttrNumber attnum);
68 extern AttrNumber get_attnum(Oid relid, const char *attname);
69 extern Oid get_atttype(Oid relid, AttrNumber attnum);
70 extern int32 get_atttypmod(Oid relid, AttrNumber attnum);
71 extern void get_atttypetypmodcoll(Oid relid, AttrNumber attnum,
72 Oid *typid, int32 *typmod, Oid *collid);
73 extern char *get_collation_name(Oid colloid);
74 extern char *get_constraint_name(Oid conoid);
75 extern Oid get_opclass_family(Oid opclass);
76 extern Oid get_opclass_input_type(Oid opclass);
77 extern RegProcedure get_opcode(Oid opno);
78 extern char *get_opname(Oid opno);
79 extern void op_input_types(Oid opno, Oid *lefttype, Oid *righttype);
80 extern bool op_mergejoinable(Oid opno, Oid inputtype);
81 extern bool op_hashjoinable(Oid opno, Oid inputtype);
82 extern bool op_strict(Oid opno);
83 extern char op_volatile(Oid opno);
84 extern Oid get_commutator(Oid opno);
85 extern Oid get_negator(Oid opno);
86 extern RegProcedure get_oprrest(Oid opno);
87 extern RegProcedure get_oprjoin(Oid opno);
88 extern char *get_func_name(Oid funcid);
89 extern Oid get_func_namespace(Oid funcid);
90 extern Oid get_func_rettype(Oid funcid);
91 extern int get_func_nargs(Oid funcid);
92 extern Oid get_func_signature(Oid funcid, Oid **argtypes, int *nargs);
93 extern bool get_func_retset(Oid funcid);
94 extern bool func_strict(Oid funcid);
95 extern char func_volatile(Oid funcid);
96 extern bool get_func_leakproof(Oid funcid);
97 extern float4 get_func_cost(Oid funcid);
98 extern float4 get_func_rows(Oid funcid);
99 extern Oid get_relname_relid(const char *relname, Oid relnamespace);
100 extern char *get_rel_name(Oid relid);
101 extern Oid get_rel_namespace(Oid relid);
102 extern Oid get_rel_type_id(Oid relid);
103 extern char get_rel_relkind(Oid relid);
104 extern Oid get_rel_tablespace(Oid relid);
105 extern bool get_typisdefined(Oid typid);
106 extern int16 get_typlen(Oid typid);
107 extern bool get_typbyval(Oid typid);
108 extern void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval);
109 extern void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval,
111 extern Oid getTypeIOParam(HeapTuple typeTuple);
112 extern void get_type_io_data(Oid typid,
113 IOFuncSelector which_func,
120 extern char get_typstorage(Oid typid);
121 extern Node *get_typdefault(Oid typid);
122 extern char get_typtype(Oid typid);
123 extern bool type_is_rowtype(Oid typid);
124 extern bool type_is_enum(Oid typid);
125 extern bool type_is_range(Oid typid);
126 extern void get_type_category_preferred(Oid typid,
128 bool *typispreferred);
129 extern Oid get_typ_typrelid(Oid typid);
130 extern Oid get_element_type(Oid typid);
131 extern Oid get_array_type(Oid typid);
132 extern Oid get_base_element_type(Oid typid);
133 extern void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam);
134 extern void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena);
135 extern void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam);
136 extern void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena);
137 extern Oid get_typmodin(Oid typid);
138 extern Oid get_typcollation(Oid typid);
139 extern bool type_is_collatable(Oid typid);
140 extern Oid getBaseType(Oid typid);
141 extern Oid getBaseTypeAndTypmod(Oid typid, int32 *typmod);
142 extern int32 get_typavgwidth(Oid typid, int32 typmod);
143 extern int32 get_attavgwidth(Oid relid, AttrNumber attnum);
144 extern bool get_attstatsslot(HeapTuple statstuple,
145 Oid atttype, int32 atttypmod,
146 int reqkind, Oid reqop,
148 Datum **values, int *nvalues,
149 float4 **numbers, int *nnumbers);
150 extern void free_attstatsslot(Oid atttype,
151 Datum *values, int nvalues,
152 float4 *numbers, int nnumbers);
153 extern char *get_namespace_name(Oid nspid);
154 extern Oid get_range_subtype(Oid rangeOid);
156 #define type_is_array(typid) (get_element_type(typid) != InvalidOid)
157 /* type_is_array_domain accepts both plain arrays and domains over arrays */
158 #define type_is_array_domain(typid) (get_base_element_type(typid) != InvalidOid)
160 #define TypeIsToastable(typid) (get_typstorage(typid) != 'p')
162 #endif /* LSYSCACHE_H */