MySQL 8.3.0
Source Code Documentation
Diagnostics_information Class Referenceabstract

Represents the diagnostics information to be obtained. More...

#include <sql_get_diagnostics.h>

Inheritance diagram for Diagnostics_information:
[legend]

Public Types

enum  Which_area { CURRENT_AREA , STACKED_AREA }
 Which Diagnostics Area to access. More...
 

Public Member Functions

void set_which_da (Which_area area)
 Set which Diagnostics Area to access. More...
 
Which_area get_which_da (void) const
 Get which Diagnostics Area to access. More...
 
virtual bool aggregate (THD *thd, const Diagnostics_area *da)=0
 Aggregate diagnostics information. More...
 

Protected Member Functions

virtual ~Diagnostics_information ()
 Diagnostics_information objects are allocated in thd->mem_root. More...
 
template<typename Diag_item , typename Context >
bool evaluate (THD *thd, Diag_item *diag_item, Context ctx)
 Evaluate a diagnostics information item in a specific context. More...
 

Private Attributes

Which_area m_area
 Which Diagnostics Area to access. More...
 

Detailed Description

Represents the diagnostics information to be obtained.

Diagnostic information is made available through statement information and condition information items.

Member Enumeration Documentation

◆ Which_area

Which Diagnostics Area to access.

Enumerator
CURRENT_AREA 

Access the first Diagnostics Area.

STACKED_AREA 

Access the second Diagnostics Area.

Constructor & Destructor Documentation

◆ ~Diagnostics_information()

virtual Diagnostics_information::~Diagnostics_information ( )
inlineprotectedvirtual

Diagnostics_information objects are allocated in thd->mem_root.

Do not rely on the destructor for any cleanup.

Member Function Documentation

◆ aggregate()

virtual bool Diagnostics_information::aggregate ( THD thd,
const Diagnostics_area da 
)
pure virtual

Aggregate diagnostics information.

Parameters
thdThe current thread.
daThe Diagnostics Area.
Return values
falseon success.
trueon error

Implemented in Statement_information, and Condition_information.

◆ evaluate()

template<typename Diag_item , typename Context >
bool Diagnostics_information::evaluate ( THD thd,
Diag_item *  diag_item,
Context  ctx 
)
inlineprotected

Evaluate a diagnostics information item in a specific context.

Parameters
thdThe current thread.
diag_itemThe diagnostics information item.
ctxThe context to evaluate the item.
Return values
falseon success.
trueon error.

◆ get_which_da()

Which_area Diagnostics_information::get_which_da ( void  ) const
inline

Get which Diagnostics Area to access.

◆ set_which_da()

void Diagnostics_information::set_which_da ( Which_area  area)
inline

Set which Diagnostics Area to access.

Member Data Documentation

◆ m_area

Which_area Diagnostics_information::m_area
private

Which Diagnostics Area to access.


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