MySQL 8.4.3
Source Code Documentation
Opt_hints_key Class Reference

Key level hints. More...

#include <opt_hints.h>

Inheritance diagram for Opt_hints_key:
[legend]

Public Member Functions

 Opt_hints_key (const LEX_CSTRING *key_name_arg, Opt_hints_table *table_hints_arg, MEM_ROOT *mem_root_arg)
 
void append_name (const THD *thd, String *str) override
 Append key name. More...
 
bool ignore_print (opt_hints_enum type_arg) const override
 Ignore printing of the object since parent complex hint has its own printing method. 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 ()=default
 
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
 
virtual const LEX_CSTRINGget_print_name ()
 
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...
 
void incr_resolved_children ()
 
Mem_root_array< Opt_hints * > * child_array_ptr ()
 
bool is_all_resolved () const
 
void register_child (Opt_hints *hint_arg)
 
virtual PT_hintget_complex_hints (opt_hints_enum type)
 Returns pointer to complex hint for a given type. More...
 
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...
 

Detailed Description

Key level hints.

Constructor & Destructor Documentation

◆ Opt_hints_key()

Opt_hints_key::Opt_hints_key ( const LEX_CSTRING key_name_arg,
Opt_hints_table table_hints_arg,
MEM_ROOT mem_root_arg 
)
inline

Member Function Documentation

◆ append_name()

void Opt_hints_key::append_name ( const THD thd,
String str 
)
inlineoverridevirtual

Append key name.

Parameters
thdpointer to THD object
strpointer to String object

Implements Opt_hints.

◆ ignore_print()

bool Opt_hints_key::ignore_print ( opt_hints_enum  type_arg) const
inlineoverridevirtual

Ignore printing of the object since parent complex hint has its own printing method.

Reimplemented from Opt_hints.


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