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 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
|
/* Copyright (c) 2017, 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
*/
#include "sql/window.h"
#include <sys/types.h>
#include <algorithm>
#include <cstring>
#include <initializer_list>
#include <limits>
#include <unordered_set>
#include "field_types.h"
#include "m_ctype.h"
#include "my_alloc.h" // destroy
#include "my_dbug.h"
#include "my_inttypes.h"
#include "my_sys.h"
#include "my_table_map.h"
#include "my_time.h"
#include "mysql/udf_registration_types.h"
#include "mysqld_error.h"
#include "sql/derror.h" // ER_THD
#include "sql/enum_query_type.h"
#include "sql/handler.h"
#include "sql/item.h"
#include "sql/item_cmpfunc.h"
#include "sql/item_func.h"
#include "sql/item_sum.h" // Item_sum
#include "sql/item_timefunc.h" // Item_date_add_interval
#include "sql/join_optimizer/finalize_plan.h"
#include "sql/join_optimizer/join_optimizer.h"
#include "sql/join_optimizer/replace_item.h"
#include "sql/key_spec.h"
#include "sql/mem_root_array.h"
#include "sql/parse_tree_nodes.h" // PT_*
#include "sql/parse_tree_window.h" // PT_window
#include "sql/parser_yystype.h"
#include "sql/sql_array.h"
#include "sql/sql_class.h"
#include "sql/sql_const.h"
#include "sql/sql_error.h"
#include "sql/sql_exception_handler.h" // handle_std_exception
#include "sql/sql_lex.h" // Query_block
#include "sql/sql_list.h"
#include "sql/sql_optimizer.h" // JOIN
#include "sql/sql_resolver.h" // find_order_in_list
#include "sql/sql_show.h"
#include "sql/sql_tmp_table.h" // free_tmp_table
#include "sql/system_variables.h"
#include "sql/table.h"
#include "sql/temp_table_param.h" // Temp_table_param
#include "sql/thd_raii.h"
#include "sql/window_lex.h"
#include "sql_string.h"
#include "template_utils.h"
/**
Shallow clone the list of ORDER objects using mem_root and return
the cloned list.
*/
static ORDER *clone(THD *thd, ORDER *order) {
ORDER *clone = nullptr;
ORDER **prev_next = &clone;
for (; order != nullptr; order = order->next) {
ORDER *o = new (thd->mem_root) PT_order_expr(nullptr, ORDER_ASC);
std::memcpy(o, order, sizeof(*order));
*prev_next = o;
prev_next = &o->next;
}
*prev_next = nullptr; // final object should have a null next pointer
return clone;
}
/**
Append order expressions at the end of *first_next ordering list
representing the partitioning columns.
*/
static void append_to_back(ORDER **first_next, ORDER *column) {
ORDER **prev_next = first_next;
/*
find last next pointer in list and make that point to column
effectively appending it.
*/
for (; *prev_next != nullptr; prev_next = &(*prev_next)->next) {
}
*prev_next = column;
}
ORDER *Window::first_partition_by() const {
return m_partition_by != nullptr ? m_partition_by->value.first : nullptr;
}
ORDER *Window::first_order_by() const {
return m_order_by != nullptr ? m_order_by->value.first : nullptr;
}
bool Window::check_window_functions1(THD *thd, Query_block *select) {
m_static_aggregates =
(m_frame->m_from->m_border_type == WBT_UNBOUNDED_PRECEDING &&
m_frame->m_to->m_border_type == WBT_UNBOUNDED_FOLLOWING);
// If static aggregates, inversion isn't necessary
m_row_optimizable =
(m_frame->m_query_expression == WFU_ROWS) && !m_static_aggregates;
m_range_optimizable =
(m_frame->m_query_expression == WFU_RANGE) && !m_static_aggregates;
for (Item_sum &wf : m_functions) {
Window_evaluation_requirements reqs;
if (wf.check_wf_semantics1(thd, select, &reqs)) return true;
// [Not] buffering depends only on facts known at resolution time
m_needs_frame_buffering |= reqs.needs_buffer;
if (reqs.needs_peerset) {
/*
A framing function looks at the frame only (which may or not include
the peers, but it's irrelevant: what matters is the frame's set, not
the peer set in itself).
*/
assert(!wf.framing());
m_needs_peerset = true;
}
if (reqs.needs_last_peer_in_frame) {
assert(wf.framing());
m_needs_last_peer_in_frame = true;
}
if (wf.needs_partition_cardinality()) {
assert(!wf.framing());
m_needs_partition_cardinality = true;
}
m_opt_first_row |= reqs.opt_first_row;
m_opt_last_row |= reqs.opt_last_row;
m_row_optimizable &= reqs.row_optimizable;
m_range_optimizable &= reqs.range_optimizable;
if (thd->lex->is_explain() && !m_frame->m_originally_absent &&
!wf.framing()) {
/*
SQL2014 <window clause> SR6b: functions which do not respect frames
shouldn't have any frame specification in their window; we are more
relaxed, as some users may find it handy to have one single
window definition for framing and non-framing functions; but in case
it's a user's mistake, we send a Note in EXPLAIN.
*/
push_warning_printf(thd, Sql_condition::SL_NOTE,
ER_WINDOW_FUNCTION_IGNORES_FRAME,
ER_THD(thd, ER_WINDOW_FUNCTION_IGNORES_FRAME),
wf.func_name(), printable_name());
}
}
return false;
}
static Item_cache *make_result_item(Item *value) {
Item *order_expr = down_cast<Item_ref *>(value)->ref_item();
Item_cache *result = nullptr;
Item_result result_type = order_expr->result_type();
// In case of enum/set type, ordering is based on numeric
// comparison. So, we need to create items that will
// evaluate to integers.
if (order_expr->real_item()->type() == Item::FIELD_ITEM) {
Item_field *field = down_cast<Item_field *>(order_expr->real_item());
if (field->field->real_type() == MYSQL_TYPE_ENUM ||
field->field->real_type() == MYSQL_TYPE_SET) {
result_type = INT_RESULT;
}
}
switch (result_type) {
case INT_RESULT:
result = new Item_cache_int(value->data_type());
break;
case REAL_RESULT:
result = new Item_cache_real();
break;
case DECIMAL_RESULT:
result = new Item_cache_decimal();
break;
case STRING_RESULT:
if (value->is_temporal())
result = new Item_cache_datetime(value->data_type());
else if (value->data_type() == MYSQL_TYPE_JSON)
result = new Item_cache_json();
else
result = new Item_cache_str(value);
break;
default:
assert(false);
}
result->setup(value);
return result;
}
/**
Return element with index i from list
@param list List of ORDER elements
@param i zero-based index
@return element at index i, or nullptr if i out of range
*/
static ORDER *elt(const SQL_I_List<ORDER> &list, uint i) {
ORDER *o = list.first;
while (o != nullptr) {
if (i-- == 0) return o;
o = o->next;
}
assert(false);
return nullptr;
}
bool Window::setup_range_expressions(THD *thd) {
assert(m_frame->m_query_expression == WFU_RANGE);
const PT_order_list *o = effective_order_by();
if (o == nullptr) {
/*
Without ORDER BY, all rows are peers, so in a RANGE frame CURRENT ROW
extends to infinity, which we rewrite accordingly.
We do not touch other border types (e.g. N PRECEDING) as they must be
checked in more detail later.
*/
{
if (m_frame->m_from->m_border_type == WBT_CURRENT_ROW)
m_frame->m_from->m_border_type = WBT_UNBOUNDED_PRECEDING;
if (m_frame->m_to->m_border_type == WBT_CURRENT_ROW)
m_frame->m_to->m_border_type = WBT_UNBOUNDED_FOLLOWING;
}
}
for (PT_border *border : {m_frame->m_from, m_frame->m_to}) {
enum_window_border_type border_type = border->m_border_type;
switch (border_type) {
case WBT_UNBOUNDED_PRECEDING:
case WBT_UNBOUNDED_FOLLOWING:
/* no computation required */
break;
case WBT_VALUE_PRECEDING:
case WBT_VALUE_FOLLOWING: {
/*
Frame uses RANGE <value>, require ORDER BY with one column
cf. SQL 2014 7.15 <window clause>, SR 13.a.ii
*/
if (!o || o->value.size() != 1) {
my_error(ER_WINDOW_RANGE_FRAME_ORDER_TYPE, MYF(0), printable_name());
return true;
}
/* check the ORDER BY type */
Item *order_expr = *(o->value.first->item);
switch (order_expr->result_type()) {
case INT_RESULT:
case REAL_RESULT:
case DECIMAL_RESULT:
goto ok;
case STRING_RESULT:
if (order_expr->is_temporal()) goto ok;
default:;
}
my_error(ER_WINDOW_RANGE_FRAME_ORDER_TYPE, MYF(0), printable_name());
return true;
ok:;
}
[[fallthrough]];
case WBT_CURRENT_ROW: {
auto comparators = Bounds_checked_array<Arg_comparator>::Alloc(
thd->mem_root, o->value.size());
for (size_t i = 0; i < o->value.size(); ++i) {
bool asc = elt(o->value, i)->direction == ORDER_ASC;
Item *nr = m_order_by_items[i]->get_item();
/*
Below, "value" is the value of ORDER BY expr at current row for
which we must compute the window function.
"nr" is the value of the ORDER BY expr at another row in partition
which we want to determine whether resided in the specified RANGE.
We poke in the actual value of expr of the current row (cached) into
value in reset_order_by_peer_set().
*/
Item_cache *value = make_result_item(nr);
if (value == nullptr) return true;
/*
See comments on m_comparator.
WBT_CURRENT_ROW:
nr â‹› value (where â‹› is three-way comparison)
If we have multiple ORDER BY expressions, before_or_after_frame()
calls them in turn as needed, including special NULL handling.
WBT_VALUE_PRECEDING:
asc ? nr â‹› value - border->val_int() :
nr â‹› value + border->val_int())
For WBT_VALUE_FOLLOWING, - becomes + and vice versa.
*/
Item *cmp_arg;
if (border_type == WBT_VALUE_PRECEDING ||
border_type == WBT_VALUE_FOLLOWING) {
assert(i == 0); // only one expr allowed with WBT_VALUE_*
cmp_arg = border->build_addop(
value, border_type == WBT_VALUE_PRECEDING, asc, this);
if (cmp_arg == nullptr) return true;
} else {
cmp_arg = value;
}
Item **left_args = new (thd->mem_root) Item *(nr);
Item **right_args = new (thd->mem_root) Item *(cmp_arg);
if (!cmp_arg->fixed) {
if (cmp_arg->fix_fields(thd, right_args)) {
return true;
}
}
// Special case to handle "INTERVAL expr" border. It is special
// because we allow a general expression there, not just a
// literal. If expr is a constant subquery like (SELECT 1), it gets
// replaced during fix_fields above with an Item_int. If it is not
// constant, we will detect it later in check_constant_bound.
if (border_type == WBT_VALUE_PRECEDING ||
border_type == WBT_VALUE_FOLLOWING) {
Item *border_val = down_cast<Item_func *>(cmp_arg)->arguments()[1];
if (border_val != *border->border_ptr()) // replaced?
*border->border_ptr() = border_val;
}
comparators[i] = Arg_comparator(left_args, right_args);
bool compare_func_set = false;
// In case of enum/set type, as ordering is based on
// numeric comparison we need to setup comparison
// functions to do numeric comparison.
if (nr->real_item()->type() == Item::FIELD_ITEM) {
Item_field *field = down_cast<Item_field *>(nr->real_item());
if (field->field->real_type() == MYSQL_TYPE_ENUM ||
field->field->real_type() == MYSQL_TYPE_SET) {
if (comparators[i].set_cmp_func(/*owner_arg=*/nullptr, left_args,
right_args, /*set_null_arg=*/true,
INT_RESULT)) {
return true;
}
compare_func_set = true;
}
}
if (!compare_func_set) {
if (comparators[i].set_cmp_func(/*owner_arg=*/nullptr, left_args,
right_args,
/*set_null_arg=*/true)) {
return true;
}
}
}
m_comparators[border == m_frame->m_to] = comparators;
break;
}
}
}
return false;
}
ORDER *Window::sorting_order(THD *thd, bool implicitly_grouped) {
if (thd == nullptr) return m_sorting_order;
if (implicitly_grouped) {
m_sorting_order = nullptr;
return nullptr;
}
ORDER *part = effective_partition_by() ? effective_partition_by()->value.first
: nullptr;
ORDER *ord =
effective_order_by() ? effective_order_by()->value.first : nullptr;
/*
1. Copy both lists
2. Append the ORDER BY list to the partition list.
This ensures that all columns are present in the resulting sort ordering
and that all ORDER BY expressions are at the end.
The resulting sort can the be used to detect partition change and also
satisfy the window ordering.
*/
if (ord == nullptr)
m_sorting_order = part;
else if (part == nullptr)
m_sorting_order = ord;
else {
ORDER *sorting = clone(thd, part);
ORDER *ob = clone(thd, ord);
append_to_back(&sorting, ob);
m_sorting_order = sorting;
}
return m_sorting_order;
}
bool Window::resolve_reference(THD *thd, Item_sum *wf, PT_window **m_window) {
assert(thd->lex->current_query_block()->first_execution);
if (!(*m_window)->is_reference()) {
(*m_window)->m_functions.push_back(wf);
return false;
}
Query_block *curr = thd->lex->current_query_block();
for (Window &w : curr->m_windows) {
if (w.name() == nullptr) continue;
if (my_strcasecmp(system_charset_info, (*m_window)->printable_name(),
w.printable_name()) == 0) {
(*m_window)->~PT_window(); // destroy the reference, no further need
/* Replace with pointer to the definition */
(*m_window) = static_cast<PT_window *>(&w);
(*m_window)->m_functions.base_list::push_back(wf);
return false;
}
}
my_error(ER_WINDOW_NO_SUCH_WINDOW, MYF(0), (*m_window)->printable_name());
return true;
}
void Window::check_partition_boundary() {
DBUG_TRACE;
bool anything_changed = false;
if (m_part_row_number == 0) // first row in first partition
{
anything_changed = true;
}
/**
If we have partitioning and any one of the partitioning columns have
changed since last row, we have a new partition.
*/
for (Cached_item *item : m_partition_items) {
anything_changed |= item->cmp();
}
m_partition_border = anything_changed;
if (m_partition_border) {
m_part_row_number = 1;
m_first_rowno_in_range_frame = 1;
} else {
m_part_row_number++;
}
}
/*
For a comparator from m_comparators, locate the Item_cache to update
with a new reference value (see Window::m_comparators).
The comparator is one of
candidate {<, >} current row
candidate {<, >} current row {-,+} constant
The second form is used when the the RANGE frame boundary is
WBT_VALUE_PRECEDING/WBT_VALUE_FOLLOWING, "constant" above being the
value specified in the query, cf. the setup in
Window::setup_range_expressions.
*/
static Item_cache *FindCacheInComparator(const Arg_comparator &cmp) {
Item *to_update;
if (cmp.get_right()->type() == Item::CACHE_ITEM) {
to_update = cmp.get_right();
} else {
to_update = down_cast<Item_func *>(cmp.get_right())->get_arg(0);
}
return down_cast<Item_cache *>(to_update);
}
void Window::reset_order_by_peer_set() {
DBUG_TRACE;
for (Cached_item *item : m_order_by_items) {
/*
A side-effect of doing this comparison, is to update the cache, so that
when we compare the new value to itself later, it is in its peer set.
*/
(void)item->cmp();
}
// Update the reference value for ORDER BY elements as used by
// before_or_after_frame(). These are the actual items used in the three-way
// comparisons, whereas cached_item is used in in_new_order_by_peer_set().
for (int i = 0; i < 2; ++i) {
for (Arg_comparator &cmp : m_comparators[i]) {
FindCacheInComparator(cmp)->cache_value();
}
}
}
bool Window::in_new_order_by_peer_set(bool compare_all_order_by_items) {
DBUG_TRACE;
bool anything_changed = false;
for (Cached_item *item : m_order_by_items) {
anything_changed |= item->cmp();
if (!compare_all_order_by_items) break;
}
return anything_changed;
}
bool Window::before_or_after_frame(bool before) {
PT_border *border;
enum_window_border_type infinity; // the extreme bound of the border
if (before) {
border = frame()->m_from;
infinity = WBT_UNBOUNDED_PRECEDING;
} else {
border = frame()->m_to;
infinity = WBT_UNBOUNDED_FOLLOWING;
}
enum enum_window_border_type border_type = border->m_border_type;
if (border_type == infinity) return false; // all rows included
/*
If multiple ORDER BY expressions: only CURRENT ROW need be considered
since infinity handled above.
*/
assert(
border_type == WBT_CURRENT_ROW ||
(m_order_by_items.size() == 1 && (border_type == WBT_VALUE_PRECEDING ||
border_type == WBT_VALUE_FOLLOWING)));
uint i = 0;
Bounds_checked_array<Arg_comparator> comparators = m_comparators[!before];
ORDER *o_expr = effective_order_by()->value.first;
for (auto it = m_order_by_items.begin(); it != m_order_by_items.end();
++it, o_expr = o_expr->next, ++i) {
Cached_item *cur_row = *it;
/*
'cur_row' represents the value of the current row's windowing ORDER BY
expression, and 'candidate' represents the same expression in the
candidate row. Our caller is calculating the WF's value for 'cur_row';
to this aim, here we want to know if 'candidate' is part of the frame of
'cur_row'.
First, as the candidate row has just been copied back from the frame
buffer, we must update the item's null_value
*/
Item *candidate = cur_row->get_item();
if (candidate->update_null_value()) return true;
const bool asc = o_expr->direction == ORDER_ASC;
const bool nulls_at_infinity = // true if NULLs stick to 'infinity'
before ? asc : !asc;
if (cur_row->null_value) // Current row is NULL
{
/*
Per the standard, if current row is NULL,
<numeric value> PRECEDING/FOLLOWING is a bound which is positioned at
"the NULLs" (=peers). So is CURRENT ROW. So, for example, in NULLS
FIRST ordering, BETWEEN 2 FOLLOWING AND 3 FOLLOWING yields only the
NULLs, while BETWEEN 2 FOLLOWING AND UNBOUNDED FOLLOWING yields the
whole partition.
*/
if (candidate->null_value)
continue; // peer, so can't be before or after
else
return !nulls_at_infinity;
}
if (candidate->null_value) return nulls_at_infinity;
// Figure out if the candidate row is before/after the frame defined
// wrt. the current row for which the window function value needs to be
// calculated (see m_comparators for more details). If we are unequal,
// we can say for sure based on this element alone that we are before
// or after; if we are equal, we need to go on to the next element (if any).
//
// NOTE: The reference value has already been set in
// reset_order_by_peer_set().
int val = comparators[i].compare();
if (val != 0) {
if (!asc) val = -val;
return before ? (val < 0) : (val > 0);
}
// Compared equal, so move to the next in the lexicographic comparison
// (if any).
}
return false;
}
bool Window::check_unique_name(const List<Window> &windows) {
if (m_name == nullptr) return false;
for (const Window &w : windows) {
if (w.name() == nullptr) continue;
if (&w != this && m_name->eq(w.name(), false)) {
my_error(ER_WINDOW_DUPLICATE_NAME, MYF(0), printable_name());
return true;
}
}
return false;
}
bool Window::setup_ordering_cached_items(THD *thd, Query_block *select,
const PT_order_list *o,
bool partition_order) {
if (o == nullptr) return false;
for (ORDER *order = o->value.first; order; order = order->next) {
if (partition_order) {
Item_ref *ir =
new Item_ref(&select->context, order->item, "<window partition by>");
if (ir == nullptr) return true;
Cached_item *ci = new_Cached_item(thd, ir);
if (ci == nullptr) return true;
m_partition_items.push_back(ci);
} else {
Item_ref *ir =
new Item_ref(&select->context, order->item, "<window order by>");
if (ir == nullptr) return true;
Cached_item *ci = new_Cached_item(thd, ir);
if (ci == nullptr) return true;
m_order_by_items.push_back(ci);
}
}
return false;
}
bool Window::resolve_window_ordering(THD *thd, Ref_item_array ref_item_array,
Table_ref *tables,
mem_root_deque<Item *> *fields, ORDER *o,
bool partition_order) {
DBUG_TRACE;
assert(o);
const char *sav_where = thd->where;
thd->where = partition_order ? "window partition by" : "window order by";
for (ORDER *order = o; order; order = order->next) {
Item *oi = *order->item;
/* Order by position is not allowed for windows: legacy SQL 1992 only */
if (oi->type() == Item::INT_ITEM && oi->basic_const_item()) {
my_error(ER_WINDOW_ILLEGAL_ORDER_BY, MYF(0), printable_name());
return true;
}
if (find_order_in_list(thd, ref_item_array, tables, order, fields, false,
true))
return true;
oi = *order->item;
if (order->used_alias) {
/*
Order by using alias is not allowed for windows, cf. SQL 2011, section
7.11 <window clause>, SR 4. Throw the same error code as when alias is
argument of a window function, or any function.
*/
my_error(ER_BAD_FIELD_ERROR, MYF(0), oi->item_name.ptr(), thd->where);
return true;
}
if (!oi->fixed && oi->fix_fields(thd, order->item)) return true;
oi = *order->item; // fix_fields() may have changed *order->item
/*
Check SQL 2014 section 7.15 <window clause> SR 7 : A window cannot
contain a windowing function without an intervening query expression.
*/
if (oi->has_wf()) {
my_error(ER_WINDOW_NESTED_WINDOW_FUNC_USE_IN_WINDOW_SPEC, MYF(0),
printable_name());
return true;
}
if (oi->propagate_type(thd, MYSQL_TYPE_VARCHAR)) return true;
/*
Call split_sum_func if an aggregate function is part of order by
expression.
*/
if (oi->has_aggregation() && oi->type() != Item::SUM_FUNC_ITEM) {
oi->split_sum_func(thd, ref_item_array, fields);
if (thd->is_error()) return true;
}
}
thd->where = sav_where;
return false;
}
bool Window::equal_sort(Window *w1, Window *w2) {
ORDER *o1 = w1->sorting_order();
ORDER *o2 = w2->sorting_order();
if (o1 == nullptr || o2 == nullptr) return false;
while (o1 != nullptr && o2 != nullptr) {
if (o1->direction != o2->direction || !(*o1->item)->eq(*o2->item, false))
return false;
o1 = o1->next;
o2 = o2->next;
}
return o1 == nullptr && o2 == nullptr; // equal so far, now also same length
}
void Window::reorder_and_eliminate_sorts(List<Window> *windows) {
const size_t n = windows->size();
std::vector<bool> redundant(n, false);
for (uint i = 0; i < n - 1; i++) {
for (uint j = i + 1; j < n; j++) {
if (equal_sort((*windows)[i], (*windows)[j])) {
if (j > i + 1) {
// move up to right after window[i], so we can share sort
windows->swap_elts(i + 1, j);
} // else already in right place
redundant[i + 1] = true;
break;
}
}
}
for (uint i = 0; i < n; i++)
if (redundant[i]) (*windows)[i]->m_sorting_order = nullptr;
}
bool Window::check_constant_bound(THD *thd, PT_border *border) {
const enum_window_border_type b_t = border->m_border_type;
if (b_t == WBT_VALUE_PRECEDING || b_t == WBT_VALUE_FOLLOWING) {
char const *save_where = thd->where;
thd->where = "window frame bound";
Item **border_ptr = border->border_ptr();
/*
For RANGE frames, resolving is already done in setup_range_expressions,
so we need a test
*/
assert(((*border_ptr)->fixed && m_frame->m_query_expression == WFU_RANGE) ||
((!(*border_ptr)->fixed || (*border_ptr)->basic_const_item()) &&
m_frame->m_query_expression == WFU_ROWS));
if (!(*border_ptr)->fixed && (*border_ptr)->fix_fields(thd, border_ptr))
return true;
if (!(*border_ptr)->const_for_execution() || // allow dyn. arg
(*border_ptr)->has_subquery()) {
my_error(ER_WINDOW_RANGE_BOUND_NOT_CONSTANT, MYF(0), printable_name());
return true;
}
thd->where = save_where;
}
return false;
}
bool Window::check_border_sanity1(THD *thd) {
const PT_frame &fr = *m_frame;
for (PT_border *border : {fr.m_from, fr.m_to}) {
enum_window_border_type border_t = border->m_border_type;
switch (fr.m_query_expression) {
case WFU_ROWS:
case WFU_RANGE:
// A check specific of the frame's start
if (border == fr.m_from) {
if (border_t == WBT_UNBOUNDED_FOLLOWING) {
/*
SQL 2014 section 7.15 <window clause>, SR 8.a
*/
my_error(ER_WINDOW_FRAME_START_ILLEGAL, MYF(0), printable_name());
return true;
}
}
// A check specific of the frame's end
else {
if (border_t == WBT_UNBOUNDED_PRECEDING) {
/*
SQL 2014 section 7.15 <window clause>, SR 8.b
*/
my_error(ER_WINDOW_FRAME_END_ILLEGAL, MYF(0), printable_name());
return true;
}
enum_window_border_type from_t = fr.m_from->m_border_type;
if ((from_t == WBT_CURRENT_ROW && border_t == WBT_VALUE_PRECEDING) ||
(border_t == WBT_CURRENT_ROW &&
(from_t == WBT_VALUE_FOLLOWING)) ||
(from_t == WBT_VALUE_FOLLOWING &&
border_t == WBT_VALUE_PRECEDING)) {
/*
SQL 2014 section 7.15 <window clause>, SR 8.c and 8.d
*/
my_error(ER_WINDOW_FRAME_ILLEGAL, MYF(0), printable_name());
return true;
}
}
// Common code for start and end
if (border_t == WBT_VALUE_PRECEDING ||
border_t == WBT_VALUE_FOLLOWING) {
// INTERVAL only allowed with RANGE
if (fr.m_query_expression == WFU_ROWS && border->m_date_time) {
my_error(ER_WINDOW_ROWS_INTERVAL_USE, MYF(0), printable_name());
return true;
}
if (check_constant_bound(thd, border)) return true;
/*
ROWS ? PRECEDING/FOLLOWING: impose an integer type to '?'.
For RANGE ? PRECEDING/FOLLOWING: type of '?' may be any
numeric (int, decimal, int in the definition an interval): we
try integer, if wrong we will reprepare.
*/
if (border->m_value->propagate_type(
thd, MYSQL_TYPE_LONGLONG, fr.m_query_expression == WFU_ROWS))
return true;
}
break;
case WFU_GROUPS:
assert(false); // not yet implemented
break;
}
}
return false;
}
bool Window::check_border_sanity2(THD *thd) {
const PT_frame &fr = *m_frame;
PT_border *ba[] = {fr.m_from, fr.m_to};
constexpr size_t siz = sizeof(ba) / sizeof(PT_border *);
for (PT_border *border : Bounds_checked_array<PT_border *>(ba, siz)) {
enum_window_border_type border_t = border->m_border_type;
switch (fr.m_query_expression) {
case WFU_ROWS:
case WFU_RANGE:
// Common code for start and end
if (border_t == WBT_VALUE_PRECEDING ||
border_t == WBT_VALUE_FOLLOWING) {
if (!border->m_value->const_for_execution()) goto err;
Item *o_item = nullptr;
/*
Only integer values can be specified as args for ROW frames.
Note that due to type pinning, if the argument is a PS param its
supplied value is silently cast to an integer before coming here.
That explains why we accept 3.14 in '?', but not as a literal.
*/
if (fr.m_query_expression == WFU_ROWS &&
border->m_value->result_type() != INT_RESULT)
goto err;
else if (fr.m_query_expression == WFU_RANGE &&
(o_item = m_order_by_items[0]->get_item())->result_type() ==
STRING_RESULT &&
o_item->is_temporal()) {
/*
SQL 2014 section 7.15 <window clause>, GR 5.b.i.1.B.I.1: if value
is NULL or negative, we should give an error.
*/
Interval interval;
char buffer[STRING_BUFFER_USUAL_SIZE];
String value(buffer, sizeof(buffer), thd->collation());
get_interval_value(border->m_value, border->m_int_type, &value,
&interval);
if (border->m_value->null_value || interval.neg) goto err;
} else if (border->m_value->val_real() < 0.0 ||
border->m_value->null_value) {
// numeric type (integer, floating-point...) must not be negative
goto err; // GR 5.b.i.1.B.I.1
}
}
break;
case WFU_GROUPS:
assert(false); // not yet implemented
break;
}
}
return false;
err:
my_error(ER_WINDOW_FRAME_ILLEGAL, MYF(0), printable_name());
return true;
}
/**
Simplified adjacency list: a window can maximum reference (depends on)
one other window due to syntax restrictions. If there is no dependency,
m_list[wno] == UNUSED. If w1 depends on w2, m_list[w1] == w2.
*/
class AdjacencyList {
public:
static constexpr uint UNUSED = std::numeric_limits<uint>::max();
uint *const m_list;
const uint m_size;
AdjacencyList(uint elements) : m_list(new uint[elements]), m_size(elements) {
for (auto &i : Bounds_checked_array<uint>(m_list, elements)) {
i = UNUSED;
}
}
~AdjacencyList() { delete[] m_list; }
/**
Add a dependency.
@param wno the window that references another in its definition
@param depends_on the window referenced
*/
void add(uint wno, uint depends_on) {
assert(wno <= m_size && depends_on <= m_size);
assert(m_list[wno] == UNUSED);
m_list[wno] = depends_on;
}
/**
If the window depends on another window, return 1, else 0.
@param wno the window
@returns the out degree
*/
uint out_degree(uint wno) {
assert(wno <= m_size);
return m_list[wno] == UNUSED ? 0 : 1;
}
/**
Return the number of windows that depend on this one.
@param wno the window
@returns the in degree
*/
uint in_degree(uint wno) {
assert(wno <= m_size);
uint degree = 0; // a priori
for (uint i : Bounds_checked_array<uint>(m_list, m_size)) {
degree += i == wno ? 1 : 0;
}
return degree;
}
/**
Return true of there is a circularity in the graph
*/
bool check_circularity() {
if (m_size == 1)
return m_list[0] != UNUSED; // could have been resolved to itself
/*
After a node has been added to 'completed', if we meet it again we don't
need to explore the nodes it depends on.
*/
std::unordered_set<uint> completed;
for (uint i = 0; i < m_size; i++) {
// Look for loop in the chain which starts at node #i
if (completed.count(i) != 0) continue; // Chain already checked.
// Nodes visited in this chain:
std::unordered_set<uint> visited;
visited.insert(i);
completed.insert(i);
for (uint dep = m_list[i]; dep != UNUSED; dep = m_list[dep]) {
assert(dep <= m_size);
if (visited.count(dep) != 0) return true; // found circularity
visited.insert(dep);
completed.insert(dep);
}
}
return false;
}
};
void Window::eliminate_unused_objects(List<Window> *windows) {
/*
Go through the list. Check if a window is used by any function. If not,
check if any other window (used by window functions) is actually inheriting
from this window. If not, remove this window definition.
*/
List_iterator<Window> wi1(*windows);
for (Window *w1 = wi1++; w1 != nullptr; w1 = wi1++) {
if (w1->m_functions.is_empty()) {
/*
No window functions use this window, so check if other used window
definitions inherit from this window.
*/
bool window_used = false;
for (const Window &w2 : *windows) {
if (!w2.m_functions.is_empty()) {
/*
Go through the ancestor list and see if the current window
definition is used by this window.
*/
for (const Window *w_a = w2.m_ancestor; w_a != nullptr;
w_a = w_a->m_ancestor) {
// Can't inherit from unnamed window:
assert(w_a->m_name != nullptr);
if (my_strcasecmp(system_charset_info, w1->printable_name(),
w_a->printable_name()) == 0) {
window_used = true;
break;
}
}
}
if (window_used) break;
// We check if partition by or order by of this window has subqueries.
// If so, we cannot remove this window. Removing subqueries would need
// removal of their entries in ref_item_array (added when setting up
// order by/partition by fields in find_order_in_list).
for (PT_order_list *it : {w1->m_partition_by, w1->m_order_by}) {
if (it != nullptr) {
for (ORDER *o = it->value.first; o != nullptr; o = o->next) {
if ((*o->item)->has_subquery()) {
window_used = true;
break;
}
}
}
if (window_used) break;
}
}
if (!window_used) {
w1->cleanup();
w1->destroy();
wi1.remove();
}
}
}
// Eliminate redundant ordering after unused window definitions are removed.
// Otherwise we risk removing order for a window based on ordering of an
// unused window.
if (!windows->is_empty()) {
reorder_and_eliminate_sorts(windows);
/* Do this last, after any re-ordering */
(*windows)[windows->size() - 1]->m_last = true;
}
}
bool Window::setup_windows1(THD *thd, Query_block *select,
Ref_item_array ref_item_array, Table_ref *tables,
mem_root_deque<Item *> *fields,
List<Window> *windows) {
// Only possible at resolution time.
assert(thd->lex->current_query_block()->first_execution);
if (windows->elements > kMaxWindows) {
my_error(ER_TOO_MANY_WINDOWS, MYF(0), windows->elements, kMaxWindows);
return true;
}
/*
We can encounter aggregate functions in the ORDER BY and PARTITION clauses
of window function, so make sure we allow it:
*/
nesting_map save_allow_sum_func = thd->lex->allow_sum_func;
thd->lex->allow_sum_func |= (nesting_map)1 << select->nest_level;
for (Window &w : *windows) {
w.m_query_block = select;
if (w.m_partition_by != nullptr &&
w.resolve_window_ordering(thd, ref_item_array, tables, fields,
w.m_partition_by->value.first, true))
return true;
if (w.m_order_by != nullptr &&
w.resolve_window_ordering(thd, ref_item_array, tables, fields,
w.m_order_by->value.first, false))
return true;
}
thd->lex->allow_sum_func = save_allow_sum_func;
/* Our adjacency list uses std::unordered_set which may throw, so "try" */
try {
/*
If window N depends on (references) window M for its definition,
we add the relation n->m to the adjacency list, cf.
w1->set_ancestor(w2) vs. adj.add(i, j) below.
*/
AdjacencyList adj(windows->size());
/* Resolve inter-window references */
{
uint i = 0;
for (auto wi1 = windows->begin(); wi1 != windows->end(); ++wi1, ++i) {
Window *w1 = &*wi1;
if (w1->m_inherit_from != nullptr) {
bool resolved = false;
uint j = 0;
for (auto wi2 = windows->begin(); wi2 != windows->end(); ++wi2, ++j) {
Window *w2 = &*wi2;
if (w2->m_name == nullptr) continue;
String str;
if (my_strcasecmp(system_charset_info,
w1->m_inherit_from->val_str(&str)->ptr(),
w2->printable_name()) == 0) {
w1->set_ancestor(w2);
resolved = true;
adj.add(i, j);
break;
}
}
if (!resolved) {
String str;
my_error(ER_WINDOW_NO_SUCH_WINDOW, MYF(0),
w1->m_inherit_from->val_str(&str)->ptr());
return true;
}
}
}
}
if (adj.check_circularity()) {
my_error(ER_WINDOW_CIRCULARITY_IN_WINDOW_GRAPH, MYF(0));
return true;
}
/* We now know all references are resolved and they form a DAG */
for (uint i = 0; i < windows->size(); i++) {
if (adj.out_degree(i) != 0) {
/* Only the root can specify partition. SR 10.c) */
const Window *const non_root = (*windows)[i];
if (non_root->m_partition_by != nullptr) {
my_error(ER_WINDOW_NO_CHILD_PARTITIONING, MYF(0));
return true;
}
}
if (adj.in_degree(i) == 0) {
/* All windows that nobody depend on (leaves in DAG tree). */
const Window *const leaf = (*windows)[i];
const Window *seen_orderer = nullptr;
/* SR 10.d) No redefines of ORDER BY along inheritance path */
for (const Window *w3 = leaf; w3 != nullptr; w3 = w3->m_ancestor) {
if (w3->m_order_by != nullptr) {
if (seen_orderer != nullptr) {
my_error(ER_WINDOW_NO_REDEFINE_ORDER_BY, MYF(0),
seen_orderer->printable_name(), w3->printable_name());
return true;
} else {
seen_orderer = w3;
}
}
}
} else {
/*
This window has at least one dependent SQL 2014 section
7.15 <window clause> SR 10.e
*/
const Window *const ancestor = (*windows)[i];
if (!ancestor->m_frame->m_originally_absent) {
my_error(ER_WINDOW_NO_INHERIT_FRAME, MYF(0),
ancestor->printable_name());
return true;
}
}
}
} catch (...) {
/* purecov: begin inspected */
handle_std_exception("setup_windows1");
return true;
/* purecov: end */
}
for (Window &w : *windows) {
const PT_frame *f = w.frame();
const PT_order_list *o = w.effective_order_by();
if (w.m_order_by == nullptr && o != nullptr &&
w.m_frame->m_originally_absent) {
/*
Since we had an empty frame specification, but inherit an ORDER BY (we
cannot inherit a frame specification), we need to adjust the a priori
border type now that we know what we inherit (not known before binding
above).
*/
assert(w.m_frame->m_query_expression == WFU_RANGE);
w.m_frame->m_to->m_border_type = WBT_CURRENT_ROW;
}
if (w.check_unique_name(*windows)) return true;
if (w.setup_ordering_cached_items(thd, select, o, false)) return true;
if (w.setup_ordering_cached_items(thd, select, w.effective_partition_by(),
true))
return true;
if (w.check_window_functions1(thd, select)) return true;
/*
initialize the physical sorting order by merging the partition clause
and the ordering clause of the window specification.
*/
(void)w.sorting_order(thd, select->is_implicitly_grouped());
/* For now, we do not support EXCLUDE */
if (f->m_exclusion != nullptr) {
my_error(ER_NOT_SUPPORTED_YET, MYF(0), "EXCLUDE");
return true;
}
/* For now, we do not support GROUPS */
if (f->m_query_expression == WFU_GROUPS) {
my_error(ER_NOT_SUPPORTED_YET, MYF(0), "GROUPS");
return true;
}
/*
So we can determine if a row's value falls within range of current row
*/
if (f->m_query_expression == WFU_RANGE && w.setup_range_expressions(thd))
return true;
if (w.check_border_sanity1(thd)) return true;
}
return false;
}
bool Window::check_window_functions2(THD *thd) {
m_opt_nth_row.m_offsets.clear();
m_opt_lead_lag.m_offsets.clear();
m_opt_nth_row.m_offsets.init(thd->mem_root);
m_opt_lead_lag.m_offsets.init(thd->mem_root);
for (Item_sum &wf : m_functions) {
Window_evaluation_requirements reqs;
if (wf.check_wf_semantics2(&reqs)) return true;
if (reqs.opt_nth_row.m_rowno > 0)
m_opt_nth_row.m_offsets.push_back(reqs.opt_nth_row);
/*
INT_MIN64 can't be specified due 2's complement range.
Offset is always given as a positive value; lead converted to negative
but can't get to INT_MIN64. So, if we see this value, this window
function isn't LEAD or LAG.
*/
if (reqs.opt_ll_row.m_rowno != INT_MIN64)
m_opt_lead_lag.m_offsets.push_back(reqs.opt_ll_row);
}
/*
We do not allow FROM_LAST yet, so sorting guarantees sequential traversal
of the frame buffer under evaluation of several NTH_VALUE functions invoked
on a window, which is important for the optimized wf eval strategy
*/
std::sort(m_opt_nth_row.m_offsets.begin(), m_opt_nth_row.m_offsets.end());
std::sort(m_opt_lead_lag.m_offsets.begin(), m_opt_lead_lag.m_offsets.end());
m_is_last_row_in_frame = !m_needs_frame_buffering;
return false;
}
bool Window::setup_windows2(THD *thd, List<Window> *windows) {
for (Window &w : *windows) {
/*
In execution of PS we need to check again in case ? parameters are used
for window borders, or for offsets in window functions..
*/
if (w.check_border_sanity2(thd) || w.check_window_functions2(thd))
return true;
}
return false;
}
bool Window::make_special_rows_cache(THD *thd, TABLE *out_tbl) {
// Each row may come either from frame buffer or out-table
size_t l = std::max((needs_buffering() ? m_frame_buffer->s->reclength : 0),
out_tbl->s->reclength);
if (m_special_rows_cache_max_length != 0) {
// Could already be set up, if the query block is planned twice
// (for in2exists).
assert(m_special_rows_cache_max_length == l);
return false;
}
m_special_rows_cache_max_length = l;
return !(m_special_rows_cache =
(uchar *)thd->alloc((FBC_FIRST_KEY - FBC_LAST_KEY + 1) * l));
}
void Window::cleanup() {
if (m_needs_frame_buffering && m_frame_buffer != nullptr) {
(void)m_frame_buffer->file->ha_index_or_rnd_end();
close_tmp_table(m_frame_buffer);
free_tmp_table(m_frame_buffer);
::destroy(m_frame_buffer_param);
}
m_frame_buffer_positions.clear();
m_special_rows_cache_max_length = 0;
m_frame_buffer_param = nullptr;
m_frame_buffer = nullptr;
}
void Window::destroy() // called only at stmt destruction
{
for (Cached_item *ci : m_order_by_items) {
::destroy(ci);
}
for (Cached_item *ci : m_partition_items) {
::destroy(ci);
}
destroy_array(m_comparators[0].data(), m_comparators[0].size());
destroy_array(m_comparators[1].data(), m_comparators[1].size());
}
void Window::reset_lead_lag() {
for (Item_sum &f : m_functions) {
if (f.sum_func() == Item_sum::LEAD_LAG_FUNC) {
down_cast<Item_lead_lag &>(f).set_has_value(false);
down_cast<Item_lead_lag &>(f).set_use_default(false);
}
}
}
void Window::reset_execution_state(Reset_level level) {
switch (level) {
case RL_ROUND:
if (m_frame_buffer != nullptr) (void)m_frame_buffer->empty_result_table();
m_frame_buffer_total_rows = 0;
m_frame_buffer_partition_offset = 0;
m_part_row_number = 0;
[[fallthrough]];
case RL_PARTITION:
/*
Forget positions in the frame buffer: they won't be valid in a new
partition.
*/
if (!m_frame_buffer_positions.empty()) {
for (Frame_buffer_position &it : m_frame_buffer_positions) {
it.m_rowno = -1;
}
} // else not allocated, empty result set
m_tmp_pos.m_rowno = -1;
/*
w.frame_buffer()->file->ha_reset();
We could truncate the file here if it is not too expensive..? FIXME
*/
break;
}
/*
These state variables are always set per row processed, so no need to
reset here:
m_rowno_being_visited
m_last_rowno_in_peerset
m_is_last_row_in_peerset_within_frame
m_partition_border
m_inverse_aggregation
m_rowno_in_frame
m_rowno_in_partition
m_do_copy_null
m_is_last_row_in_frame
But these need resetting for all levels
*/
m_last_row_output = 0;
m_last_rowno_in_cache = 0;
m_aggregates_primed = false;
m_first_rowno_in_range_frame = 1;
m_last_rowno_in_range_frame = 0;
m_first_rowno_in_rows_frame = 1;
m_row_has_fields_in_out_table = 0;
}
void Window::print_border(const THD *thd, String *str, PT_border *border,
enum_query_type qt) const {
const PT_border &b = *border;
switch (b.m_border_type) {
case WBT_CURRENT_ROW:
str->append("CURRENT ROW");
break;
case WBT_VALUE_FOLLOWING:
case WBT_VALUE_PRECEDING:
if (b.m_date_time) {
str->append("INTERVAL ");
b.m_value->print(thd, str, qt);
str->append(' ');
str->append(interval_names[b.m_int_type]);
str->append(' ');
} else
b.m_value->print(thd, str, qt);
str->append(b.m_border_type == WBT_VALUE_PRECEDING ? " PRECEDING"
: " FOLLOWING");
break;
case WBT_UNBOUNDED_FOLLOWING:
str->append("UNBOUNDED FOLLOWING");
break;
case WBT_UNBOUNDED_PRECEDING:
str->append("UNBOUNDED PRECEDING");
break;
}
}
void Window::print_frame(const THD *thd, String *str,
enum_query_type qt) const {
const PT_frame &f = *m_frame;
str->append(f.m_query_expression == WFU_ROWS
? "ROWS "
: (f.m_query_expression == WFU_RANGE ? "RANGE " : "GROUPS "));
str->append("BETWEEN ");
print_border(thd, str, f.m_from, qt);
str->append(" AND ");
print_border(thd, str, f.m_to, qt);
}
void Window::print(const THD *thd, String *str, enum_query_type qt,
bool expand_definition) const {
if (m_name != nullptr && !expand_definition) {
append_identifier(thd, str, m_name->item_name.ptr(),
m_name->item_name.length());
} else {
str->append('(');
if (m_ancestor) {
append_identifier(thd, str, m_ancestor->m_name->item_name.ptr(),
strlen(m_ancestor->m_name->item_name.ptr()));
str->append(' ');
}
if (m_partition_by != nullptr) {
str->append("PARTITION BY ");
Query_block::print_order(thd, str, m_partition_by->value.first, qt);
str->append(' ');
}
if (m_order_by != nullptr) {
str->append("ORDER BY ");
Query_block::print_order(thd, str, m_order_by->value.first, qt);
str->append(' ');
}
if (!m_frame->m_originally_absent) {
print_frame(thd, str, qt);
}
str->append(") ");
}
}
const char *Window::printable_name() const {
if (m_name == nullptr) return "<unnamed window>";
// Since Item_string::val_str() ignores the argument, it is safe
// to use nullptr as argument.
return m_name->val_str(nullptr)->ptr();
}
void Window::reset_all_wf_state() {
for (Item_sum &sum : m_functions) {
for (bool framing : {false, true}) {
(void)sum.walk(&Item::reset_wf_state, enum_walk::POSTFIX,
(uchar *)&framing);
}
}
}
bool Window::has_windowing_steps() const {
return m_query_block != nullptr && m_query_block->join != nullptr &&
m_query_block->join->m_windowing_steps;
}
double Window::compute_cost(double cost, const List<Window> &windows) {
double total_cost = 0.0;
for (const Window &w : windows)
if (w.needs_sorting()) total_cost += cost;
return total_cost;
}
void Window::apply_temp_table(THD *thd, const Func_ptr_array &items_to_copy) {
for (Cached_item *&ci : m_partition_items) {
Item *item = FindReplacementOrReplaceMaterializedItems(
thd, ci->get_item()->real_item(), items_to_copy,
/*need_exact_match=*/true);
thd->change_item_tree(ci->get_item_ptr(), item);
}
for (Cached_item *&ci : m_order_by_items) {
Item *item = FindReplacementOrReplaceMaterializedItems(
thd, ci->get_item()->real_item(), items_to_copy,
/*need_exact_match=*/true);
thd->change_item_tree(ci->get_item_ptr(), item);
}
// Item_rank looks directly into the ORDER *, so we need to update
// that as well.
if (m_order_by != nullptr) {
ReplaceOrderItemsWithTempTableFields(thd, m_order_by->value.first,
items_to_copy);
}
for (int i = 0; i < 2; ++i) {
for (Arg_comparator &cmp : m_comparators[i]) {
Item **left_ptr = cmp.get_left_ptr();
Item *new_item = FindReplacementOrReplaceMaterializedItems(
thd, (*left_ptr)->real_item(), items_to_copy,
/*need_exact_match=*/true);
thd->change_item_tree(left_ptr, new_item);
Item_cache *cache = FindCacheInComparator(cmp);
Item *new_cache_item = FindReplacementOrReplaceMaterializedItems(
thd, cache->get_example()->real_item(), items_to_copy,
/*need_exact_match=*/true);
thd->change_item_tree(cache->get_example_ptr(), new_cache_item);
}
}
}
|