MySQL  8.0.17
Source Code Documentation
Sql_cmd_signal Class Reference

Sql_cmd_signal represents a SIGNAL statement. More...

#include <sql_signal.h>

Inheritance diagram for Sql_cmd_signal:
Sql_cmd_common_signal Sql_cmd

Public Member Functions

 Sql_cmd_signal (const sp_condition_value *cond, Set_signal_information *set)
 Constructor, used to represent a SIGNAL statement. More...
 
virtual ~Sql_cmd_signal ()
 
virtual enum_sql_command sql_command_code () const
 Return the command code for this statement. More...
 
virtual bool execute (THD *thd)
 Execute this SQL statement. More...
 
- Public Member Functions inherited from Sql_cmd
bool is_prepared () const
 
virtual bool prepare (THD *thd)
 Prepare this SQL statement. More...
 
virtual void cleanup (THD *thd)
 Command-specific reinitialization before execution of prepared statement. More...
 
void set_owner (Prepared_statement *stmt)
 Set the owning prepared statement. More...
 
Prepared_statementget_owner ()
 Get the owning prepared statement. More...
 
virtual bool is_dml () const
 
virtual bool is_single_table_plan () const
 
virtual void unprepare (THD *thd)
 Temporary function used to "unprepare" a prepared statement after preparation, so that a subsequent execute statement will reprepare it. More...
 
virtual bool accept (THD *thd, Select_lex_visitor *visitor)
 
virtual const MYSQL_LEX_CSTRINGeligible_secondary_storage_engine () const
 Is this statement of a type and on a form that makes it eligible for execution in a secondary storage engine? More...
 
void disable_secondary_storage_engine ()
 Disable use of secondary storage engines in this statement. More...
 
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...
 

Additional Inherited Members

- Protected Member Functions inherited from Sql_cmd_common_signal
 Sql_cmd_common_signal (const sp_condition_value *cond, Set_signal_information *set)
 Constructor. More...
 
virtual ~Sql_cmd_common_signal ()
 
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 ()
 
bool needs_explicit_preparation () const
 
void set_prepared ()
 Set this statement as prepared. More...
 
- Static Protected Member Functions inherited from Sql_cmd_common_signal
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 inherited from Sql_cmd_common_signal
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...
 
- Protected Attributes inherited from Sql_cmd
bool prepare_only
 

Detailed Description

Sql_cmd_signal represents a SIGNAL statement.

Constructor & Destructor Documentation

◆ Sql_cmd_signal()

Sql_cmd_signal::Sql_cmd_signal ( const sp_condition_value cond,
Set_signal_information set 
)
inline

Constructor, used to represent a SIGNAL statement.

Parameters
condthe SQL condition to signal (required).
setthe collection of signal informations to signal.

◆ ~Sql_cmd_signal()

virtual Sql_cmd_signal::~Sql_cmd_signal ( )
inlinevirtual

Member Function Documentation

◆ execute()

bool Sql_cmd_signal::execute ( THD thd)
virtual

Execute this SQL statement.

Parameters
thdthe current thread.
Returns
false if success, true if error

Implements Sql_cmd.

◆ sql_command_code()

virtual enum_sql_command Sql_cmd_signal::sql_command_code ( ) const
inlinevirtual

Return the command code for this statement.

Implements Sql_cmd.


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