Describe Parameter Type (a_v4_extfn_describe_parm

The a_v4_extfn_describe_parm_type enumerated type selects the parameter property retrieved or set by the UDF.

Implementation

typedef enum a_v4_extfn_describe_parm_type {
    EXTFNAPIV4_DESCRIBE_PARM_NAME,
    EXTFNAPIV4_DESCRIBE_PARM_TYPE,
    EXTFNAPIV4_DESCRIBE_PARM_WIDTH,
    EXTFNAPIV4_DESCRIBE_PARM_SCALE,
    EXTFNAPIV4_DESCRIBE_PARM_CAN_BE_NULL,
    EXTFNAPIV4_DESCRIBE_PARM_DISTINCT_VALUES,
    EXTFNAPIV4_DESCRIBE_PARM_IS_CONSTANT,
    EXTFNAPIV4_DESCRIBE_PARM_CONSTANT_VALUE,
    
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_COLUMNS,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_ROWS,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_ORDERBY,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_PARTITIONBY,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_REQUEST_REWIND,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_HAS_REWIND,
    EXTFNAPIV4_DESCRIBE_PARM_TABLE_UNUSED_COLUMNS,

    EXTFNAPIV4_DESCRIBE_PARM_LAST
} a_v4_extfn_describe_parm_type;

Members Summary

Member	Description
`EXTFNAPIV4_DESCRIBE_PARM_NAME`	Parameter name (valid identifier).
`EXTFNAPIV4_DESCRIBE_PARM_TYPE`	Data type.
`EXTFNAPIV4_DESCRIBE_PARM_WIDTH`	String width (precision for NUMERIC).
`EXTFNAPIV4_DESCRIBE_PARM_SCALE`	Scale for NUMERIC.
`EXTFNAPIV4_DESCRIBE_PARM_CAN_BE_NULL`	True, if the value can be NULL.
`EXTFNAPIV4_DESCRIBE_PARM_DISTINCT_VALUES`	Estimated number of distinct values across all invocations.
`EXTFNAPIV4_DESCRIBE_PARM_IS_CONSTANT`	True, if parameter is a constant for the statement.
`EXTFNAPIV4_DESCRIBE_PARM_CONSTANT_VALUE`	The value of a parameter, if known at describe time.
These selectors can retrieve or set properties of a TABLE parameter. These enumerator values cannot be used with scalar parameters:
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_COLUMNS`	The number of columns in the table.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_ROWS`	Estimated number of rows in the table.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_ORDERBY`	The order of rows in a table.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_PARTITIONBY`	The partitioning; use `number_of_columns`=0 for ANY.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_REQUEST_REWIND`	True, if the consumer wants the ability rewind the input table.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_HAS_REWIND`	Return true, if the producer supports rewind.
`EXTFNAPIV4_DESCRIBE_PARM_TABLE_UNUSED_COLUMNS`	The list of output table columns that are not going to be consumed by the server or the UDF.
`EXTFNAPIV4_DESCRIBE_PARM_LAST`	First illegal value for v4 API. Out-of-band value.

Describe Parameter Type (a_v4_extfn_describe_parm_type)

Implementation

Members Summary