EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_ROWS Attribute (Set)

Data Type

a_sql_a_v4_extfn_estimate

Description

The estimated number of rows in the table. Only valid for argument 0 and table arguments.

Usage

The UDF sets this property for argument 0 if it estimates the number of rows in the result set. The server uses the estimate during optimization to make query processing decisions. You cannot set this value for an input table.

If you do not set a value, the server defaults to the number of rows specified by the DEFAULT_TABLE_UDF_ROW_COUNT option.

Returns

On success, returns a_v4_extfn_estimate.

On failure, returns one of the generic describe_parameter errors or:

• EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – set error returned if the describe_buffer is not the size of a_v4_extfn_estimate.
• EXTFNAPIV4_DESCRIBE_INVALID_STATE – set error returned if the state is not Optimization.
• EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER – get error returned if the parameter is not a table parameter.
• EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the table parameter is not the result table.
• EXTFNAPI4_DESCRIBE_INVALID_ATTRIBUTE_VALUE – get error returned if the UDF tries to reset the number of columns of the specified table.

Query Processing States