EXTFNAPIV4_DESCRIBE_COL_WIDTH (Set)

The EXTFNAPIV4_DESCRIBE_COL_WIDTH attribute indicates the width of the column. Used in a describe_column_set scenario.

Data Type

a_sql_uint32

Description

The width of a column. Column width is the amount of storage, in bytes, required to store a value of the associated data type. This property is valid only for table arguments.

Usage

If the UDF sets this property, the server compares the value with the width of the column supplied in the CREATE PROCEDURE statement. This allows the UDF to ensure the CREATE PROCEDURE statement has the same column width as expected by the UDF.

Returns

On success, returns the sizeof(a_sql_uint32).

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

  • EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – set error returned if the describe buffer is not the size of a_sql_uint32.

  • EXTFNAPIV4_DESCRIBE_INVALID_STATE – set error returned if the query processing state is not Annotation.

  • EXTFNAPIV4_DESCRIBE_INVALID_ATTRIBUTE_VALUE – set error returned if the input width and width stored in the catalog do not match.

Query Processing States

Valid in:

Parent topic: Attributes for *describe_column_set