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.

{
    Oid         type_oid;
    int32       typemod;
    char       *result;
    bits16      flags = FORMAT_TYPE_ALLOW_INVALID;
 
    /* Since this function is not strict, we must test for null args */
    if (PG_ARGISNULL(0))
        PG_RETURN_NULL();
 
    type_oid = PG_GETARG_OID(0);
 
    if (PG_ARGISNULL(1))
        typemod = -1;
    else
    {
        typemod = PG_GETARG_INT32(1);
        flags |= FORMAT_TYPE_TYPEMOD_GIVEN;
    }
 
    result = format_type_extended(type_oid, typemod, flags);
 
    PG_RETURN_TEXT_P(cstring_to_text(result));
}

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.

format_type_be()

char * format_type_be

(

Oid

type_oid

)

Definition at line 343 of file format_type.c.

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

References format_type_extended().

Referenced by aclcheck_error_type(), addFamilyMember(), addRangeTableEntryForFunction(), AggregateCreate(), AlterType(), AlterTypeNamespace(), AlterTypeNamespace_oid(), AlterTypeNamespaceInternal(), AlterTypeOwner(), AlterTypeOwnerInternal(), 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(), 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(), 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(), ExecAlterExtensionContentsRecurse(), 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(), GetAttributeStorage(), GetColumnDefCollation(), GetDefaultOpClass(), getObjectDescription(), GetOperatorFromCompareType(), 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(), JsonItemFromDatum(), 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(), NonFiniteIntervalPart(), NonFiniteTimestampTzPart(), op_signature_string(), ParseFuncOrColumn(), pg_collation_for(), plperl_array_to_datum(), plperl_sv_to_datum(), plperl_validator(), plpgsql_build_datatype_arrayof(), 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(), stats_check_arg_type(), stats_fill_fcinfo_from_arg_pairs(), 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(), transformJsonBehavior(), transformJsonFuncExpr(), transformJsonIsPredicate(), transformJsonReturning(), transformJsonSerializeExpr(), transformJsonValueExpr(), 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

)

Definition at line 353 of file format_type.c.

{
    return format_type_extended(type_oid, -1, FORMAT_TYPE_FORCE_QUALIFY);
}

References format_type_extended(), and FORMAT_TYPE_FORCE_QUALIFY.

Referenced by format_operator_extended(), format_operator_parts(), format_procedure_extended(), format_procedure_parts(), and getObjectIdentityParts().

format_type_extended()

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

Definition at line 112 of file format_type.c.

{
    HeapTuple   tuple;
    Form_pg_type typeform;
    Oid         array_base_type;
    bool        is_array;
    char       *buf;
    bool        with_typemod;
 
    if (type_oid == InvalidOid)
    {
        if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
            return NULL;
        else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
            return pstrdup("-");
    }
 
    tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(type_oid));
    if (!HeapTupleIsValid(tuple))
    {
        if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
            return NULL;
        else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
            return pstrdup("???");
        else
            elog(ERROR, "cache lookup failed for type %u", type_oid);
    }
    typeform = (Form_pg_type) GETSTRUCT(tuple);
 
    /*
     * Check if it's a "true" array type.  Pseudo-array types such as "name"
     * shouldn't get deconstructed.  Also check the toast property, and don't
     * deconstruct "plain storage" array types --- this is because we don't
     * want to show oidvector as oid[].
     */
    array_base_type = typeform->typelem;
 
    if (IsTrueArrayType(typeform) &&
        typeform->typstorage != TYPSTORAGE_PLAIN)
    {
        /* Switch our attention to the array element type */
        ReleaseSysCache(tuple);
        tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(array_base_type));
        if (!HeapTupleIsValid(tuple))
        {
            if ((flags & FORMAT_TYPE_INVALID_AS_NULL) != 0)
                return NULL;
            else if ((flags & FORMAT_TYPE_ALLOW_INVALID) != 0)
                return pstrdup("???[]");
            else
                elog(ERROR, "cache lookup failed for type %u", type_oid);
        }
        typeform = (Form_pg_type) GETSTRUCT(tuple);
        type_oid = array_base_type;
        is_array = true;
    }
    else
        is_array = false;
 
    with_typemod = (flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0 && (typemod >= 0);
 
    /*
     * See if we want to special-case the output for certain built-in types.
     * Note that these special cases should all correspond to special
     * productions in gram.y, to ensure that the type name will be taken as a
     * system type, not a user type of the same name.
     *
     * If we do not provide a special-case output here, the type name will be
     * handled the same way as a user type name --- in particular, it will be
     * double-quoted if it matches any lexer keyword.  This behavior is
     * essential for some cases, such as types "bit" and "char".
     */
    buf = NULL;                 /* flag for no special case */
 
    switch (type_oid)
    {
        case BITOID:
            if (with_typemod)
                buf = printTypmod("bit", typemod, typeform->typmodout);
            else if ((flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0)
            {
                /*
                 * bit with typmod -1 is not the same as BIT, which means
                 * BIT(1) per SQL spec.  Report it as the quoted typename so
                 * that parser will not assign a bogus typmod.
                 */
            }
            else
                buf = pstrdup("bit");
            break;
 
        case BOOLOID:
            buf = pstrdup("boolean");
            break;
 
        case BPCHAROID:
            if (with_typemod)
                buf = printTypmod("character", typemod, typeform->typmodout);
            else if ((flags & FORMAT_TYPE_TYPEMOD_GIVEN) != 0)
            {
                /*
                 * bpchar with typmod -1 is not the same as CHARACTER, which
                 * means CHARACTER(1) per SQL spec.  Report it as bpchar so
                 * that parser will not assign a bogus typmod.
                 */
            }
            else
                buf = pstrdup("character");
            break;
 
        case FLOAT4OID:
            buf = pstrdup("real");
            break;
 
        case FLOAT8OID:
            buf = pstrdup("double precision");
            break;
 
        case INT2OID:
            buf = pstrdup("smallint");
            break;
 
        case INT4OID:
            buf = pstrdup("integer");
            break;
 
        case INT8OID:
            buf = pstrdup("bigint");
            break;
 
        case NUMERICOID:
            if (with_typemod)
                buf = printTypmod("numeric", typemod, typeform->typmodout);
            else
                buf = pstrdup("numeric");
            break;
 
        case INTERVALOID:
            if (with_typemod)
                buf = printTypmod("interval", typemod, typeform->typmodout);
            else
                buf = pstrdup("interval");
            break;
 
        case TIMEOID:
            if (with_typemod)
                buf = printTypmod("time", typemod, typeform->typmodout);
            else
                buf = pstrdup("time without time zone");
            break;
 
        case TIMETZOID:
            if (with_typemod)
                buf = printTypmod("time", typemod, typeform->typmodout);
            else
                buf = pstrdup("time with time zone");
            break;
 
        case TIMESTAMPOID:
            if (with_typemod)
                buf = printTypmod("timestamp", typemod, typeform->typmodout);
            else
                buf = pstrdup("timestamp without time zone");
            break;
 
        case TIMESTAMPTZOID:
            if (with_typemod)
                buf = printTypmod("timestamp", typemod, typeform->typmodout);
            else
                buf = pstrdup("timestamp with time zone");
            break;
 
        case VARBITOID:
            if (with_typemod)
                buf = printTypmod("bit varying", typemod, typeform->typmodout);
            else
                buf = pstrdup("bit varying");
            break;
 
        case VARCHAROID:
            if (with_typemod)
                buf = printTypmod("character varying", typemod, typeform->typmodout);
            else
                buf = pstrdup("character varying");
            break;
 
        case JSONOID:
            buf = pstrdup("json");
            break;
    }
 
    if (buf == NULL)
    {
        /*
         * Default handling: report the name as it appears in the catalog.
         * Here, we must qualify the name if it is not visible in the search
         * path or if caller requests it; and we must double-quote it if it's
         * not a standard identifier or if it matches any keyword.
         */
        char       *nspname;
        char       *typname;
 
        if ((flags & FORMAT_TYPE_FORCE_QUALIFY) == 0 &&
            TypeIsVisible(type_oid))
            nspname = NULL;
        else
            nspname = get_namespace_name_or_temp(typeform->typnamespace);
 
        typname = NameStr(typeform->typname);
 
        buf = quote_qualified_identifier(nspname, typname);
 
        if (with_typemod)
            buf = printTypmod(buf, typemod, typeform->typmodout);
    }
 
    if (is_array)
        buf = psprintf("%s[]", buf);
 
    ReleaseSysCache(tuple);
 
    return buf;
}

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(), and typname.

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

format_type_with_typemod()

char * format_type_with_typemod	(	Oid	type_oid,
		int32	typemod
	)

Definition at line 362 of file format_type.c.

{
    return format_type_extended(type_oid, typemod, FORMAT_TYPE_TYPEMOD_GIVEN);
}

References format_type_extended(), and FORMAT_TYPE_TYPEMOD_GIVEN.

Referenced by analyzeCTE(), ATPrepAlterColumnType(), build_attrmap_by_position(), checkRuleResultList(), checkViewColumns(), compatConnectbyTupleDescs(), compatCrosstabTupleDescs(), get_coercion_expr(), get_const_expr(), get_from_clause_coldeflist(), get_json_returning(), get_json_table_columns(), get_rule_expr(), get_rule_expr_funccall(), get_variable(), get_xmltable(), MergeChildAttribute(), and MergeInheritedAttribute().

oidvectortypes()

Datum oidvectortypes

(

PG_FUNCTION_ARGS

)

Definition at line 447 of file format_type.c.

{
    oidvector  *oidArray = (oidvector *) PG_GETARG_POINTER(0);
    char       *result;
    int         numargs = oidArray->dim1;
    int         num;
    size_t      total;
    size_t      left;
 
    total = 20 * numargs + 1;
    result = palloc(total);
    result[0] = '\0';
    left = total - 1;
 
    for (num = 0; num < numargs; num++)
    {
        char       *typename = format_type_extended(oidArray->values[num], -1,
                                                    FORMAT_TYPE_ALLOW_INVALID);
        size_t      slen = strlen(typename);
 
        if (left < (slen + 2))
        {
            total += slen + 2;
            result = repalloc(result, total);
            left += slen + 2;
        }
 
        if (num > 0)
        {
            strcat(result, ", ");
            left -= 2;
        }
        strcat(result, typename);
        left -= slen;
    }
 
    PG_RETURN_TEXT_P(cstring_to_text(result));
}

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.

{
    char       *res;
 
    /* Shouldn't be called if typmod is -1 */
    Assert(typmod >= 0);
 
    if (typmodout == InvalidOid)
    {
        /* Default behavior: just print the integer typmod with parens */
        res = psprintf("%s(%d)", typname, (int) typmod);
    }
    else
    {
        /* Use the type-specific typmodout procedure */
        char       *tmstr;
 
        tmstr = DatumGetCString(OidFunctionCall1(typmodout,
                                                 Int32GetDatum(typmod)));
        res = psprintf("%s%s", typname, tmstr);
    }
 
    return res;
}

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.

{
    if (typemod < 0)
        return -1;
 
    switch (type_oid)
    {
        case BPCHAROID:
        case VARCHAROID:
            /* typemod includes varlena header */
 
            /* typemod is in characters not bytes */
            return (typemod - VARHDRSZ) *
                pg_encoding_max_length(GetDatabaseEncoding())
                + VARHDRSZ;
 
        case NUMERICOID:
            return numeric_maximum_size(typemod);
 
        case VARBITOID:
        case BITOID:
            /* typemod is the (max) number of bits */
            return (typemod + (BITS_PER_BYTE - 1)) / BITS_PER_BYTE
                + 2 * sizeof(int32);
    }
 
    /* Unknown type, or unlimited-width type such as 'text' */
    return -1;
}

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

Referenced by get_typavgwidth(), and heapam_relation_needs_toast_table().