PostgreSQL Source Code  git master
format_type.c File Reference
#include "postgres.h"
#include <ctype.h>
#include "access/htup_details.h"
#include "catalog/namespace.h"
#include "catalog/pg_type.h"
#include "mb/pg_wchar.h"
#include "utils/builtins.h"
#include "utils/fmgroids.h"
#include "utils/lsyscache.h"
#include "utils/numeric.h"
#include "utils/syscache.h"
Include dependency graph for format_type.c:

Go to the source code of this file.

Functions

static char * printTypmod (const char *typname, int32 typmod, Oid typmodout)
 
Datum format_type (PG_FUNCTION_ARGS)
 
char * format_type_extended (Oid type_oid, int32 typemod, bits16 flags)
 
char * format_type_be (Oid type_oid)
 
char * format_type_be_qualified (Oid type_oid)
 
char * format_type_with_typemod (Oid type_oid, int32 typemod)
 
int32 type_maximum_size (Oid type_oid, int32 typemod)
 
Datum oidvectortypes (PG_FUNCTION_ARGS)
 

Function Documentation

◆ format_type()

Datum format_type ( PG_FUNCTION_ARGS  )

Definition at line 60 of file format_type.c.

61 {
62  Oid type_oid;
63  int32 typemod;
64  char *result;
66 
67  /* Since this function is not strict, we must test for null args */
68  if (PG_ARGISNULL(0))
70 
71  type_oid = PG_GETARG_OID(0);
72 
73  if (PG_ARGISNULL(1))
74  typemod = -1;
75  else
76  {
77  typemod = PG_GETARG_INT32(1);
79  }
80 
81  result = format_type_extended(type_oid, typemod, flags);
82 
84 }
#define FORMAT_TYPE_ALLOW_INVALID
Definition: builtins.h:113
#define FORMAT_TYPE_TYPEMOD_GIVEN
Definition: builtins.h:112
uint16 bits16
Definition: c.h:449
signed int int32
Definition: c.h:429
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define PG_RETURN_NULL()
Definition: fmgr.h:345
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:372
#define PG_GETARG_INT32(n)
Definition: fmgr.h:269
char * format_type_extended(Oid type_oid, int32 typemod, bits16 flags)
Definition: format_type.c:112
unsigned int Oid
Definition: postgres_ext.h:31
text * cstring_to_text(const char *s)
Definition: varlena.c:188

References cstring_to_text(), FORMAT_TYPE_ALLOW_INVALID, format_type_extended(), FORMAT_TYPE_TYPEMOD_GIVEN, PG_ARGISNULL, PG_GETARG_INT32, PG_GETARG_OID, PG_RETURN_NULL, and PG_RETURN_TEXT_P.

Referenced by _copyJsonFormat(), _equalJsonFormat(), _outJsonFormat(), and _readJsonFormat().

◆ format_type_be()

char* format_type_be ( Oid  type_oid)

Definition at line 343 of file format_type.c.

344 {
345  return format_type_extended(type_oid, -1, 0);
346 }

References format_type_extended().

Referenced by aclcheck_error_type(), addFamilyMember(), addRangeTableEntryForFunction(), AggregateCreate(), AlterType(), AlterTypeNamespace(), AlterTypeNamespace_oid(), AlterTypeNamespaceInternal(), AlterTypeOwner(), analyzeCTE(), appendTypeNameToBuffer(), array_cat(), array_cmp(), array_contain_compare(), array_eq(), array_position_common(), array_positions(), array_recv(), array_replace_internal(), array_send(), assign_record_type_identifier(), ATAddForeignKeyConstraint(), ATExecAlterColumnType(), ATExecSetStorage(), ATPrepAlterColumnType(), brinvalidate(), btvalidate(), build_attrmap_by_name(), build_column_default(), build_datatype(), build_subplan(), CastCreate(), check_object_ownership(), check_of_type(), check_safe_enum_use(), check_sql_fn_retval(), check_valid_polymorphic_signature(), CheckAttributeType(), checkDomainOwner(), checkEnumOwner(), checkRuleResultList(), CheckVarSlotCompatibility(), coerce_record_to_complex(), coerce_to_boolean(), coerce_to_common_type(), coerce_to_specific_type_typmod(), coerce_type(), coerceDefaultJsonExpr(), coerceJsonFuncExpr(), compare_values_of_enum(), compile_plperl_function(), compile_pltcl_function(), ComputeIndexAttrs(), ComputePartitionAttrs(), cookDefault(), create_ctas_nodata(), CreateCast(), CreateFunction(), CreateStatistics(), CreateTransform(), DefineAggregate(), DefineDomain(), DefineRange(), DefineType(), do_compile(), domain_check_input(), domain_state_setup(), dropOperators(), dropProcedures(), enforce_generic_type_consistency(), enum_first(), enum_in(), enum_last(), enum_recv(), EvaluateParams(), exec_stmt_foreach_a(), ExecBuildUpdateProjection(), ExecCheckPlanOutput(), ExecEvalArrayExpr(), ExecEvalConstraintCheck(), ExecEvalConstraintNotNull(), ExecEvalFieldSelect(), ExecEvalParamExtern(), ExecEvalWholeRowVar(), ExecInitAgg(), ExecInitExprRec(), ExecInitSubscriptingRef(), exprType(), extract_date(), fetch_cursor_param_value(), findRangeSubOpclass(), findTypeInputFunction(), findTypeReceiveFunction(), fmgr_sql_validator(), format_operator_extended(), format_procedure_extended(), funcname_signature_string(), get_cached_rowtype(), get_cast_oid(), get_domain_constraint_oid(), get_expr_result_tupdesc(), get_multirange_io_data(), get_range_io_data(), get_rels_with_domain(), get_sort_group_operators(), get_transform_oid(), get_ts_parser_func(), get_ts_template_func(), GetAttributeCompression(), GetColumnDefCollation(), GetDefaultOpClass(), getObjectDescription(), getTypeBinaryInputInfo(), getTypeBinaryOutputInfo(), getTypeInputInfo(), getTypeOutputInfo(), hash_array(), hash_array_extended(), hash_multirange(), hash_multirange_extended(), hash_range(), hash_range_extended(), hash_record(), hash_record_extended(), hashvalidate(), init_params(), initArrayResultArr(), initGinState(), internal_get_result_type(), interval_part_common(), interval_trunc(), intorel_startup(), jsonb_subscript_transform(), load_enum_cache_data(), lookup_rowtype_tupdesc_domain(), lookup_rowtype_tupdesc_internal(), LookupTypeNameExtended(), make_expanded_record_from_tupdesc(), make_expanded_record_from_typeid(), make_row_comparison_op(), make_scalar_array_op(), NonFiniteTimestampTzPart(), op_signature_string(), ParseFuncOrColumn(), pg_collation_for(), plperl_array_to_datum(), plperl_sv_to_datum(), plperl_validator(), plpgsql_build_variable(), plpgsql_param_eval_generic(), plpgsql_param_eval_generic_ro(), plpgsql_param_eval_recfield(), plpgsql_validator(), PLy_procedure_create(), prepare_sql_fn_parse_info(), print_function_arguments(), print_function_rettype(), print_function_trftypes(), processIndirection(), record_cmp(), record_eq(), record_image_cmp(), record_image_eq(), regtypeout(), RelationBuildPartitionKey(), RenameConstraintById(), RenameType(), resolve_anyarray_from_others(), resolve_anyelement_from_others(), resolve_anymultirange_from_others(), resolve_anyrange_from_others(), ResolveOpClass(), revalidate_rectypeid(), ri_HashCompareOp(), satisfies_hash_partition(), select_common_type(), select_common_type_from_oids(), spgvalidate(), storeOperators(), storeProcedures(), time_part_common(), timestamp_part_common(), timestamp_trunc(), timestamptz_part_common(), timestamptz_trunc_internal(), timetz_part_common(), transformAggregateCall(), transformArrayExpr(), transformAssignedExpr(), transformAssignmentIndirection(), transformAssignmentSubscripts(), transformCollateClause(), transformColumnType(), transformContainerSubscripts(), transformFrameOffset(), transformJsonConstructorRet(), transformJsonExprCommon(), transformJsonFuncExpr(), transformJsonIsPredicate(), transformJsonValueExprExt(), transformPartitionBoundValue(), transformPLAssignStmt(), transformTypeCast(), transformXmlSerialize(), tuple_to_stringinfo(), tupledesc_match(), tuples_equal(), unknown_attribute(), validateConnectbyTupleDesc(), variable_coerce_param_hook(), and width_bucket_array().

◆ format_type_be_qualified()

char* format_type_be_qualified ( Oid  type_oid)

◆ format_type_extended()

char* format_type_extended ( Oid  type_oid,
int32  typemod,
bits16  flags 
)

Definition at line 112 of file format_type.c.

113 {
114  HeapTuple tuple;
115  Form_pg_type typeform;
116  Oid array_base_type;
117  bool is_array;
118  char *buf;
119  bool with_typemod;
120 
121  if (type_oid == InvalidOid)
122  {
123  if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
124  return NULL;
125  else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
126  return pstrdup("-");
127  }
128 
129  tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(type_oid));
130  if (!HeapTupleIsValid(tuple))
131  {
132  if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
133  return NULL;
134  else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
135  return pstrdup("???");
136  else
137  elog(ERROR, "cache lookup failed for type %u", type_oid);
138  }
139  typeform = (Form_pg_type) GETSTRUCT(tuple);
140 
141  /*
142  * Check if it's a "true" array type. Pseudo-array types such as "name"
143  * shouldn't get deconstructed. Also check the toast property, and don't
144  * deconstruct "plain storage" array types --- this is because we don't
145  * want to show oidvector as oid[].
146  */
147  array_base_type = typeform->typelem;
148 
149  if (IsTrueArrayType(typeform) &&
150  typeform->typstorage != TYPSTORAGE_PLAIN)
151  {
152  /* Switch our attention to the array element type */
153  ReleaseSysCache(tuple);
154  tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(array_base_type));
155  if (!HeapTupleIsValid(tuple))
156  {
157  if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
158  return NULL;
159  else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
160  return pstrdup("???[]");
161  else
162  elog(ERROR, "cache lookup failed for type %u", type_oid);
163  }
164  typeform = (Form_pg_type) GETSTRUCT(tuple);
165  type_oid = array_base_type;
166  is_array = true;
167  }
168  else
169  is_array = false;
170 
171  with_typemod = (flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0 && (typemod >= 0);
172 
173  /*
174  * See if we want to special-case the output for certain built-in types.
175  * Note that these special cases should all correspond to special
176  * productions in gram.y, to ensure that the type name will be taken as a
177  * system type, not a user type of the same name.
178  *
179  * If we do not provide a special-case output here, the type name will be
180  * handled the same way as a user type name --- in particular, it will be
181  * double-quoted if it matches any lexer keyword. This behavior is
182  * essential for some cases, such as types "bit" and "char".
183  */
184  buf = NULL; /* flag for no special case */
185 
186  switch (type_oid)
187  {
188  case BITOID:
189  if (with_typemod)
190  buf = printTypmod("bit", typemod, typeform->typmodout);
191  else if ((flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0)
192  {
193  /*
194  * bit with typmod -1 is not the same as BIT, which means
195  * BIT(1) per SQL spec. Report it as the quoted typename so
196  * that parser will not assign a bogus typmod.
197  */
198  }
199  else
200  buf = pstrdup("bit");
201  break;
202 
203  case BOOLOID:
204  buf = pstrdup("boolean");
205  break;
206 
207  case BPCHAROID:
208  if (with_typemod)
209  buf = printTypmod("character", typemod, typeform->typmodout);
210  else if ((flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0)
211  {
212  /*
213  * bpchar with typmod -1 is not the same as CHARACTER, which
214  * means CHARACTER(1) per SQL spec. Report it as bpchar so
215  * that parser will not assign a bogus typmod.
216  */
217  }
218  else
219  buf = pstrdup("character");
220  break;
221 
222  case FLOAT4OID:
223  buf = pstrdup("real");
224  break;
225 
226  case FLOAT8OID:
227  buf = pstrdup("double precision");
228  break;
229 
230  case INT2OID:
231  buf = pstrdup("smallint");
232  break;
233 
234  case INT4OID:
235  buf = pstrdup("integer");
236  break;
237 
238  case INT8OID:
239  buf = pstrdup("bigint");
240  break;
241 
242  case NUMERICOID:
243  if (with_typemod)
244  buf = printTypmod("numeric", typemod, typeform->typmodout);
245  else
246  buf = pstrdup("numeric");
247  break;
248 
249  case INTERVALOID:
250  if (with_typemod)
251  buf = printTypmod("interval", typemod, typeform->typmodout);
252  else
253  buf = pstrdup("interval");
254  break;
255 
256  case TIMEOID:
257  if (with_typemod)
258  buf = printTypmod("time", typemod, typeform->typmodout);
259  else
260  buf = pstrdup("time without time zone");
261  break;
262 
263  case TIMETZOID:
264  if (with_typemod)
265  buf = printTypmod("time", typemod, typeform->typmodout);
266  else
267  buf = pstrdup("time with time zone");
268  break;
269 
270  case TIMESTAMPOID:
271  if (with_typemod)
272  buf = printTypmod("timestamp", typemod, typeform->typmodout);
273  else
274  buf = pstrdup("timestamp without time zone");
275  break;
276 
277  case TIMESTAMPTZOID:
278  if (with_typemod)
279  buf = printTypmod("timestamp", typemod, typeform->typmodout);
280  else
281  buf = pstrdup("timestamp with time zone");
282  break;
283 
284  case VARBITOID:
285  if (with_typemod)
286  buf = printTypmod("bit varying", typemod, typeform->typmodout);
287  else
288  buf = pstrdup("bit varying");
289  break;
290 
291  case VARCHAROID:
292  if (with_typemod)
293  buf = printTypmod("character varying", typemod, typeform->typmodout);
294  else
295  buf = pstrdup("character varying");
296  break;
297 
298  case JSONOID:
299  buf = pstrdup("json");
300  break;
301  }
302 
303  if (buf == NULL)
304  {
305  /*
306  * Default handling: report the name as it appears in the catalog.
307  * Here, we must qualify the name if it is not visible in the search
308  * path or if caller requests it; and we must double-quote it if it's
309  * not a standard identifier or if it matches any keyword.
310  */
311  char *nspname;
312  char *typname;
313 
314  if ((flags & FORMAT_TYPE_FORCE_QUALIFY) == 0 &&
315  TypeIsVisible(type_oid))
316  nspname = NULL;
317  else
318  nspname = get_namespace_name_or_temp(typeform->typnamespace);
319 
320  typname = NameStr(typeform->typname);
321 
323 
324  if (with_typemod)
325  buf = printTypmod(buf, typemod, typeform->typmodout);
326  }
327 
328  if (is_array)
329  buf = psprintf("%s[]", buf);
330 
331  ReleaseSysCache(tuple);
332 
333  return buf;
334 }
#define FORMAT_TYPE_INVALID_AS_NULL
Definition: builtins.h:115
#define NameStr(name)
Definition: c.h:681
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
static char * printTypmod(const char *typname, int32 typmod, Oid typmodout)
Definition: format_type.c:371
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:649
char * get_namespace_name_or_temp(Oid nspid)
Definition: lsyscache.c:3350
char * pstrdup(const char *in)
Definition: mcxt.c:1305
bool TypeIsVisible(Oid typid)
Definition: namespace.c:818
static char * buf
Definition: pg_test_fsync.c:67
FormData_pg_type * Form_pg_type
Definition: pg_type.h:261
NameData typname
Definition: pg_type.h:41
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
#define InvalidOid
Definition: postgres_ext.h:36
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
char * quote_qualified_identifier(const char *qualifier, const char *ident)
Definition: ruleutils.c:12276
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1221
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1173
@ TYPEOID
Definition: syscache.h:114

References buf, elog, ERROR, FORMAT_TYPE_ALLOW_INVALID, FORMAT_TYPE_FORCE_QUALIFY, FORMAT_TYPE_INVALID_AS_NULL, FORMAT_TYPE_TYPEMOD_GIVEN, get_namespace_name_or_temp(), GETSTRUCT, HeapTupleIsValid, InvalidOid, NameStr, ObjectIdGetDatum, printTypmod(), psprintf(), pstrdup(), quote_qualified_identifier(), ReleaseSysCache(), SearchSysCache1(), TypeIsVisible(), TYPEOID, and typname.

Referenced by array_recv(), deparse_type_name(), format_type(), format_type_be(), format_type_be_qualified(), format_type_with_typemod(), getObjectDescription(), getObjectIdentityParts(), lookup_am_handler_func(), oidvectortypes(), and record_recv().

◆ format_type_with_typemod()

◆ oidvectortypes()

Datum oidvectortypes ( PG_FUNCTION_ARGS  )

Definition at line 447 of file format_type.c.

448 {
449  oidvector *oidArray = (oidvector *) PG_GETARG_POINTER(0);
450  char *result;
451  int numargs = oidArray->dim1;
452  int num;
453  size_t total;
454  size_t left;
455 
456  total = 20 * numargs + 1;
457  result = palloc(total);
458  result[0] = '\0';
459  left = total - 1;
460 
461  for (num = 0; num < numargs; num++)
462  {
463  char *typename = format_type_extended(oidArray->values[num], -1,
465  size_t slen = strlen(typename);
466 
467  if (left < (slen + 2))
468  {
469  total += slen + 2;
470  result = repalloc(result, total);
471  left += slen + 2;
472  }
473 
474  if (num > 0)
475  {
476  strcat(result, ", ");
477  left -= 2;
478  }
479  strcat(result, typename);
480  left -= slen;
481  }
482 
484 }
#define PG_GETARG_POINTER(n)
Definition: fmgr.h:276
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1188
void * palloc(Size size)
Definition: mcxt.c:1068
Definition: c.h:661
int dim1
Definition: c.h:666
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:668

References cstring_to_text(), oidvector::dim1, FORMAT_TYPE_ALLOW_INVALID, format_type_extended(), palloc(), PG_GETARG_POINTER, PG_RETURN_TEXT_P, repalloc(), and oidvector::values.

◆ printTypmod()

static char * printTypmod ( const char *  typname,
int32  typmod,
Oid  typmodout 
)
static

Definition at line 371 of file format_type.c.

372 {
373  char *res;
374 
375  /* Shouldn't be called if typmod is -1 */
376  Assert(typmod >= 0);
377 
378  if (typmodout == InvalidOid)
379  {
380  /* Default behavior: just print the integer typmod with parens */
381  res = psprintf("%s(%d)", typname, (int) typmod);
382  }
383  else
384  {
385  /* Use the type-specific typmodout procedure */
386  char *tmstr;
387 
388  tmstr = DatumGetCString(OidFunctionCall1(typmodout,
389  Int32GetDatum(typmod)));
390  res = psprintf("%s%s", typname, tmstr);
391  }
392 
393  return res;
394 }
#define OidFunctionCall1(functionId, arg1)
Definition: fmgr.h:669
Assert(fmt[strlen(fmt) - 1] !='\n')
#define Int32GetDatum(X)
Definition: postgres.h:523
#define DatumGetCString(X)
Definition: postgres.h:610

References Assert(), DatumGetCString, Int32GetDatum, InvalidOid, OidFunctionCall1, psprintf(), res, and typname.

Referenced by format_type_extended().

◆ type_maximum_size()

int32 type_maximum_size ( Oid  type_oid,
int32  typemod 
)

Definition at line 412 of file format_type.c.

413 {
414  if (typemod < 0)
415  return -1;
416 
417  switch (type_oid)
418  {
419  case BPCHAROID:
420  case VARCHAROID:
421  /* typemod includes varlena header */
422 
423  /* typemod is in characters not bytes */
424  return (typemod - VARHDRSZ) *
426  + VARHDRSZ;
427 
428  case NUMERICOID:
429  return numeric_maximum_size(typemod);
430 
431  case VARBITOID:
432  case BITOID:
433  /* typemod is the (max) number of bits */
434  return (typemod + (BITS_PER_BYTE - 1)) / BITS_PER_BYTE
435  + 2 * sizeof(int32);
436  }
437 
438  /* Unknown type, or unlimited-width type such as 'text' */
439  return -1;
440 }
int32 numeric_maximum_size(int32 typmod)
Definition: numeric.c:872
#define VARHDRSZ
Definition: c.h:627
int GetDatabaseEncoding(void)
Definition: mbutils.c:1210
#define BITS_PER_BYTE
int pg_encoding_max_length(int encoding)
Definition: wchar.c:2187

References BITS_PER_BYTE, GetDatabaseEncoding(), numeric_maximum_size(), pg_encoding_max_length(), and VARHDRSZ.

Referenced by get_typavgwidth(), and heapam_relation_needs_toast_table().