RaiseException
Applicability
Product |
Supported |
|---|---|
√ |
|
√ |
|
x |
|
x |
|
x |
Function Description
A UDF proactively reports an exception, which can be captured by other UDFs in the same scope.
Prototype
1 | void RaiseException(int32_t expCode, uint64_t userContextId) |
Command-Line Options
Parameter |
Input/Output |
Description |
|---|---|---|
expCode |
Input |
User-defined error code. |
userContextId |
Input |
Context ID of a user-defined exception, which is used to identify the reported exception. This ensures that other UDFs can detect the data batch where the exception occurs based on the ID after capturing the exception. |
Returns
None
Troubleshooting
Print error logs.
Constraints
If exception reporting is not enabled for the current DataFlow graph through SetExceptionCatch, calling this API in the UDF will cause the process to report an error and exit.
In scenarios with streaming input (that is, the FlowFunc input is a queue), the UDF cannot proactively report exceptions.