1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
|
/* Copyright (c) 2015, 2025, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
/*
Parse tree node classes for optimizer hint syntax
*/
#ifndef OPT_HINTS_INCLUDED
#define OPT_HINTS_INCLUDED
#include <assert.h>
#include <stddef.h>
#include <sys/types.h>
#include "lex_string.h"
#include "m_ctype.h"
#include "m_string.h"
#include "my_compiler.h"
#include "my_inttypes.h"
#include "sql/enum_query_type.h"
#include "sql/mem_root_array.h" // Mem_root_array
#include "sql/sql_bitmap.h" // Bitmap
#include "sql/sql_show.h" // append_identifier
#include "sql_string.h" // String
enum class Subquery_strategy : int;
class Item;
class JOIN;
class Opt_hints_table;
class Sys_var_hint;
class THD;
class set_var;
class sys_var;
struct MEM_ROOT;
struct TABLE;
class Table_ref;
class PT_hint_list;
/**
Hint types, MAX_HINT_ENUM should be always last.
This enum should be synchronized with opt_hint_info
array(see opt_hints.cc).
*/
enum opt_hints_enum {
BKA_HINT_ENUM = 0,
BNL_HINT_ENUM,
ICP_HINT_ENUM,
MRR_HINT_ENUM,
NO_RANGE_HINT_ENUM,
MAX_EXEC_TIME_HINT_ENUM,
QB_NAME_HINT_ENUM,
SEMIJOIN_HINT_ENUM,
SUBQUERY_HINT_ENUM,
DERIVED_MERGE_HINT_ENUM,
JOIN_PREFIX_HINT_ENUM,
JOIN_SUFFIX_HINT_ENUM,
JOIN_ORDER_HINT_ENUM,
JOIN_FIXED_ORDER_HINT_ENUM,
INDEX_MERGE_HINT_ENUM,
RESOURCE_GROUP_HINT_ENUM,
SKIP_SCAN_HINT_ENUM,
HASH_JOIN_HINT_ENUM,
INDEX_HINT_ENUM,
JOIN_INDEX_HINT_ENUM,
GROUP_INDEX_HINT_ENUM,
ORDER_INDEX_HINT_ENUM,
DERIVED_CONDITION_PUSHDOWN_HINT_ENUM,
MAX_HINT_ENUM
};
struct st_opt_hint_info {
const char *hint_name; // Hint name.
bool check_upper_lvl; // true if upper level hint check is needed (for hints
// which can be specified on more than one level).
bool switch_hint; // true if hint is not complex.
bool irregular_hint; ///< true if hint requires some special handling.
///< Currently it's used only for join order hints
///< since they need special printing procedure.
};
/**
Opt_hints_map contains information
about hint state(specified or not, hint value).
*/
class Opt_hints_map {
Bitmap<64> hints; // hint state
Bitmap<64> hints_specified; // true if hint is specified
public:
/**
Check if hint is specified.
@param type_arg hint type
@return true if hint is specified
*/
bool is_specified(opt_hints_enum type_arg) const {
return hints_specified.is_set(type_arg);
}
/**
Set switch value and set hint into specified state.
@param type_arg hint type
@param switch_state_arg switch value
*/
void set_switch(opt_hints_enum type_arg, bool switch_state_arg) {
if (switch_state_arg)
hints.set_bit(type_arg);
else
hints.clear_bit(type_arg);
hints_specified.set_bit(type_arg);
}
/**
Get switch value.
@param type_arg hint type
@return switch value.
*/
bool switch_on(opt_hints_enum type_arg) const {
return hints.is_set(type_arg);
}
};
class Opt_hints_key;
class PT_hint;
class PT_hint_max_execution_time;
/**
Opt_hints class is used as ancestor for Opt_hints_global,
Opt_hints_qb, Opt_hints_table, Opt_hints_key classes.
Opt_hints_global class is hierarchical structure.
It contains information about global hints and also
contains array of QUERY BLOCK level objects (Opt_hints_qb class).
Each QUERY BLOCK level object contains array of TABLE level hints
(class Opt_hints_table). Each TABLE level hint contains array of
KEY lelev hints (Opt_hints_key class).
Hint information(specified, on|off state) is stored in hints_map object.
*/
class Opt_hints {
/*
Name of object referred by the hint.
This name is empty for global level,
query block name for query block level,
table name for table level and key name
for key level.
*/
const LEX_CSTRING *name;
/*
Parent object. There is no parent for global level,
for query block level parent is Opt_hints_global object,
for table level parent is Opt_hints_qb object,
for key level parent is Opt_hints_key object.
*/
Opt_hints *parent;
Opt_hints_map hints_map; // Hint map
/* Array of child objects. i.e. array of the lower level objects */
Mem_root_array<Opt_hints *> child_array;
/* true if hint is connected to the real object */
bool resolved;
/* Number of resolved children */
uint resolved_children;
public:
Opt_hints(const LEX_CSTRING *name_arg, Opt_hints *parent_arg,
MEM_ROOT *mem_root_arg)
: name(name_arg),
parent(parent_arg),
child_array(mem_root_arg),
resolved(false),
resolved_children(0) {}
virtual ~Opt_hints() = default;
bool is_specified(opt_hints_enum type_arg) const {
return hints_map.is_specified(type_arg);
}
/**
Function sets switch hint state.
@param switch_state_arg switch hint state
@param type_arg hint type
@param check_parent true if hint can be on parent level
@return true if hint is already specified,
false otherwise
*/
bool set_switch(bool switch_state_arg, opt_hints_enum type_arg,
bool check_parent) {
if (is_specified(type_arg) ||
(check_parent && parent->is_specified(type_arg)))
return true;
hints_map.set_switch(type_arg, switch_state_arg);
return false;
}
/**
Function returns switch hint state.
@param type_arg hint type
@return hint value if hint is specified,
false otherwise
*/
bool get_switch(opt_hints_enum type_arg) const;
virtual const LEX_CSTRING *get_name() const { return name; }
virtual const LEX_CSTRING *get_print_name() { return name; }
void set_name(const LEX_CSTRING *name_arg) { name = name_arg; }
Opt_hints *get_parent() const { return parent; }
virtual void set_resolved() { resolved = true; }
/**
Returns 'resolved' flag value for depending on hint type.
@param type_arg hint type
@return true if all hint objects are resolved, false otherwise.
*/
virtual bool is_resolved(opt_hints_enum type_arg [[maybe_unused]]) {
return resolved;
}
/**
Set hint to unresolved state.
@param type_arg hint type
*/
virtual void set_unresolved(opt_hints_enum type_arg [[maybe_unused]]) {}
/**
If ignore_print() returns true, hint is not printed
in Opt_hints::print() function. Atm used for
INDEX_MERGE, SKIP_SCAN, INDEX, JOIN_INDEX, GROUP_INDEX
ORDER_INDEX hints.
@param type_arg hint type
@return true if the hint should not be printed
in Opt_hints::print() function, false otherwise.
*/
virtual bool ignore_print(opt_hints_enum type_arg [[maybe_unused]]) const {
return false;
}
void incr_resolved_children() { resolved_children++; }
Mem_root_array<Opt_hints *> *child_array_ptr() { return &child_array; }
bool is_all_resolved() const {
return child_array.size() == resolved_children;
}
void register_child(Opt_hints *hint_arg) { child_array.push_back(hint_arg); }
/**
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.)
@param type hint type
@return pointer to complex hint for a given type.
*/
virtual PT_hint *get_complex_hints(opt_hints_enum type [[maybe_unused]]) {
assert(0);
return nullptr; /* error C4716: must return a value */
}
/**
Find hint among lower-level hint objects.
@param name_arg hint name
@param cs Pointer to character set
@return hint if found,
NULL otherwise
*/
Opt_hints *find_by_name(const LEX_CSTRING *name_arg,
const CHARSET_INFO *cs) const;
/**
Print all hints except of QB_NAME hint.
@param thd Pointer to THD object
@param str Pointer to String object
@param query_type If query type is QT_NORMALIZED_FORMAT,
un-resolved hints will also be printed
*/
void print(const THD *thd, String *str, enum_query_type query_type);
/**
Check if there are any unresolved hint objects and
print warnings for them.
@param thd Pointer to THD object
*/
void check_unresolved(THD *thd);
virtual void append_name(const THD *thd, String *str) = 0;
private:
/**
Append hint type.
@param str Pointer to String object
@param type Hint type
*/
void append_hint_type(String *str, opt_hints_enum type);
/**
Print warning for unresolved hint name.
@param thd Pointer to THD object
*/
void print_warn_unresolved(THD *thd);
/**
Function prints hints which are non-standard and don't
fit into existing hint infrastructure.
@param thd pointer to THD object
@param str pointer to String object
*/
virtual void print_irregular_hints(const THD *thd [[maybe_unused]],
String *str [[maybe_unused]]) {}
};
/**
Global level hints.
*/
class Opt_hints_global : public Opt_hints {
public:
PT_hint_max_execution_time *max_exec_time;
Sys_var_hint *sys_var_hint;
PT_hint_list *deferred_hints;
bool deferred_hints_flag;
Opt_hints_global(MEM_ROOT *mem_root_arg)
: Opt_hints(nullptr, nullptr, mem_root_arg) {
max_exec_time = nullptr;
sys_var_hint = nullptr;
deferred_hints = nullptr;
deferred_hints_flag = false;
}
void append_name(const THD *, String *) override {}
PT_hint *get_complex_hints(opt_hints_enum type) override;
void print_irregular_hints(const THD *thd, String *str) override;
};
class PT_qb_level_hint;
/**
Query block level hints.
*/
class Opt_hints_qb : public Opt_hints {
uint select_number; // Query_block number
LEX_CSTRING sys_name; // System QB name
char buff[32]; // Buffer to hold sys name
PT_qb_level_hint *subquery_hint, *semijoin_hint;
/// Array of join order hints
Mem_root_array<PT_qb_level_hint *> join_order_hints;
/// Bit map of which hints are ignored.
ulonglong join_order_hints_ignored;
/*
PT_qb_level_hint::contextualize sets subquery/semijoin_hint during parsing.
it also registers join order hints during parsing.
*/
friend class PT_qb_level_hint;
public:
Opt_hints_qb(Opt_hints *opt_hints_arg, MEM_ROOT *mem_root_arg,
uint select_number_arg);
const LEX_CSTRING *get_print_name() override {
const LEX_CSTRING *str = Opt_hints::get_name();
return str ? str : &sys_name;
}
/**
Append query block hint.
@param thd pointer to THD object
@param str pointer to String object
*/
void append_qb_hint(const THD *thd, String *str) {
if (get_name()) {
str->append(STRING_WITH_LEN("QB_NAME("));
append_identifier(thd, str, get_name()->str, get_name()->length);
str->append(STRING_WITH_LEN(") "));
}
}
/**
Append query block name.
@param thd pointer to THD object
@param str pointer to String object
*/
void append_name(const THD *thd, String *str) override {
str->append(STRING_WITH_LEN("@"));
append_identifier(thd, str, get_print_name()->str,
get_print_name()->length);
}
PT_hint *get_complex_hints(opt_hints_enum type) override;
/**
Function finds Opt_hints_table object corresponding to
table alias in the query block and attaches corresponding
key hint objects to appropriate KEY structures.
@param table Table reference
@return pointer Opt_hints_table object if this object is found,
NULL otherwise.
*/
Opt_hints_table *adjust_table_hints(Table_ref *table);
/**
Returns whether semi-join is enabled for this query block
A SEMIJOIN hint will force semi-join regardless of optimizer_switch
settings. A NO_SEMIJOIN hint will only turn off semi-join if the variant
with no strategies is used. A SUBQUERY hint will turn off semi-join. If
there is no SEMIJOIN/SUBQUERY hint, optimizer_switch setting determines
whether SEMIJOIN is used.
@param thd Pointer to THD object for session.
Used to access optimizer_switch
@return true if semijoin is enabled
*/
bool semijoin_enabled(const THD *thd) const;
/**
Returns bit mask of which semi-join strategies are enabled for this query
block.
@param opt_switches Bit map of strategies enabled by optimizer_switch
@return Bit mask of strategies that are enabled
*/
uint sj_enabled_strategies(uint opt_switches) const;
/**
Returns which subquery execution strategy has been specified by hints
for this query block.
@retval SUBQ_MATERIALIZATION Subquery Materialization should be used
@retval SUBQ_EXISTS In-to-exists execution should be used
@retval UNSPECIFIED No SUBQUERY hint for this query block
*/
Subquery_strategy subquery_strategy() const;
void print_irregular_hints(const THD *thd, String *str) override;
/**
Checks if join order hints are applicable and
applies table dependencies if possible.
@param join JOIN object
*/
void apply_join_order_hints(JOIN *join);
private:
void register_join_order_hint(PT_qb_level_hint *hint_arg) {
join_order_hints.push_back(hint_arg);
}
};
class PT_key_level_hint;
/**
Auxiliary class for compound key objects.
*/
class Compound_key_hint {
PT_key_level_hint *pt_hint; // Pointer to PT_key_level_hint object.
Key_map key_map; // Indexes, specified in the hint.
bool resolved; // true if hint does not have unresolved index.
public:
Compound_key_hint() {
key_map.init();
resolved = false;
pt_hint = nullptr;
}
virtual ~Compound_key_hint() = default;
void set_pt_hint(PT_key_level_hint *pt_hint_arg) { pt_hint = pt_hint_arg; }
PT_key_level_hint *get_pt_hint() { return pt_hint; }
void set_resolved(bool arg) { resolved = arg; }
bool is_resolved() { return resolved; }
void set_key_map(uint i) { key_map.set_bit(i); }
bool is_set_key_map(uint i) { return key_map.is_set(i); }
bool is_key_map_clear_all() { return key_map.is_clear_all(); }
Key_map *get_key_map() { return &key_map; }
virtual bool is_hint_conflicting(Opt_hints_table *table_hint [[maybe_unused]],
Opt_hints_key *key_hint [[maybe_unused]]) {
return false;
}
};
/**
Auxiliary class for JOIN_INDEX, GROUP_INDEX, ORDER_INDEX hints.
*/
class Index_key_hint : public Compound_key_hint {
public:
bool is_hint_conflicting(Opt_hints_table *table_hint,
Opt_hints_key *key_hint) override;
};
/**
Auxiliary class for INDEX hint.
*/
class Glob_index_key_hint : public Compound_key_hint {
public:
bool is_hint_conflicting(Opt_hints_table *table_hint,
Opt_hints_key *key_hint) override;
};
bool is_compound_hint(opt_hints_enum type_arg);
/**
Table level hints.
*/
class Opt_hints_table : public Opt_hints {
public:
Mem_root_array<Opt_hints_key *> keyinfo_array;
Compound_key_hint index_merge;
Compound_key_hint skip_scan;
Glob_index_key_hint index;
Index_key_hint join_index;
Index_key_hint group_index;
Index_key_hint order_index;
Opt_hints_table(const LEX_CSTRING *table_name_arg, Opt_hints_qb *qb_hints_arg,
MEM_ROOT *mem_root_arg)
: Opt_hints(table_name_arg, qb_hints_arg, mem_root_arg),
keyinfo_array(mem_root_arg) {}
/**
Append table name.
@param thd pointer to THD object
@param str pointer to String object
*/
void append_name(const THD *thd, String *str) override {
append_identifier(thd, str, get_name()->str, get_name()->length);
get_parent()->append_name(thd, str);
}
/**
Function sets correlation between key hint objects and
appropriate KEY structures.
@param table Pointer to Table_ref object
*/
void adjust_key_hints(Table_ref *table);
PT_hint *get_complex_hints(opt_hints_enum type) override;
void set_resolved() override {
Opt_hints::set_resolved();
if (is_specified(INDEX_MERGE_HINT_ENUM)) index_merge.set_resolved(true);
if (is_specified(SKIP_SCAN_HINT_ENUM)) skip_scan.set_resolved(true);
if (is_specified(INDEX_HINT_ENUM)) index.set_resolved(true);
if (is_specified(JOIN_INDEX_HINT_ENUM)) join_index.set_resolved(true);
if (is_specified(GROUP_INDEX_HINT_ENUM)) group_index.set_resolved(true);
if (is_specified(ORDER_INDEX_HINT_ENUM)) order_index.set_resolved(true);
}
void set_unresolved(opt_hints_enum type_arg) override {
if (is_specified(type_arg) && is_compound_hint(type_arg))
get_compound_key_hint(type_arg)->set_resolved(false);
}
bool is_resolved(opt_hints_enum type_arg) override {
if (is_compound_hint(type_arg))
return Opt_hints::is_resolved(type_arg) &&
get_compound_key_hint(type_arg)->is_resolved();
return Opt_hints::is_resolved(type_arg);
}
void set_compound_key_hint_map(Opt_hints *hint, uint arg) {
if (hint->is_specified(INDEX_MERGE_HINT_ENUM)) index_merge.set_key_map(arg);
if (hint->is_specified(SKIP_SCAN_HINT_ENUM)) skip_scan.set_key_map(arg);
if (hint->is_specified(INDEX_HINT_ENUM)) index.set_key_map(arg);
if (hint->is_specified(JOIN_INDEX_HINT_ENUM)) join_index.set_key_map(arg);
if (hint->is_specified(GROUP_INDEX_HINT_ENUM)) group_index.set_key_map(arg);
if (hint->is_specified(ORDER_INDEX_HINT_ENUM)) order_index.set_key_map(arg);
}
Compound_key_hint *get_compound_key_hint(opt_hints_enum type_arg) {
if (type_arg == INDEX_MERGE_HINT_ENUM) return &index_merge;
if (type_arg == SKIP_SCAN_HINT_ENUM) return &skip_scan;
if (type_arg == INDEX_HINT_ENUM) return &index;
if (type_arg == JOIN_INDEX_HINT_ENUM) return &join_index;
if (type_arg == GROUP_INDEX_HINT_ENUM) return &group_index;
if (type_arg == ORDER_INDEX_HINT_ENUM) return &order_index;
assert(0);
return nullptr;
}
bool is_force_index_hint(opt_hints_enum type_arg) {
return (get_compound_key_hint(type_arg)->is_resolved() &&
get_switch(type_arg));
}
bool is_hint_conflicting(Opt_hints_key *key_hint, opt_hints_enum type);
void update_index_hint_map(Key_map *keys_to_use,
Key_map *available_keys_to_use,
opt_hints_enum type_arg);
bool update_index_hint_maps(THD *thd, TABLE *tbl);
};
/**
Key level hints.
*/
class Opt_hints_key : public Opt_hints {
public:
Opt_hints_key(const LEX_CSTRING *key_name_arg,
Opt_hints_table *table_hints_arg, MEM_ROOT *mem_root_arg)
: Opt_hints(key_name_arg, table_hints_arg, mem_root_arg) {}
/**
Append key name.
@param thd pointer to THD object
@param str pointer to String object
*/
void append_name(const THD *thd, String *str) override {
get_parent()->append_name(thd, str);
str->append(' ');
append_identifier(thd, str, get_name()->str, get_name()->length);
}
/**
Ignore printing of the object since parent complex hint has
its own printing method.
*/
bool ignore_print(opt_hints_enum type_arg) const override {
return is_compound_hint(type_arg);
}
};
/**
Container for set_var object and original variable value.
*/
class Hint_set_var {
public:
Hint_set_var(set_var *var_arg) : var(var_arg), save_value(nullptr) {}
set_var *var; // Pointer to set_var object
Item *save_value; // Original variable value
};
/**
SET_VAR hints.
*/
class Sys_var_hint {
// List of str_var variables which need to be updated.
Mem_root_array<Hint_set_var *> var_list;
public:
Sys_var_hint(MEM_ROOT *mem_root_arg) : var_list(mem_root_arg) {}
/**
Add variable to hint list.
@param thd pointer to THD object
@param var_tracker pointer to System_variable_tracker object
@param sys_var_value variable value
@return true if variable is added,
false otherwise
*/
bool add_var(THD *thd, const System_variable_tracker &var_tracker,
Item *sys_var_value);
/**
Find variable in hint list.
@param thd Pointer to thread object
*/
void update_vars(THD *thd);
/**
Restore system variables with original values.
@param thd Pointer to thread object
*/
void restore_vars(THD *thd);
/**
Print applicable hints.
@param thd Thread handle
@param str Pointer to string object
*/
void print(const THD *thd, String *str);
};
/**
Returns key hint value if hint is specified, returns
optimizer switch value if hint is not specified.
@param thd Pointer to THD object
@param table Pointer to Table_ref object
@param keyno Key number
@param type_arg Hint type
@param optimizer_switch Optimizer switch flag
@return key hint value if hint is specified,
otherwise optimizer switch value.
*/
bool hint_key_state(const THD *thd, const Table_ref *table, uint keyno,
opt_hints_enum type_arg, uint optimizer_switch);
/**
Returns table hint value if hint is specified, returns
optimizer switch value if hint is not specified.
@param thd Pointer to THD object
@param table Pointer to Table_ref object
@param type_arg Hint type
@param optimizer_switch Optimizer switch flag
@return table hint value if hint is specified,
otherwise optimizer switch value.
*/
bool hint_table_state(const THD *thd, const Table_ref *table,
opt_hints_enum type_arg, uint optimizer_switch);
/**
Append table and query block name.
@param thd pointer to THD object
@param str pointer to String object
@param qb_name pointer to query block name, may be null
@param table_name pointer to table name
*/
void append_table_name(const THD *thd, String *str, const LEX_CSTRING *qb_name,
const LEX_CSTRING *table_name);
/**
Returns true if compound hint state is on with or without
specified keys, otherwise returns false.
If compound hint state is on and hint is specified without indexes,
function returns 'true' for any 'keyno' argument. If hint specified
with indexes, function returns true only for appropriate 'keyno' index.
@param table Pointer to TABLE object
@param keyno Key number
@param type_arg Hint type
@return true if compound hint state is on with or without
specified keys, otherwise returns false.
*/
bool compound_hint_key_enabled(const TABLE *table, uint keyno,
opt_hints_enum type_arg);
/**
Returns true if index merge hint state is on otherwise returns false.
@param thd Thread handler
@param table Pointer to TABLE object
@param use_cheapest_index_merge IN/OUT Returns true if INDEX_MERGE hint is
used without any specified key.
@return true if index merge hint state is on otherwise returns false.
*/
bool idx_merge_hint_state(THD *thd, const TABLE *table,
bool *use_cheapest_index_merge);
int cmp_lex_string(const LEX_CSTRING &s, const LEX_CSTRING &t,
const CHARSET_INFO *cs);
#endif /* OPT_HINTS_INCLUDED */
|