EXTFNAPIV4_DESCRIBE_COL_CAN_BE_NULL (Get)

The EXTFNAPIV4_DESCRIBE_COL_CAN_BE_NULL attribute indicates if the column can be NULL. Used in a describe_column_get scenario.

Data Type

a_sql_byte

Description

True, if the column can be NULL. This property is valid only for table arguments. This property is valid only for argument 0.

Usage

If a UDF gets this property, returns 1 if the column can be NULL, and returns 0 if otherwise.

Returns

On success, returns the sizeof(a_sql_byte) if the attribute is available, or:
  • EXTFNAPIV4_DESCRIBE_NOT_AVAILABLE – returned if the attribute was not available to get. This can happen if the column was not involved in the query.
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_byte.
  • EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the specified argument is an input table and the query processing state is not greater than Plan building state.

Query Processing States

Valid in:

Parent topic: Attributes for *describe_column_get