The EXTFNAPIV4_DESCRIBE_PARM_TABLE_REQUEST_REWIND attribute indicates that the consumer requests rewind of an input table. Used in a describe_parameter_get scenario.
Description
Indicates that the consumer wants to rewind an input table. Valid only for table input arguments. By default, this property is false.
Usage
The UDF queries this property to retrieve the true/false value.
Returns
On success, returns sizeof(a_sql_byte).
On failure, returns one of the generic
describe_parameter errors, or:
- EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH
– get error returned if the describe_buffer is not the size of a_sql_byte.
- EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the
phase is not Optimization or Plan Building.
- EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the UDF attempts to get this attribute on parameter 0.
- EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER – get error returned if the UDF attempts to get this attribute on a parameter that is not a table.
Query Processing Phases
Valid in:
- Optimization phase
- Plan Building phase