MySQL  8.0.21
Source Code Documentation
PT_qb_level_hint Class Reference

Parse tree hint object for query block level hints. More...

#include <parse_tree_hints.h>

Inheritance diagram for PT_qb_level_hint:
PT_hint Parse_tree_node_tmpl< Context >

Public Member Functions

 PT_qb_level_hint (const LEX_CSTRING qb_name_arg, bool switch_state_arg, enum opt_hints_enum hint_type_arg, uint arg)
 
 PT_qb_level_hint (const LEX_CSTRING qb_name_arg, bool switch_state_arg, enum opt_hints_enum hint_type_arg, const Hint_param_table_list &table_list_arg)
 
uint get_args () const
 
bool contextualize (Parse_context *pc) override
 Function handles query block level hint. More...
 
void append_args (const THD *thd, String *str) const override
 Append hint arguments to given string. More...
 
virtual Hint_param_table_listget_table_list ()
 
- Public Member Functions inherited from PT_hint
 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...
 
bool supports_view ()
 
- 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...
 
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 Types

typedef PT_hint super
 

Private Attributes

const LEX_CSTRING qb_name
 Name of query block. More...
 
uint args
 Bit mask of arguments to hint. More...
 
Hint_param_table_list table_list
 List of tables specified in join order hint. More...
 

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

Parse tree hint object for query block level hints.

Member Typedef Documentation

◆ super

Constructor & Destructor Documentation

◆ PT_qb_level_hint() [1/2]

PT_qb_level_hint::PT_qb_level_hint ( const LEX_CSTRING  qb_name_arg,
bool  switch_state_arg,
enum opt_hints_enum  hint_type_arg,
uint  arg 
)
inline

◆ PT_qb_level_hint() [2/2]

PT_qb_level_hint::PT_qb_level_hint ( const LEX_CSTRING  qb_name_arg,
bool  switch_state_arg,
enum opt_hints_enum  hint_type_arg,
const Hint_param_table_list table_list_arg 
)
inline

Member Function Documentation

◆ append_args()

void PT_qb_level_hint::append_args ( const THD thd,
String str 
) const
overridevirtual

Append hint arguments to given string.

Parameters
thdPointer to THD object
strPointer to String object

Reimplemented from PT_hint.

◆ contextualize()

bool PT_qb_level_hint::contextualize ( Parse_context pc)
override

Function handles query block level hint.

It also creates query block hint object (Opt_hints_qb) if it does not exist.

Parameters
pcPointer to Parse_context object
Returns
true in case of error, false otherwise

◆ get_args()

uint PT_qb_level_hint::get_args ( ) const
inline

◆ get_table_list()

virtual Hint_param_table_list* PT_qb_level_hint::get_table_list ( )
inlinevirtual

Member Data Documentation

◆ args

uint PT_qb_level_hint::args
private

Bit mask of arguments to hint.

◆ qb_name

const LEX_CSTRING PT_qb_level_hint::qb_name
private

Name of query block.

◆ table_list

Hint_param_table_list PT_qb_level_hint::table_list
private

List of tables specified in join order hint.


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