Help Center/ GaussDB/ Developer Guide(Centralized_V2.0-2.x)/ SQL Reference/ Functions and Operators/ Prompt Message Function
Updated on 2025-08-19 GMT+08:00
View PDF

Prompt Message Function

  • report_application_error

    Description: This function can be used to throw errors during PL execution.

    Return type: void

    Table 1 report_application_error parameter description

    Parameter

    Type

    Description

    Required (Yes/No)

    log

    text

    Content of an error message.

    Yes

    code

    int4

    Error code corresponding to an error message. The value ranges from –20999 to –20000.

    No

    Example:

    openGauss=# CREATE OR REPLACE FUNCTION GET_RESULT_UNKNOWN(
openGauss(#     IN context_id int, /*context_id*/
openGauss(#     IN col_type text /*col_type*/
openGauss(# )RETURNS INTEGER
openGauss-# AS $$
openGauss$# BEGIN
openGauss$#     if col_type is NULL then
openGauss$#         PG_CATALOG.REPORT_APPLICATION_ERROR('invalid input for the third parameter col_type should not be null');
openGauss$#     end if;
openGauss$#     PG_CATALOG.REPORT_APPLICATION_ERROR('UnSupport data type for column_value(context: '||context_id||', '||PG_CATALOG.QUOTE_LITERAL(col_type)||')');
openGauss$#     return -1;
openGauss$# END;
openGauss$# $$ LANGUAGE plpgsql;
CREATE FUNCTION
openGauss=# CALL GET_RESULT_UNKNOWN(NULL, NULL);
ERROR:  invalid input for the third parameter col_type should not be null
CONTEXT:  SQL statement "CALL pg_catalog.report_application_error('invalid input for the third parameter col_type should not be null')"
PL/pgSQL function get_result_unknown(integer,text) line 4 at PERFORM
Parent topic: Functions and Operators