MySQL  8.0.28
Source Code Documentation
Sql_cmd_get_diagnostics Class Reference

Sql_cmd_get_diagnostics represents a GET DIAGNOSTICS statement. More...

#include <sql_get_diagnostics.h>

Inheritance diagram for Sql_cmd_get_diagnostics:
Sql_cmd

Public Member Functions

 Sql_cmd_get_diagnostics (Diagnostics_information *info)
 Constructor, used to represent a GET DIAGNOSTICS statement. More...
 
enum_sql_command sql_command_code () const override
 Return the command code for this statement. More...
 
bool execute (THD *thd) override
 Execute this GET DIAGNOSTICS statement. More...
 
- Public Member Functions inherited from Sql_cmd
bool needs_explicit_preparation () const
 
bool is_regular () const
 
bool is_prepared () const
 
virtual bool prepare (THD *)
 Prepare 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 bool is_dml () const
 
virtual bool is_single_table_plan () const
 
virtual bool accept (THD *, Select_lex_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...
 
void set_optional_transform_prepared (bool value)
 
bool is_optional_transform_prepared ()
 

Private Attributes

Diagnostics_informationm_info
 The information to be obtained. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Sql_cmd
 Sql_cmd ()
 
virtual ~Sql_cmd ()
 
void set_prepared ()
 Set this statement as prepared. More...
 

Detailed Description

Sql_cmd_get_diagnostics represents a GET DIAGNOSTICS statement.

The GET DIAGNOSTICS statement retrieves exception or completion condition information from a Diagnostics Area, usually pertaining to the last non-diagnostic SQL statement that was executed.

Constructor & Destructor Documentation

◆ Sql_cmd_get_diagnostics()

Sql_cmd_get_diagnostics::Sql_cmd_get_diagnostics ( Diagnostics_information info)
inline

Constructor, used to represent a GET DIAGNOSTICS statement.

Parameters
infoDiagnostics information to be obtained.

Member Function Documentation

◆ execute()

bool Sql_cmd_get_diagnostics::execute ( THD thd)
overridevirtual

Execute this GET DIAGNOSTICS statement.

Parameters
thdThe current thread.
Remarks
Errors or warnings occurring during the execution of the GET DIAGNOSTICS statement should not affect the Diagnostics Area of a previous statement as the diagnostics information there would be wiped out. Thus, in order to preserve the contents of the Diagnostics Area from which information is being retrieved, the GET DIAGNOSTICS statement is executed under a separate Diagnostics Area. If any errors or warnings occur during the execution of the GET DIAGNOSTICS statement, these error or warnings (conditions) are appended to the list of the original Diagnostics Area. The only exception to this is fatal errors, which must always cause the statement to fail.
Return values
falseon success.
trueon error

Implements Sql_cmd.

◆ sql_command_code()

enum_sql_command Sql_cmd_get_diagnostics::sql_command_code ( ) const
inlineoverridevirtual

Return the command code for this statement.

Implements Sql_cmd.

Member Data Documentation

◆ m_info

Diagnostics_information* Sql_cmd_get_diagnostics::m_info
private

The information to be obtained.


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