1 /*------------------------------------------------------------------------- 2 * 3 * lsyscache.h 4 * Convenience routines for common queries in the system catalog cache. 5 * 6 * Portions Copyright (c) 1996-2020, 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 /* 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() */ 62 typedef int32 (*get_attavgwidth_hook_type) (Oid relid, AttrNumber attnum); 63 extern PGDLLIMPORT get_attavgwidth_hook_type get_attavgwidth_hook; 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); 83 extern List *get_op_btree_interpretation(Oid opno); 84 extern bool equality_ops_are_compatible(Oid opno1, Oid opno2); 85 extern bool comparison_ops_are_compatible(Oid opno1, Oid opno2); 86 extern Oid get_opfamily_proc(Oid opfamily, Oid lefttype, Oid righttype, 87 int16 procnum); 88 extern char *get_attname(Oid relid, AttrNumber attnum, bool missing_ok); 89 extern AttrNumber get_attnum(Oid relid, const char *attname); 90 extern int get_attstattarget(Oid relid, AttrNumber attnum); 91 extern char get_attgenerated(Oid relid, AttrNumber attnum); 92 extern Oid get_atttype(Oid relid, AttrNumber attnum); 93 extern void get_atttypetypmodcoll(Oid relid, AttrNumber attnum, 94 Oid *typid, int32 *typmod, Oid *collid); 95 extern Datum get_attoptions(Oid relid, int16 attnum); 96 extern Oid get_cast_oid(Oid sourcetypeid, Oid targettypeid, bool missing_ok); 97 extern char *get_collation_name(Oid colloid); 98 extern bool get_collation_isdeterministic(Oid colloid); 99 extern char *get_constraint_name(Oid conoid); 100 extern char *get_language_name(Oid langoid, bool missing_ok); 101 extern Oid get_opclass_family(Oid opclass); 102 extern Oid get_opclass_input_type(Oid opclass); 103 extern bool get_opclass_opfamily_and_input_type(Oid opclass, 104 Oid *opfamily, Oid *opcintype); 105 extern RegProcedure get_opcode(Oid opno); 106 extern char *get_opname(Oid opno); 107 extern Oid get_op_rettype(Oid opno); 108 extern void op_input_types(Oid opno, Oid *lefttype, Oid *righttype); 109 extern bool op_mergejoinable(Oid opno, Oid inputtype); 110 extern bool op_hashjoinable(Oid opno, Oid inputtype); 111 extern bool op_strict(Oid opno); 112 extern char op_volatile(Oid opno); 113 extern Oid get_commutator(Oid opno); 114 extern Oid get_negator(Oid opno); 115 extern RegProcedure get_oprrest(Oid opno); 116 extern RegProcedure get_oprjoin(Oid opno); 117 extern char *get_func_name(Oid funcid); 118 extern Oid get_func_namespace(Oid funcid); 119 extern Oid get_func_rettype(Oid funcid); 120 extern int get_func_nargs(Oid funcid); 121 extern Oid get_func_signature(Oid funcid, Oid **argtypes, int *nargs); 122 extern Oid get_func_variadictype(Oid funcid); 123 extern bool get_func_retset(Oid funcid); 124 extern bool func_strict(Oid funcid); 125 extern char func_volatile(Oid funcid); 126 extern char func_parallel(Oid funcid); 127 extern char get_func_prokind(Oid funcid); 128 extern bool get_func_leakproof(Oid funcid); 129 extern RegProcedure get_func_support(Oid funcid); 130 extern Oid get_relname_relid(const char *relname, Oid relnamespace); 131 extern char *get_rel_name(Oid relid); 132 extern Oid get_rel_namespace(Oid relid); 133 extern Oid get_rel_type_id(Oid relid); 134 extern char get_rel_relkind(Oid relid); 135 extern bool get_rel_relispartition(Oid relid); 136 extern Oid get_rel_tablespace(Oid relid); 137 extern char get_rel_persistence(Oid relid); 138 extern Oid get_transform_fromsql(Oid typid, Oid langid, List *trftypes); 139 extern Oid get_transform_tosql(Oid typid, Oid langid, List *trftypes); 140 extern bool get_typisdefined(Oid typid); 141 extern int16 get_typlen(Oid typid); 142 extern bool get_typbyval(Oid typid); 143 extern void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval); 144 extern void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval, 145 char *typalign); 146 extern Oid getTypeIOParam(HeapTuple typeTuple); 147 extern void get_type_io_data(Oid typid, 148 IOFuncSelector which_func, 149 int16 *typlen, 150 bool *typbyval, 151 char *typalign, 152 char *typdelim, 153 Oid *typioparam, 154 Oid *func); 155 extern char get_typstorage(Oid typid); 156 extern Node *get_typdefault(Oid typid); 157 extern char get_typtype(Oid typid); 158 extern bool type_is_rowtype(Oid typid); 159 extern bool type_is_enum(Oid typid); 160 extern bool type_is_range(Oid typid); 161 extern void get_type_category_preferred(Oid typid, 162 char *typcategory, 163 bool *typispreferred); 164 extern Oid get_typ_typrelid(Oid typid); 165 extern Oid get_element_type(Oid typid); 166 extern Oid get_array_type(Oid typid); 167 extern Oid get_promoted_array_type(Oid typid); 168 extern Oid get_base_element_type(Oid typid); 169 extern void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam); 170 extern void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena); 171 extern void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam); 172 extern void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena); 173 extern Oid get_typmodin(Oid typid); 174 extern Oid get_typcollation(Oid typid); 175 extern bool type_is_collatable(Oid typid); 176 extern Oid getBaseType(Oid typid); 177 extern Oid getBaseTypeAndTypmod(Oid typid, int32 *typmod); 178 extern int32 get_typavgwidth(Oid typid, int32 typmod); 179 extern int32 get_attavgwidth(Oid relid, AttrNumber attnum); 180 extern bool get_attstatsslot(AttStatsSlot *sslot, HeapTuple statstuple, 181 int reqkind, Oid reqop, int flags); 182 extern void free_attstatsslot(AttStatsSlot *sslot); 183 extern char *get_namespace_name(Oid nspid); 184 extern char *get_namespace_name_or_temp(Oid nspid); 185 extern Oid get_range_subtype(Oid rangeOid); 186 extern Oid get_range_collation(Oid rangeOid); 187 extern Oid get_index_column_opclass(Oid index_oid, int attno); 188 extern bool get_index_isreplident(Oid index_oid); 189 extern bool get_index_isvalid(Oid index_oid); 190 extern bool get_index_isclustered(Oid index_oid); 191 192 #define type_is_array(typid) (get_element_type(typid) != InvalidOid) 193 /* type_is_array_domain accepts both plain arrays and domains over arrays */ 194 #define type_is_array_domain(typid) (get_base_element_type(typid) != InvalidOid) 195 196 #define TypeIsToastable(typid) (get_typstorage(typid) != TYPSTORAGE_PLAIN) 197 198 #endif /* LSYSCACHE_H */ 199