MySQL  8.0.19
Source Code Documentation
Explain_format_flags Class Reference

#include <opt_explain_format.h>

Public Member Functions

 Explain_format_flags ()
 
void set (Explain_sort_clause clause, Explain_sort_property property)
 Set property bit flag for the clause. More...
 
void set (Explain_format_flags &flags)
 
void reset (Explain_sort_clause clause, Explain_sort_property property)
 Clear property bit flag for the clause. More...
 
bool get (Explain_sort_clause clause, Explain_sort_property property) const
 Return true if property is set for the clause. More...
 
bool any (Explain_sort_property property, Explain_sort_clause clause=ESC_none) const
 Return true if any of clauses has this property set. More...
 

Private Attributes

uint8 sorts [ESC_MAX]
 Bitmasks of Explain_sort_property flags for Explain_sort_clause clauses. More...
 

Constructor & Destructor Documentation

◆ Explain_format_flags()

Explain_format_flags::Explain_format_flags ( )
inline

Member Function Documentation

◆ any()

bool Explain_format_flags::any ( Explain_sort_property  property,
Explain_sort_clause  clause = ESC_none 
) const
inline

Return true if any of clauses has this property set.

Parameters
propertyCheck if this property is present in any of the sorts except clause's sort if specified
clauseOptional. Do not check for the property for this clause. The default is to check all clauses.

◆ get()

bool Explain_format_flags::get ( Explain_sort_clause  clause,
Explain_sort_property  property 
) const
inline

Return true if property is set for the clause.

◆ reset()

void Explain_format_flags::reset ( Explain_sort_clause  clause,
Explain_sort_property  property 
)
inline

Clear property bit flag for the clause.

◆ set() [1/2]

void Explain_format_flags::set ( Explain_format_flags flags)
inline

◆ set() [2/2]

void Explain_format_flags::set ( Explain_sort_clause  clause,
Explain_sort_property  property 
)
inline

Set property bit flag for the clause.

Member Data Documentation

◆ sorts

uint8 Explain_format_flags::sorts[ESC_MAX]
private

Bitmasks of Explain_sort_property flags for Explain_sort_clause clauses.


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