Describe Column Type (a_v4_extfn_describe_col_type)

The a_v4_extfn_describe_col_type enumerated type selects the column property retrieved or set by the UDF.

Implementation

typedef enum a_v4_extfn_describe_col_type {
    EXTFNAPIV4_DESCRIBE_COL_NAME,
    EXTFNAPIV4_DESCRIBE_COL_TYPE,
    EXTFNAPIV4_DESCRIBE_COL_WIDTH,
    EXTFNAPIV4_DESCRIBE_COL_SCALE,
    EXTFNAPIV4_DESCRIBE_COL_CAN_BE_NULL,
    EXTFNAPIV4_DESCRIBE_COL_DISTINCT_VALUES,
    EXTFNAPIV4_DESCRIBE_COL_IS_UNIQUE,
    EXTFNAPIV4_DESCRIBE_COL_IS_CONSTANT,
    EXTFNAPIV4_DESCRIBE_COL_CONSTANT_VALUE,
    EXTFNAPIV4_DESCRIBE_COL_IS_USED_BY_CONSUMER,
    EXTFNAPIV4_DESCRIBE_COL_MINIMUM_VALUE,
    EXTFNAPIV4_DESCRIBE_COL_MAXIMUM_VALUE,
    EXTFNAPIV4_DESCRIBE_COL_VALUES_SUBSET_OF_INPUT,
    EXTFNAPIV4_DESCRIBE_COL_LAST
} a_v4_extfn_describe_col_type;

Members Summary

Member Description
EXTFNAPIV4_DESCRIBE_COL_NAME Column name (valid identifier).
EXTFNAPIV4_DESCRIBE_COL_TYPE Column data type.
EXTFNAPIV4_DESCRIBE_COL_WIDTH String width (precision for NUMERIC).
EXTFNAPIV4_DESCRIBE_COL_SCALE Scale for NUMERIC.
EXTFNAPIV4_DESCRIBE_COL_CAN_BE_NULL True, if a column can be NULL.
EXTFNAPIV4_DESCRIBE_COL_DISTINCT_VALUES Estimated number of distinct values in the column.
EXTFNAPIV4_DESCRIBE_COL_IS_UNIQUE True, if column is unique within the table.
EXTFNAPIV4_DESCRIBE_COL_IS_CONSTANT True, if column is constant for statement lifetime.
EXTFNAPIV4_DESCRIBE_COL_CONSTANT_VALUE The value of a parameter, if known at describe time.
EXTFNAPIV4_DESCRIBE_COL_IS_USED_BY_CONSUMER True, if column is needed by the consumer of the table.
EXTFNAPIV4_DESCRIBE_COL_MINIMUM_VALUE The minimum value for the column (if known).
EXTFNAPIV4_DESCRIBE_COL_MAXIMUM_VALUE The maximum value for the column (if known).
EXTFNAPIV4_DESCRIBE_COL_VALUES_SUBSET_OF_INPUT The result column values are a subset of columns from an input table.
EXTFNAPIV4_DESCRIBE_COL_LAST First illegal value for v4 API. Out-of-band value.
Parent topic: API Reference for a_v4_extfn