MySQL  8.0.17
Source Code Documentation
Opt_hints_global Class Reference

Global level hints. More...

#include <opt_hints.h>

Inheritance diagram for Opt_hints_global:
Opt_hints

Public Member Functions

 Opt_hints_global (MEM_ROOT *mem_root_arg)
 
void append_name (const THD *, String *) override
 
PT_hintget_complex_hints (opt_hints_enum type) override
 Returns pointer to complex hint for a given type. More...
 
void print_irregular_hints (const THD *thd, String *str) override
 Function prints hints which are non-standard and don't fit into existing hint infrastructure. More...
 
- Public Member Functions inherited from Opt_hints
 Opt_hints (const LEX_CSTRING *name_arg, Opt_hints *parent_arg, MEM_ROOT *mem_root_arg)
 
virtual ~Opt_hints ()
 
bool is_specified (opt_hints_enum type_arg) const
 
bool set_switch (bool switch_state_arg, opt_hints_enum type_arg, bool check_parent)
 Function sets switch hint state. More...
 
bool get_switch (opt_hints_enum type_arg) const
 Function returns switch hint state. More...
 
virtual const LEX_CSTRINGget_name () const
 
void set_name (const LEX_CSTRING *name_arg)
 
Opt_hintsget_parent () const
 
virtual void set_resolved ()
 
virtual bool is_resolved (opt_hints_enum type_arg)
 Returns 'resolved' flag value for depending on hint type. More...
 
virtual void set_unresolved (opt_hints_enum type_arg)
 Set hint to unresolved state. More...
 
virtual bool ignore_print (opt_hints_enum type_arg) const
 If ignore_print() returns true, hint is not printed in Opt_hints::print() function. More...
 
void incr_resolved_children ()
 
Mem_root_array< Opt_hints * > * child_array_ptr ()
 
bool is_all_resolved () const
 
void register_child (Opt_hints *hint_arg)
 
Opt_hintsfind_by_name (const LEX_CSTRING *name_arg, const CHARSET_INFO *cs) const
 Find hint among lower-level hint objects. More...
 
void print (const THD *thd, String *str, enum_query_type query_type)
 Print all hints except of QB_NAME hint. More...
 
void check_unresolved (THD *thd)
 Check if there are any unresolved hint objects and print warnings for them. More...
 

Public Attributes

PT_hint_max_execution_timemax_exec_time
 
Sys_var_hintsys_var_hint
 

Detailed Description

Global level hints.

Constructor & Destructor Documentation

◆ Opt_hints_global()

Opt_hints_global::Opt_hints_global ( MEM_ROOT mem_root_arg)
inline

Member Function Documentation

◆ append_name()

void Opt_hints_global::append_name ( const THD ,
String  
)
inlineoverridevirtual

Implements Opt_hints.

◆ get_complex_hints()

PT_hint * Opt_hints_global::get_complex_hints ( opt_hints_enum  type)
overridevirtual

Returns pointer to complex hint for a given type.

A complex hint is a hint that has arguments. (It is not just an on/off switch.)

Parameters
typehint type
Returns
pointer to complex hint for a given type.

Reimplemented from Opt_hints.

◆ print_irregular_hints()

void Opt_hints_global::print_irregular_hints ( const THD thd,
String str 
)
overridevirtual

Function prints hints which are non-standard and don't fit into existing hint infrastructure.

Parameters
thdpointer to THD object
strpointer to String object

Reimplemented from Opt_hints.

Member Data Documentation

◆ max_exec_time

PT_hint_max_execution_time* Opt_hints_global::max_exec_time

◆ sys_var_hint

Sys_var_hint* Opt_hints_global::sys_var_hint

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