MySQL 8.0.31
Source Code Documentation
Set_var_error_handler Class Reference

Implements the error handler for SET_VAR hint. More...

#include <error_handler.h>

Inheritance diagram for Set_var_error_handler:
[legend]

Public Member Functions

 Set_var_error_handler (bool ignore_warn_arg)
 
bool handle_condition (THD *, uint, const char *, Sql_condition::enum_severity_level *level, const char *) override
 Handle a sql condition. More...
 
void reset_state ()
 

Private Attributes

bool ignore_warn
 
bool ignore_subsequent_messages
 

Additional Inherited Members

- Protected Member Functions inherited from Internal_error_handler
 Internal_error_handler ()
 
Internal_error_handlerprev_internal_handler () const
 
virtual ~Internal_error_handler ()=default
 

Detailed Description

Implements the error handler for SET_VAR hint.

For Sys_var_hint::update_vars handler accepts first warning or error. Subsequent error are ignored to avoid message duplication. For Sys_var_hint::restore_vars all warnings and errors are ignored since valid value is restored.

Constructor & Destructor Documentation

◆ Set_var_error_handler()

Set_var_error_handler::Set_var_error_handler ( bool  ignore_warn_arg)
inline

Member Function Documentation

◆ handle_condition()

bool Set_var_error_handler::handle_condition ( THD thd,
uint  sql_errno,
const char *  sqlstate,
Sql_condition::enum_severity_level level,
const char *  msg 
)
inlineoverridevirtual

Handle a sql condition.

This method can be implemented by a subclass to achieve any of the following:

  • mask a warning/error internally, prevent exposing it to the user,
  • mask a warning/error and throw another one instead. When this method returns true, the sql condition is considered 'handled', and will not be propagated to upper layers. It is the responsibility of the code installing an internal handler to then check for trapped conditions, and implement logic to recover from the anticipated conditions trapped during runtime.

This mechanism is similar to C++ try/throw/catch:

  • 'try' correspond to THD::push_internal_handler(),
  • 'throw' correspond to my_error(), which invokes my_message_sql(),
  • 'catch' correspond to checking how/if an internal handler was invoked, before removing it from the exception stack with THD::pop_internal_handler().
Parameters
thdthe calling thread
sql_errnothe error number for the condition raised.
sqlstatethe SQLSTATE for the condition raised.
levelthe severity level for the condition raised.
msgthe error message for the condition raised.
Returns
true if the condition is handled

Implements Internal_error_handler.

◆ reset_state()

void Set_var_error_handler::reset_state ( )
inline

Member Data Documentation

◆ ignore_subsequent_messages

bool Set_var_error_handler::ignore_subsequent_messages
private

◆ ignore_warn

bool Set_var_error_handler::ignore_warn
private

The documentation for this class was generated from the following file: