MySQL 8.3.0
Source Code Documentation
Sql_cmd_common_signal Class Reference

Sql_cmd_common_signal represents the common properties of the SIGNAL and RESIGNAL statements. More...

#include <sql_signal.h>

Inheritance diagram for Sql_cmd_common_signal:
[legend]

Protected Member Functions

 Sql_cmd_common_signal (const sp_condition_value *cond, Set_signal_information *set)
 Constructor. More...
 
 ~Sql_cmd_common_signal () override=default
 
void eval_defaults (THD *thd, Sql_condition *cond)
 Evaluate the condition items 'SQLSTATE', 'MYSQL_ERRNO', 'level' and 'MESSAGE_TEXT' default values for this statement. More...
 
int eval_signal_informations (THD *thd, Sql_condition *cond)
 Evaluate each signal condition items for this statement. More...
 
- Protected Member Functions inherited from Sql_cmd
 Sql_cmd ()
 
virtual ~Sql_cmd ()
 
void set_prepared ()
 Set this statement as prepared. More...
 

Static Protected Member Functions

static void assign_defaults (THD *thd, Sql_condition *cond, bool set_level_code, Sql_condition::enum_severity_level level, int sqlcode)
 Assign the condition items 'MYSQL_ERRNO', 'level' and 'MESSAGE_TEXT' default values of a condition. More...
 

Protected Attributes

const sp_condition_valuem_cond
 The condition to signal or resignal. More...
 
Set_signal_informationm_set_signal_information
 Collection of 'SET item = value' assignments in the SIGNAL/RESIGNAL statement. More...
 

Additional Inherited Members

- Public Member Functions inherited from Sql_cmd
virtual enum_sql_command sql_command_code () const =0
 Return the command code for this statement. More...
 
bool needs_explicit_preparation () const
 
bool is_regular () const
 
bool is_prepared () const
 
virtual bool prepare (THD *)
 Prepare this SQL statement. More...
 
virtual bool execute (THD *thd)=0
 Execute this SQL statement. More...
 
virtual void cleanup (THD *)
 Command-specific reinitialization before execution of prepared statement. More...
 
void set_owner (Prepared_statement *stmt)
 Set the owning prepared statement. More...
 
Prepared_statementowner () const
 Get the owning prepared statement. More...
 
void set_as_part_of_sp ()
 Mark statement as part of procedure. More...
 
bool is_part_of_sp () const
 
virtual enum enum_sql_cmd_type sql_cmd_type () const
 
virtual bool is_single_table_plan () const
 
virtual bool accept (THD *, Select_lex_visitor *)
 
virtual const MYSQL_LEX_CSTRINGeligible_secondary_storage_engine (THD *) const
 Is this statement of a type and on a form that makes it eligible for execution in a secondary storage engine? More...
 
virtual bool is_bulk_load () const
 
void disable_secondary_storage_engine ()
 Disable use of secondary storage engines in this statement. More...
 
void enable_secondary_storage_engine ()
 
bool secondary_storage_engine_disabled () const
 Has use of secondary storage engines been disabled for this statement? More...
 
void use_secondary_storage_engine (const handlerton *hton)
 Mark the current statement as using a secondary storage engine. More...
 
bool using_secondary_storage_engine () const
 Is this statement using a secondary storage engine? More...
 
const handlertonsecondary_engine () const
 Get the handlerton of the secondary engine that is used for executing this statement, or nullptr if a secondary engine is not used. More...
 
void set_optional_transform_prepared (bool value)
 
bool is_optional_transform_prepared ()
 

Detailed Description

Sql_cmd_common_signal represents the common properties of the SIGNAL and RESIGNAL statements.

Constructor & Destructor Documentation

◆ Sql_cmd_common_signal()

Sql_cmd_common_signal::Sql_cmd_common_signal ( const sp_condition_value cond,
Set_signal_information set 
)
inlineprotected

Constructor.

Parameters
condthe condition signaled if any, or NULL.
setcollection of signal condition item assignments.

◆ ~Sql_cmd_common_signal()

Sql_cmd_common_signal::~Sql_cmd_common_signal ( )
overrideprotecteddefault

Member Function Documentation

◆ assign_defaults()

void Sql_cmd_common_signal::assign_defaults ( THD thd,
Sql_condition cond,
bool  set_level_code,
Sql_condition::enum_severity_level  level,
int  sqlcode 
)
staticprotected

Assign the condition items 'MYSQL_ERRNO', 'level' and 'MESSAGE_TEXT' default values of a condition.

Parameters
thdthe current thread.
condthe condition to update.
set_level_codetrue if 'level' and 'MYSQL_ERRNO' needs to be overwritten
levelthe level to assign
sqlcodethe sql code to assign

◆ eval_defaults()

void Sql_cmd_common_signal::eval_defaults ( THD thd,
Sql_condition cond 
)
protected

Evaluate the condition items 'SQLSTATE', 'MYSQL_ERRNO', 'level' and 'MESSAGE_TEXT' default values for this statement.

Parameters
thdthe current thread.
condthe condition to update.

◆ eval_signal_informations()

int Sql_cmd_common_signal::eval_signal_informations ( THD thd,
Sql_condition cond 
)
protected

Evaluate each signal condition items for this statement.

Parameters
thdthe current thread.
condthe condition to update.
Returns
0 on success.

Member Data Documentation

◆ m_cond

const sp_condition_value* Sql_cmd_common_signal::m_cond
protected

The condition to signal or resignal.

This member is optional and can be NULL (RESIGNAL).

◆ m_set_signal_information

Set_signal_information* Sql_cmd_common_signal::m_set_signal_information
protected

Collection of 'SET item = value' assignments in the SIGNAL/RESIGNAL statement.


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