MySQL  8.0.17
Source Code Documentation
PT_hint Class Reference

The class is a base class for representation of the different types of the hints. More...

#include <parse_tree_hints.h>

Inheritance diagram for PT_hint:
Parse_tree_node_tmpl< Context > PT_hint_max_execution_time PT_hint_qb_name PT_hint_resource_group PT_hint_sys_var PT_key_level_hint PT_qb_level_hint PT_table_level_hint

Public Member Functions

 PT_hint (opt_hints_enum hint_type_arg, bool switch_state_arg)
 
opt_hints_enum type () const
 
bool switch_on () const
 
virtual void print_warn (THD *thd, uint err_code, const LEX_CSTRING *qb_name_arg, LEX_CSTRING *table_name_arg, LEX_CSTRING *key_name_arg, PT_hint *hint) const
 Print warning issuing in processing of the hint. More...
 
virtual void append_args (const THD *thd, String *str) const
 Append additional hint arguments. More...
 
- Public Member Functions inherited from Parse_tree_node_tmpl< Context >
virtual ~Parse_tree_node_tmpl ()
 
bool is_contextualized () const
 
virtual bool contextualize (Context *pc)
 Do all context-sensitive things and mark the node as contextualized. More...
 
virtual bool contextualize_ (Context *)
 
Intermediate version of the contextualize() function More...
 
void error (Context *pc, const POS &pos) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 
void error (Context *pc, const POS &pos, const char *msg) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 
void errorf (Context *pc, const POS &pos, const char *format,...) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 

Private Attributes

opt_hints_enum hint_type
 
bool state
 

Additional Inherited Members

- Public Types inherited from Parse_tree_node_tmpl< Context >
typedef Context context_t
 
- Static Public Member Functions inherited from Parse_tree_node_tmpl< Context >
static void * operator new (size_t size, MEM_ROOT *mem_root, const std::nothrow_t &arg=std::nothrow) noexcept
 
static void operator delete (void *ptr, size_t size)
 
static void operator delete (void *, MEM_ROOT *, const std::nothrow_t &) noexcept
 
- Protected Member Functions inherited from Parse_tree_node_tmpl< Context >
 Parse_tree_node_tmpl ()
 

Detailed Description

The class is a base class for representation of the different types of the hints.

For the complex hints it is also used as a container for additional argumnets.

Constructor & Destructor Documentation

◆ PT_hint()

PT_hint::PT_hint ( opt_hints_enum  hint_type_arg,
bool  switch_state_arg 
)
inline

Member Function Documentation

◆ append_args()

virtual void PT_hint::append_args ( const THD thd,
String str 
) const
inlinevirtual

Append additional hint arguments.

Parameters
thdPointer to THD object
strPointer to String object

Reimplemented in PT_hint_resource_group, PT_hint_max_execution_time, PT_hint_qb_name, PT_key_level_hint, and PT_qb_level_hint.

◆ print_warn()

void PT_hint::print_warn ( THD thd,
uint  err_code,
const LEX_CSTRING qb_name_arg,
LEX_CSTRING table_name_arg,
LEX_CSTRING key_name_arg,
PT_hint hint 
) const
virtual

Print warning issuing in processing of the hint.

Parameters
thdPointer to THD object
err_codeError code
qb_name_argQB name
table_name_argtable name
key_name_argkey name
hintPointer to hint object

◆ switch_on()

bool PT_hint::switch_on ( ) const
inline

◆ type()

opt_hints_enum PT_hint::type ( ) const
inline

Member Data Documentation

◆ hint_type

opt_hints_enum PT_hint::hint_type
private

◆ state

bool PT_hint::state
private

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