1 /*------------------------------------------------------------------------- 2 * 3 * lsyscache.h 4 * Convenience routines for common queries in the system catalog cache. 5 * 6 * Portions Copyright (c) 1996-2016, 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 */ 27 } OpBtreeInterpretation; 28 29 /* I/O function selector for get_type_io_data */ 30 typedef enum IOFuncSelector 31 { 32 IOFunc_input, 33 IOFunc_output, 34 IOFunc_receive, 35 IOFunc_send 36 } IOFuncSelector; 37 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; 41 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, 46 int *strategy, 47 Oid *lefttype, 48 Oid *righttype); 49 extern Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, 50 int16 strategy); 51 extern bool get_ordering_op_properties(Oid opno, 52 Oid *opfamily, Oid *opcintype, int16 *strategy); 53 extern Oid get_equality_op_for_ordering_op(Oid opno, bool *reverse); 54 extern Oid get_ordering_op_for_equality_op(Oid opno, bool use_lhs_type); 55 extern List *get_mergejoin_opfamilies(Oid opno); 56 extern bool get_compatible_hash_operators(Oid opno, 57 Oid *lhs_opno, Oid *rhs_opno); 58 extern bool get_op_hash_functions(Oid opno, 59 RegProcedure *lhs_procno, RegProcedure *rhs_procno); 60 extern List *get_op_btree_interpretation(Oid opno); 61 extern bool equality_ops_are_compatible(Oid opno1, Oid opno2); 62 extern Oid get_opfamily_proc(Oid opfamily, Oid lefttype, Oid righttype, 63 int16 procnum); 64 extern char *get_attname(Oid relid, AttrNumber attnum); 65 extern char *get_relid_attribute_name(Oid relid, AttrNumber attnum); 66 extern AttrNumber get_attnum(Oid relid, const char *attname); 67 extern Oid get_atttype(Oid relid, AttrNumber attnum); 68 extern int32 get_atttypmod(Oid relid, AttrNumber attnum); 69 extern void get_atttypetypmodcoll(Oid relid, AttrNumber attnum, 70 Oid *typid, int32 *typmod, Oid *collid); 71 extern char *get_collation_name(Oid colloid); 72 extern char *get_constraint_name(Oid conoid); 73 extern char *get_language_name(Oid langoid, bool missing_ok); 74 extern Oid get_opclass_family(Oid opclass); 75 extern Oid get_opclass_input_type(Oid opclass); 76 extern RegProcedure get_opcode(Oid opno); 77 extern char *get_opname(Oid opno); 78 extern Oid get_op_rettype(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 Oid get_func_variadictype(Oid funcid); 94 extern bool get_func_retset(Oid funcid); 95 extern bool func_strict(Oid funcid); 96 extern char func_volatile(Oid funcid); 97 extern char func_parallel(Oid funcid); 98 extern bool get_func_leakproof(Oid funcid); 99 extern float4 get_func_cost(Oid funcid); 100 extern float4 get_func_rows(Oid funcid); 101 extern Oid get_relname_relid(const char *relname, Oid relnamespace); 102 extern char *get_rel_name(Oid relid); 103 extern Oid get_rel_namespace(Oid relid); 104 extern Oid get_rel_type_id(Oid relid); 105 extern char get_rel_relkind(Oid relid); 106 extern Oid get_rel_tablespace(Oid relid); 107 extern char get_rel_persistence(Oid relid); 108 extern Oid get_transform_fromsql(Oid typid, Oid langid, List *trftypes); 109 extern Oid get_transform_tosql(Oid typid, Oid langid, List *trftypes); 110 extern bool get_typisdefined(Oid typid); 111 extern int16 get_typlen(Oid typid); 112 extern bool get_typbyval(Oid typid); 113 extern void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval); 114 extern void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval, 115 char *typalign); 116 extern Oid getTypeIOParam(HeapTuple typeTuple); 117 extern void get_type_io_data(Oid typid, 118 IOFuncSelector which_func, 119 int16 *typlen, 120 bool *typbyval, 121 char *typalign, 122 char *typdelim, 123 Oid *typioparam, 124 Oid *func); 125 extern char get_typstorage(Oid typid); 126 extern Node *get_typdefault(Oid typid); 127 extern char get_typtype(Oid typid); 128 extern bool type_is_rowtype(Oid typid); 129 extern bool type_is_enum(Oid typid); 130 extern bool type_is_range(Oid typid); 131 extern void get_type_category_preferred(Oid typid, 132 char *typcategory, 133 bool *typispreferred); 134 extern Oid get_typ_typrelid(Oid typid); 135 extern Oid get_element_type(Oid typid); 136 extern Oid get_array_type(Oid typid); 137 extern Oid get_promoted_array_type(Oid typid); 138 extern Oid get_base_element_type(Oid typid); 139 extern void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam); 140 extern void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena); 141 extern void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam); 142 extern void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena); 143 extern Oid get_typmodin(Oid typid); 144 extern Oid get_typcollation(Oid typid); 145 extern bool type_is_collatable(Oid typid); 146 extern Oid getBaseType(Oid typid); 147 extern Oid getBaseTypeAndTypmod(Oid typid, int32 *typmod); 148 extern int32 get_typavgwidth(Oid typid, int32 typmod); 149 extern int32 get_attavgwidth(Oid relid, AttrNumber attnum); 150 extern bool get_attstatsslot(HeapTuple statstuple, 151 Oid atttype, int32 atttypmod, 152 int reqkind, Oid reqop, 153 Oid *actualop, 154 Datum **values, int *nvalues, 155 float4 **numbers, int *nnumbers); 156 extern void free_attstatsslot(Oid atttype, 157 Datum *values, int nvalues, 158 float4 *numbers, int nnumbers); 159 extern char *get_namespace_name(Oid nspid); 160 extern char *get_namespace_name_or_temp(Oid nspid); 161 extern Oid get_range_subtype(Oid rangeOid); 162 extern Oid get_range_collation(Oid rangeOid); 163 extern bool get_index_isreplident(Oid index_oid); 164 extern bool get_index_isclustered(Oid index_oid); 165 166 #define type_is_array(typid) (get_element_type(typid) != InvalidOid) 167 /* type_is_array_domain accepts both plain arrays and domains over arrays */ 168 #define type_is_array_domain(typid) (get_base_element_type(typid) != InvalidOid) 169 170 #define TypeIsToastable(typid) (get_typstorage(typid) != 'p') 171 172 #endif /* LSYSCACHE_H */ 173