EXTFNAPIV4_DESCRIBE_COL_SCALE (Get)

The EXTFNAPIV4_DESCRIBE_COL_SCALE attribute indicates the scale of the column. Used in a describe_column_get scenario.

Data Type

a_sql_uint32

Description

The scale of a column. For arithmetic data types, parameter scale is the number of digits to the right of the decimal point in a number. This property is valid only for table arguments.

Usage

If the UDF gets this property, returns the scale of the column as defined in the CREATE PROCEDURE statement. This property is valid only for arithmetic data types.

Returns

On success, returns the sizeof(a_sql_uint32) if the value was returned, or:

  • EXTFNAPIV4_DESCRIBE_NOT_AVAILABLE – get error returned if the scale is unavailable for the data type of the specified column.

On failure, returns one of the generic describe_column errors, or:
  • EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – get error returned if the describe buffer is not the size of a_sql_uint32.
  • EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the query processing state is not greater than Initial.

Query Processing States

Parent topic: Attributes for *describe_column_get