The EXTFNAPIV4_DESCRIBE_COL_NAME attribute indicates the column name. Used in a describe_column_get scenario.
Description
The column name. This property is valid only for table arguments.
Usage
If a UDF gets this property, then the name of the specified column is returned.
Returns
On success, returns the length of the column name.
On failure, returns one of the generic
describe_column errors, or:
- EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the
query processing phase is not greater than Initial.
- EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH –
get error returned if the buffer length has insufficient characters or is 0 length.
- EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER –
get error returned if the parameter is not a TABLE parameter.
Query Processing Phases
Valid in:
- Annotation phase
- Query Optimization phase
- Plan Building phase
- Execution phase