MySQL  8.0.18
Source Code Documentation
Rows_applier_psi_stage Class Reference

#include <log_event.h>

Public Member Functions

 Rows_applier_psi_stage ()
 
void set_progress (PSI_stage_progress *progress)
 
bool is_enabled ()
 
If instrumentation is enabled this member function SHALL return true. More...
 
void update_work_estimated_and_completed (const uchar *cursor, const uchar *begin, const uchar *end)
 
This member function shall update the progress and reestimate the remaining work needed. More...
 
void end_work ()
 
Resets this object. More...
 
void inc_n_rows_applied (ulonglong delta)
 
Updates the counter of processed rows. More...
 
ulonglong get_n_rows_applied ()
 
Gets the value of the counter of rows that have been processed. More...
 

Private Member Functions

 Rows_applier_psi_stage (const Rows_applier_psi_stage &rhs)
 
Rows_applier_psi_stageoperator= (const Rows_applier_psi_stage &rhs)
 

Private Attributes

PSI_stage_progressm_progress
 
A cached pointer to this stage PSI_stage_progress. More...
 
ulonglong m_n_rows_applied
 
Counter that is unconditionally incremented on each row that is processed. More...
 

Constructor & Destructor Documentation

◆ Rows_applier_psi_stage() [1/2]

Rows_applier_psi_stage::Rows_applier_psi_stage ( const Rows_applier_psi_stage rhs)
private

◆ Rows_applier_psi_stage() [2/2]

Rows_applier_psi_stage::Rows_applier_psi_stage ( )
inline

Member Function Documentation

◆ end_work()

void Rows_applier_psi_stage::end_work ( )
inline


Resets this object.

◆ get_n_rows_applied()

ulonglong Rows_applier_psi_stage::get_n_rows_applied ( )
inline


Gets the value of the counter of rows that have been processed.

Returns
the value of the counter of rows processed so far.

◆ inc_n_rows_applied()

void Rows_applier_psi_stage::inc_n_rows_applied ( ulonglong  delta)
inline


Updates the counter of processed rows.

Parameters
deltathe amount of increment to be done.

◆ is_enabled()

bool Rows_applier_psi_stage::is_enabled ( )
inline


If instrumentation is enabled this member function SHALL return true.

Returns
true if instrumentation is enabled for the given stage, false otherwise.

◆ operator=()

Rows_applier_psi_stage& Rows_applier_psi_stage::operator= ( const Rows_applier_psi_stage rhs)
private

◆ set_progress()

void Rows_applier_psi_stage::set_progress ( PSI_stage_progress progress)
inline

◆ update_work_estimated_and_completed()

void Rows_applier_psi_stage::update_work_estimated_and_completed ( const uchar cursor,
const uchar begin,
const uchar end 
)
inline


This member function shall update the progress and reestimate the remaining work needed.

This MUST be called after setting n_rows_applied correctly by calling inc_n_rows_applied beforehand.

Cursor, begin and end are used in case estimation is needed.

Parameters
cursorPointer to where we are in the buffer of rows to be processed.
beginPointer to the beginning of the rows buffer.
endPointer to the end of the rows buffer.

Member Data Documentation

◆ m_n_rows_applied

ulonglong Rows_applier_psi_stage::m_n_rows_applied
private


Counter that is unconditionally incremented on each row that is processed.

This is helpful in case estimation is needed after started processing a Rows_log_event.

◆ m_progress

PSI_stage_progress* Rows_applier_psi_stage::m_progress
private


A cached pointer to this stage PSI_stage_progress.


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