Updated on 2024-06-03 GMT+08:00

DBE_APPLICATION_INFO

Interface Description

Table 1 provides all interfaces supported by the DBE_APPLICATION_INFO package. DBE_APPLICATION_INFO applies to the current session.

Table 1 DBE_APPLICATION_INFO

Interface

Description

DBE_APPLICATION_INFO.SET_CLIENT_INFO

Writes client information.

DBE_APPLICATION_INFO.READ_CLIENT_INFO

Reads client information.

DBE_APPLICATION_INFO.SET_MODULE

Sets the name of the currently running module to the new module. You can set the module and action.

DBE_APPLICATION_INFO.READ_MODULE

Reads the values of the module and action columns of the current session.

DBE_APPLICATION_INFO.SET_ACTION

Sets the name of the current action in the current module.

  • DBE_APPLICATION_INFO.SET_CLIENT_INFO

    Writes client information. The prototype of the DBE_APPLICATION_INFO.SET_CLIENT_INFO function is as follows:

    1
    2
    3
    DBE_APPLICATION_INFO.SET_CLIENT_INFO(
        str text
    )returns void;
    
    Table 2 DBE_APPLICATION_INFO.SET_CLIENT_INFO interface parameters

    Parameter

    Description

    str

    Client information to be written. The maximum length is 64 bytes. If the length exceeds 64 bytes, it will be truncated.

  • DBE_APPLICATION_INFO.READ_CLIENT_INFO

    The prototype of the DBE_APPLICATION_INFO.READ_CLIENT_INFO function is as follows:

    1
    2
    DBE_APPLICATION_INFO.READ_CLIENT_INFO(
     OUT client_info text);
    
    Table 3 DBE_APPLICATION_INFO.READ_CLIENT_INFO interface parameters

    Parameter

    Description

    client_info

    Client information

  • DBE_APPLICATION_INFO.SET_MODULE

    Sets the name of the currently running module to the new module. The prototype of the DBE_APPLICATION_INFO.SET_MODULE function is as follows:

    1
    2
    3
    4
    DBE_APPLICATION_INFO.SET_MODULE(
        IN module_name text,
        IN action_name text
    );
    
    Table 4 DBE_APPLICATION_INFO.SET_MODULE parameters

    Parameter

    Description

    module_name

    Name of the running module. The maximum length is 64 bytes. If the length exceeds 64 bytes, it will be truncated.

    action_name

    Name of the current action in the current module. The maximum length is 64 bytes. If the length exceeds 64 bytes, it will be truncated.

    Example:

    CALL dbe_application_info.set_module('module_name','action_name');
     set_module 
    ------------
    
    (1 row)
  • DBE_APPLICATION_INFO.READ_MODULE

    Reads the values of the module and action columns of the current session. The prototype of the DBE_APPLICATION_INFO.READ_MODULE function is as follows:

    1
    2
    3
    4
    DBE_APPLICATION_INFO.READ_MODULE(
        OUT module_name text,
        OUT action_name text
    );
    
    Table 5 DBE_APPLICATION_INFO.READ_MODULE parameters

    Parameter

    Description

    module_name

    Name of the running module.

    action_name

    Name of the current action in the current module.

    Example:

    DECLARE
     module varchar2(64);
     action varchar2(64);
    BEGIN
     dbe_application_info.read_module(module,action);
     dbe_output.print_line(module);
     dbe_output.print_line(action);
    END;
    /
    module_name
    action_name
    ANONYMOUS BLOCK EXECUTE
  • DBE_APPLICATION_INFO.SET_ACTION

    Sets the name of the current action in the current module. The prototype of the DBE_APPLICATION_INFO.SET_ACTION function is as follows:

    1
    2
    3
    DBE_APPLICATION_INFO.SET_ACTION(
           IN action_name text
    );
    
    Table 6 DBE_APPLICATION_INFO.SET_ACTION parameters

    Parameter

    Description

    action_name

    Name of the current action in the current module. The maximum length is 64 bytes. If the length exceeds 64 bytes, it will be truncated.

    Examples

    CALL dbe_application_info.set_action('action_name');
     set_action 
    ------------
    
    (1 row)