/usr/lib/mysql-workbench/modules/explain_renderer.py is in mysql-workbench 6.2.3+dfsg-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 | # Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 of the
# License.
#
# 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 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
import mforms
from workbench.log import log_error
from workbench.graphics.canvas import VBoxFigure, Canvas, DiamondShapeFigure, RectangleShapeFigure, TextFigure, HFill, draw_varrow, draw_harrow
from workbench.graphics.cairo_utils import ImageSurface, Context
import cairo
import StringIO
import json
def decode_json(text):
fp = StringIO.StringIO(text)
return json.load(fp)
def reformat_expression(expression):
# turn the expression into a valid SQL query
sql = "SELECT " + expression
try:
import sqlide_grt
sql = sqlide_grt.reformatSQLStatement(sql)
# strip the artificially added SELECT
expression = sql.partition(" ")[-1].strip()
except ImportError:
log_error("Can't import sqlide_grt, disabling expression reformatting\n")
return expression
def fmt_number(c):
if c >= 1000*1000*1000:
return "%.2fG" % (c/(1000*1000*1000.0))
elif c >= 1000*1000:
return "%.02fM" % (c/(1000*1000.0))
elif c >= 1000:
return "%.0fK" % (c/1000.0)
return str(c)
def fmt_rows(r):
if r == 1:
return "%i row" % r
else:
if r > 1000000000:
return "%.2fG rows" % (r/1000000000.0)
elif r > 1000000:
return "%.2fM rows" % (r/1000000.0)
elif r > 1000:
return "%.2fK rows" % (r/1000.0)
else:
return "%s rows" % r
class MyCanvas(Canvas):
def __init__(self, cb):
Canvas.__init__(self, cb)
def figure_at(self, x, y):
fig = Canvas.figure_at(self, x, y)
if fig:
return fig.get_figure_at(x, y)
return None
class ExplainNode(VBoxFigure):
arrow_w = 3
arrow_h = 7
is_operation = False
is_container = False
def __init__(self, context):
VBoxFigure.__init__(self)
self._context = context
self.parent = None
self.cost_info = None
self._figure = None
self._aggr_cost_value = None
self._aggr_cost_pct = None
self.on_hover_in = self.handle_hover_in
self.on_hover_out = self.handle_hover_out
@property
def inner_width(self):
"""Width of the figure itself, without accounting for child nodes"""
return self._figure.width
@property
def inner_height(self):
return self._figure.height
@property
def varrow_source(self):
return int(self.root_x + self.vconnect_pos_offset)+0.5, self._figure.root_y
@property
def varrow_target(self):
return int(self.root_x + self.vconnect_pos_offset)+0.5, self._figure.root_y + self.inner_height
@property
def harrow_target(self):
return self._figure.root_x, int(self.root_y + self.hconnect_pos_offset)+0.5
@property
def harrow_target_right(self):
return int(self._figure.root_x + self._figure.width)+0.5, int(self.root_y + self.hconnect_pos_offset)+0.5
@property
def harrow_source(self):
return self._figure.root_x + self.inner_width, int(self.root_y + self.hconnect_pos_offset)+0.5
@property
def vconnect_pos_offset(self):
return self._figure.x + self.inner_width/2
@property
def hconnect_pos_offset(self):
return self._figure.y + self._figure.height/2
def get_read_eval_cost(self):
return None
@property
def cost_value(self):
cost_value = None
if self._context.displayed_cost_info == "read_eval_cost":
# 5.7 server only
# for table nodes, we display the read+eval value
# for nested_loop nodes, we display prefix_cost
cost_value = self.get_read_eval_cost()
if cost_value is not None:
try:
return float(cost_value)
except ValueError: # some values have a unit suffix
value = cost_value[:-1]
unit = cost_value[-1]
value = float(value)
if unit == "K":
return value * 1000
elif unit == "M":
return value * 1000*1000
elif unit == "G":
return value * 1000*1000*1000
else:
return value
return None
@property
def rows_count(self):
"""The row count number to be shown in outgoing node arrows
"""
return None
def get_figure_at(self, x, y):
if self.root_x < x < self.root_x + self.width and self.root_y < y < self.root_y + self.height:
for f in self.children:
ff = f.get_figure_at(x, y)
if ff:
return ff
if self._figure.root_x < x < self._figure.root_x + self.inner_width and self._figure.root_y < y < self._figure.root_y + self.inner_height:
return self
return None
def dump(self, s, level=0):
if self.children:
s.write(level*" "+repr(self)+" (\n")
for x in self.children:
x.dump(s, level+1)
s.write("\n")
s.write(level*" " + ")")
else:
s.write(level*" "+repr(self))
def get_line_width(self):
rows_count = self.rows_count
line_width = 1
if rows_count:
from math import log
line_width = max(min(int(log(rows_count, 20)+0.5), 20), 1)
return line_width
def render_cost(self, cr, x, y):
cost = self.cost_value
if cost is not None:
cr.set_source_rgba(0, 0, 0, 1)
cr.move_to(x, y)
cr.set_font_size(10)
cr.show_text(self._context.fmt_cost(cost))
def render_row_count(self, cr, x, y):
rows_count = self.rows_count
if rows_count is not None:
cr.set_source_rgba(0, 0, 0, 1)
cr.move_to(x, y)
cr.set_font_size(10)
cr.show_text(fmt_rows(rows_count))
def do_render_extras(self, cr):
pass
def render_extras(self, cr):
self.do_render_extras(cr)
for ch in self.children:
assert ch.parent == self
ch.render_extras(cr)
def render(self, cr):
self.do_render(cr)
self.render_extras(cr)
def do_render(self, cr):
VBoxFigure.render(self, cr)
cr.save()
cr.translate(self.x, self.y)
for ch in self.children:
ch.do_render(cr)
#ctx = cr
#ctx.rectangle(0, 0, self.width, self.height)
#ctx.set_line_width(1)
#ctx.set_source_rgba(0.3, 0.3, 0.7, 1)
#ctx.stroke()
#ctx.set_source_rgba(1, 0, 0, 1)
#ctx.rectangle(self.vconnect_pos_offset-1, 0, 2, 2)
#ctx.fill()
cr.restore()
def do_relayout(self, ctx):
VBoxFigure.do_relayout(self, ctx)
if self.children:
# calculate layout of the child item
child = self.children[0]
child.do_relayout(ctx)
# get the offset of the point in the child item that should be
# aligned with the parent item
child_align_x = child.vconnect_pos_offset
child_width = child.width
# increase the size of this item, to allow fitting the child item
self._width = child_width
self._height = self.inner_height + self._context.vspacing + child.height
# position the child
child.move(0, self.inner_height + self._context.vspacing)
# position the inner figure of the node so it aligns with the center of the child
self._figure.move(child_align_x - self.inner_width/2, self._figure.y)
def draw_varrow(self, cr, x, y1, y2):
cr.set_line_width(self.get_line_width())
cr.move_to(x, y1)
cr.line_to(x, y2 + 6 + self.get_line_width())
cr.stroke()
draw_varrow(cr, (x, y2), 10+self.get_line_width(), 6+self.get_line_width())
cr.fill()
def draw_harrow(self, cr, x1, x2, y, w=10, h=6):
cr.set_line_width(self.get_line_width())
cr.move_to(x1, y)
cr.line_to(x2 - (w + self.get_line_width()), y)
cr.stroke()
draw_harrow(cr, (x2, y), w+self.get_line_width(), h+self.get_line_width())
cr.fill()
# hover tip handling
def handle_hover_out(self, fig, x, y):
if self._context.tooltip:
self._context.tooltip.close()
self._context.tooltip = None
@property
def hint_pos_x(self):
return self.root_x + self.width
def get_hint_text(self):
return None
def handle_hover_in(self, fig, x, y):
if self._context.tooltip:
self._context.tooltip.close()
self._context.tooltip = None
if self._context.overview_mode:
return
text = self.get_hint_text()
if text:
if type(text) is unicode:
text = text.encode("utf8")
self._context.tooltip = mforms.newPopover(mforms.PopoverStyleTooltip)
if fig.is_container:
xx, yy = self._context.client_to_screen(x + 10, y)
else:
xx, yy = self._context.client_to_screen(fig._figure.root_x + fig.inner_width, fig._figure.root_y + fig.inner_height/2)
box = mforms.newBox(False)
box.set_spacing(0)
t = ""
for line in text.split("\n"):
if line.startswith("*"):
if t:
if t.endswith("\n"):
t = t[:-1]
label = mforms.newLabel(t)
label.set_style(mforms.SmallStyle)
box.add(label, False, False)
t = ""
label = mforms.newLabel(line[1:].rstrip("\n"))
label.set_style(mforms.SmallBoldStyle)
box.add(label, False, False)
else:
t += line+"\n"
if t:
label = mforms.newLabel(t.rstrip("\n"))
label.set_style(mforms.SmallStyle)
box.add(label, False, False)
self._context.tooltip.set_size(max(box.get_width(), 100), max(box.get_height(), 50))
self._context.tooltip.set_content(box)
self._context.tooltip.add_close_callback(self._context.close_tooltip)
self._context.tooltip.show_and_track(self._context._view, xx, yy, mforms.Right)
class NestedLoopNode(ExplainNode):
is_operation = True
def __init__(self, context, join_buffer, left_child, right_child):
ExplainNode.__init__(self, context)
self.join_buffer = join_buffer
left_child.parent = self
right_child.parent = self
self.child_aside = left_child
self.child_below = right_child
if join_buffer == "nested_loop":
caption = "nested\nloop"
elif join_buffer == "Block Nested Loop":
caption = "block\nnested\nloop"
elif join_buffer == "Batched Key Access":
caption = "batched\nkey\naccess"
elif join_buffer == "Batched Key Access (unique)":
caption = "batched\nkey\naccess (u)"
else:
caption = join_buffer.replace(" ", "\n")
self._figure = DiamondShapeFigure(caption)
self._figure.set_layout_flags(0)
self._figure.set_color(0.5, 0.5, 0.5, 1)
self._figure.set_text_color(0, 0, 0, 1)
# self._figure.set_fill_color(0.8, 0.8, 0.8, 1)
self._figure.set_line_width(2)
self._figure.set_font_size(11)
self._figure.set_usize(self._context.default_height, self._context.default_height)
self.add(self._figure)
@property
def children(self):
return [self.child_aside, self.child_below]
@property
def vconnect_pos_offset(self):
return self.child_aside.width + self._context.hspacing + self.child_below.inner_width/2
@property
def rows_count(self):
if self._context.server_version.is_supported_mysql_version_at_least(5, 7):
return self.child_below.rows_produced
return None
def get_read_eval_cost(self):
return float(self.child_below.cost_info.get("prefix_cost", 0)) if self.child_below.cost_info else None
def __repr__(self):
return self.join_buffer
def do_render_extras(self, cr):
if self.parent:
is_inside_a_box = isinstance(self.parent, MaterializedTableNode) or isinstance(self.parent, MaterializedJoinNode)
cr.save()
cr.set_source_rgba(0, 0, 0, 1)
if isinstance(self.parent, NestedLoopNode):
if not is_inside_a_box:
self.draw_harrow(cr, self.harrow_source[0], self.parent.harrow_target[0], self.parent.harrow_target[1])
self.render_row_count(cr, self.harrow_source[0] + 4, self.harrow_source[1] - 8)
else:
if not is_inside_a_box:
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
self.render_row_count(cr, self.varrow_source[0] + 4, self.varrow_source[1])
self.render_cost(cr, self._figure.root_x, self.varrow_source[1] - 5)
cr.restore()
def do_relayout(self, ctx):
# 1 node directly under this and the other to lower/left
# if it's another NestedLoopNode, then it should just be on the side too
below = self.child_below
aside = self.child_aside
self._figure.do_relayout(ctx)
below.do_relayout(ctx)
aside.do_relayout(ctx)
total_width = below.width + aside.width + self._context.hspacing
self._width = max(self.inner_width, total_width)
# layout other nested loop nodes horizontally
if isinstance(aside, NestedLoopNode):
self._height = max(self._figure.height + self._context.vspacing + below.height,
aside.height)
self._figure.move(self.vconnect_pos_offset - self.inner_width/2,
0)
aside.move(0, self._figure.y)
else:
self._height = self._figure.height + self._context.vspacing + max(below.height, aside.height)
self._figure.move(self.vconnect_pos_offset - self.inner_width/2, 0)
aside.move(0, self._figure.height + self._context.vspacing)
below.move(aside.width + self._context.hspacing, self._figure.height + self._context.vspacing)
def get_hint_text(self):
text = """*%(join_buffer)s
""" % {"join_buffer" : self.join_buffer}
if self.child_below.cost_info:
text += "Prefix Cost: %(prefix_cost)s" % self.child_below.cost_info # 5.7 only
return text
BLUE = (0.25, 0.5, 0.75, 1)
GREEN = (0.0, 0.5, 0.0, 1)
YELLOW = (0.75, 0.75, 0.0, 1)
ORANGE = (0.75, 0.5, 0.0, 1)
RED = (0.75, 0.25, 0.25, 1)
BLACK = (0, 0, 0, 1)
WHITE = (1, 1, 1, 1)
class TableNode(ExplainNode):
col_join_types = [
("system", BLUE, "Single Row\n(system constant)", "Very low cost"),
("const", BLUE, "Single Row\n(constant)", "Very low cost"),
("eq_ref", GREEN, "Unique Key Lookup", """Low - The optimizer is able to find an index that it can use to retrieve required records.
Fast because the index search leads directly to the page with all the row data"""),
("ref", GREEN, "Non-Unique Key Lookup", "Low-medium - Low if number of matching rows is small, higher as the number of rows increases."),
("fulltext", YELLOW, "Fulltext Index Search", "Specialized FULL TEXT search. Low - for this specialized search requirement."),
("ref_or_null", GREEN, "Key Lookup +\nFetch NULL Values", """Low-medium - if number of matching rows is small, higher as the number of rows increases."""),
("index_merge", GREEN, "Index Merge", "Medium - may want to look for better index selection in the query to improve performance."),
("unique_subquery", ORANGE, "Unique Key Lookup\ninto table of subquery", "Low - Used for efficient Subquery processing"),
("index_subquery", ORANGE, "Non-Unique Key Lookup\ninto table of subquery", "Low - Used for efficient Subquery processing"),
("range", ORANGE, "Index Range Scan", "Medium - partial index scan"),
("index", RED, "Full Index Scan", "High - especially for large indexes"),
("ALL", RED, "Full Table Scan", """Very High - very costly for large tables (not so much for small ones).
No usable indexes were found for the table and the optimizer must search every row.
This could also mean the search range is so broad that the index would be useless."""),
("UNKNOWN", BLACK, "unknown", ""), # the default, in case none matches
]
def __init__(self, context, name, access_type, attached_subqueries=None,\
key_name = [], info = None, cost_info = None,\
rows_examined = None, rows_produced = None):
ExplainNode.__init__(self, context)
self.name = name
self.key_name = key_name
self.access_type = access_type
self.info = info
self.cost_info = cost_info
self.rows_examined = rows_examined
self.rows_produced = rows_produced
self.child_attached_subqueries = attached_subqueries
if attached_subqueries:
attached_subqueries.parent = self
for key, color, label, hint in self.col_join_types:
if access_type == key:
break
self.info["_hint"] = hint
self.info["_access_type"] = label
self.set_spacing(4)
self._figure = RectangleShapeFigure(label)
self._figure.set_layout_flags(0)
self._figure.set_font_size(11)
self._figure.set_font_bold(True)
self._figure.set_fill_color(*color)
self._figure.set_text_color(1, 1, 1, 1)
self._figure.set_padding(10, 10, 10, 10)
self.add(self._figure)
self._figure_name = RectangleShapeFigure(self.name)
self._figure_name.set_layout_flags(0)
self._figure_name.set_color(1, 1, 1, 0)
self._figure_name.set_font_size(11)
self._figure_name.set_text_color(0, 0, 0, 1)
self._figure_name.set_alignment(0.5, 0)
self.add(self._figure_name)
if self.key_name:
self._figure_key = TextFigure(self.key_name)
self._figure_key.set_layout_flags(0)
self._figure_key.set_font_size(10)
self._figure_key.set_font_bold(True)
self._figure_key.set_text_color(0, 0, 0, 1)
self._figure_key.set_alignment(0.5, 0)
self.add(self._figure_key)
else:
self._figure_key = None
@property
def children(self):
if self.child_attached_subqueries:
return [self.child_attached_subqueries]
return []
def get_read_eval_cost(self):
if self.cost_info:
return float(self.cost_info.get("read_cost", 0)) + float(self.cost_info.get("eval_cost", 0))
return None
@property
def rows_count(self):
return self.rows_examined
@property
def vconnect_pos_offset(self):
if self.child_attached_subqueries:
return self._figure.x + self._figure.width/2
return self._figure.x + self.inner_width/2
@property
def inner_height(self):
h = self._figure.height
if self._figure_name:
h += 4 + self._figure_name.height
if self._figure_key:
h += 4 + self._figure_key.height
return h
@property
def hint_pos_x(self):
return self._figure.root_x + self._figure.width
def _hint_line(self, label, key, always_show=False, value_format=None):
if self.info.has_key(key) or always_show:
if value_format and self.info.has_key(key):
value = value_format % self.info[key]
else:
value = self.info.get(key, "-")
if type(value) is list:
value = ",\n ".join(value)
return "%s %s\n" % (label, value)
return ""
def get_hint_text(self):
text = """*%(table_name)s
Access Type: %(access_type)s
%(_access_type)s
Cost Hint: %(_hint)s
""" % self.info
text += self._hint_line(" Used Columns:", "used_columns") # 5.7
text += "\n"
text += self._hint_line("*Key/Index:", "key", True)
text += self._hint_line(" Ref.:", "ref")
text += self._hint_line(" Used Key Parts:", "used_key_parts")
text += self._hint_line(" Possible Keys:", "possible_keys")
if "used_columns" in self.info or "used_key_parts" in self.info or "possible_keys" in self.info:
text += "\n"
if "attached_condition_fmt" not in self.info and "attached_condition" in self.info:
# create a formatted version of attached_condition, so it will not be too wide
try:
self.info["attached_condition_fmt"] = reformat_expression(self.info["attached_condition"])
except Exception, e:
log_error("Could not reformat %s: %s\n" % (self.info["attached_condition"], e))
self.info["attached_condition_fmt"] = self.info["attached_condition"]
text += self._hint_line("*Attached Condition:\n", "attached_condition_fmt")
if "attached_condition" in self.info:
text += "\n"
text += self._hint_line("Using Join Buffer:", "using_join_buffer")
text += self._hint_line("Rows Examined per Scan:", "rows_examined_per_scan") # 5.7
text += self._hint_line("Rows Produced per Join:", "rows_produced_per_join") # 5.7
text += self._hint_line("Filtered (ratio of rows produced per rows examined):", "filtered", value_format="%s%%")
text += " Hint: 100% is best, <= 1% is worst\n"
text += " A low value means the query examines a lot of rows that are not returned.\n"
if self.cost_info: # 5.7
text += """*Cost Info
Read: %(read_cost)s
Eval: %(eval_cost)s
Prefix: %(prefix_cost)s
Data Read: %(data_read_per_join)s
""" % self.cost_info
return text
def do_render_extras(self, cr):
if self.parent and not isinstance(self.parent, MaterializedTableNode):
cr.save()
cr.set_source_rgba(0, 0, 0, 1)
if isinstance(self.parent, NestedLoopNode) and self.parent.child_aside == self:
# special case (line in L)
cr.move_to(*self.varrow_source)
cr.line_to(self.varrow_source[0], self.parent.harrow_target[1])
self.draw_harrow(cr, self.varrow_source[0], self.parent.harrow_target[0], self.parent.harrow_target[1])
else:
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
self.render_cost(cr, self._figure.root_x, self.varrow_source[1] - 5)
self.render_row_count(cr, self.varrow_source[0] + 4, self.varrow_source[1] - 5)
cr.restore()
def do_relayout(self, ctx):
self._figure.set_usize(None, None)
self._figure.do_relayout(ctx)
self._figure.set_usize(max(self._figure.width, 90), self._figure._uheight)
if self._figure_name:
self._figure_name.set_usize(max(self._figure.width, 90), self._figure_name._uheight)
if self._figure_key:
self._figure_key.set_usize(max(self._figure.width, 90), self._figure_key._uheight)
self._height = self.inner_height
VBoxFigure.do_relayout(self, ctx)
# for subselects in the WHERE list (attached subqs), attach them from the right side
# select * from ... where (select ...) = ...
child = self.child_attached_subqueries
if child:
child.do_relayout(ctx)
self._figure.move(0, self._figure.y)
if self._figure_name:
self._figure_name.move(0, self._figure_name.y)
if self._figure_key:
self._figure_key.move(0, self._figure_key.y)
child.move(self._figure.x + self._figure.width + self._context.hspacing, self._figure.y)
self._width = self._figure.width + self._context.hspacing + child.width
self._height = max(self._height, child.height)
def __repr__(self):
return "<table: "+self.name+" ("+self.access_type+")>"
class MaterializedTableNode(TableNode):
is_container = True
def __init__(self, context, name, access_type, attached_subqueries=None,\
materialized_from = None, materialize_attributes = None,\
key_name = [], info = None, cost_info = None,\
rows_examined = None, rows_produced = None):
TableNode.__init__(self, context, name, access_type = access_type,
attached_subqueries = attached_subqueries,
key_name = key_name, info = info,
cost_info = cost_info, rows_examined = rows_examined, rows_produced = rows_produced)
self.set_spacing(0)
fill = self._figure._fill_color
self._figure.set_color(fill[0], fill[1], fill[2], 0.8)
self._figure.set_fill_color(fill[0], fill[1], fill[2], 0.8)
self._figure_name.set_color(0.9, 0.9, 0.9, 0.9)
if name.startswith("<") and name.endswith(">"):
self._figure_name.set_text(name)
else:
self._figure_name.set_text("%s (materialized)" % name)
self._figure_name.set_fill_color(0.9, 0.9, 0.9, 0.9)
self._figure_name.set_padding(4, 4, 4, 4)
self.materialize_attributes = materialize_attributes
self.child_materialized_from = materialized_from
materialized_from.parent = self
def __repr__(self):
return "<materialized table: "+self.name+" ("+self.access_type+")>"
@property
def children(self):
return TableNode.children.fget(self) + [self.child_materialized_from]
def do_relayout(self, ctx):
self.child_materialized_from.do_relayout(ctx)
width = self.child_materialized_from.width + self._context.frame_padding*2
# skip Table specific layouting and do everything from scratch
VBoxFigure.do_relayout(self, ctx)
for f in self._items:
f.move(0, f.y)
f._width = width
self._width = width
self._height = max(self._height, int(self.inner_height + self.child_materialized_from.height + self._context.frame_padding*2))
if self.width <= self.child_materialized_from.width:
self.child_materialized_from.move(self._context.frame_padding,
self.inner_height + self._context.frame_padding)
else:
self.child_materialized_from.move((width - self.child_materialized_from.width)/2,
self.inner_height + self._context.frame_padding)
# for subselects in the WHERE list (attached subqs), attach them from the right side
# select * from ... where (select ...) = ...
child = self.child_attached_subqueries
if child:
child.do_relayout(ctx)
child.move(width + self._context.hspacing, self._figure.y)
self._width = width + self._context.hspacing + child.width
self._height = max(self._height, child.height)
def do_render(self, ctx):
TableNode.do_render(self, ctx)
ctx.save()
ctx.translate(self.x, self.y)
ctx.rectangle(0.5, 0.5,
int(self.child_materialized_from.width + self.child_materialized_from.x + self._context.frame_padding),
int(self.child_materialized_from.height + self.child_materialized_from.y + self._context.frame_padding))
ctx.set_line_width(1)
ctx.set_dash([4.0, 2.0], 0)
ctx.set_source_rgba(0.5, 0.5, 0.5, 0.9)
ctx.stroke()
ctx.restore()
@property
def inner_width(self):
return self.width
def get_hint_text(self):
d = {"dependent":False,
"cacheable":False,
"using_temporary_table":False
}
d.update(self.materialize_attributes)
text = """*Materialized from Subquery
Using Temporary Table: %(using_temporary_table)s
Dependent: %(dependent)s
Cacheable: %(cacheable)s
""" % d
text = text + "\n" + TableNode.get_hint_text(self)
class OperationNode(ExplainNode):
is_operation = True
def __init__(self, context, operation, child, cost_info = None, attributes = None, optimized_away_subnode=None):
ExplainNode.__init__(self, context)
self.operation = operation
if child:
child.parent = self
self.child = child
self.cost_info = cost_info
self.attributes = attributes
self.child_optimized_away = optimized_away_subnode
if operation == "grouping_operation":
operation_caption = "GROUP"
score = 0
if self.attributes.get("using_temporary_table", False):
score += 1
if self.attributes.get("using_filesort", False):
score += 1
elif operation == "duplicates_removal":
operation_caption = "DISTINCT"
score = 0
if self.attributes.get("using_filesort", False):
score += 2
elif operation == "ordering_operation":
operation_caption = "ORDER"
score = 0
if self.attributes.get("using_filesort", False):
score += 2
else:
log_error("Unknown operation: %s\n" % operation)
operation_caption = operation
score = 0
fill_color = YELLOW
if score == 1:
fill_color = ORANGE
elif score == 2:
fill_color = RED
self.set_spacing(4)
self._figure = RectangleShapeFigure(operation_caption)
self._figure.set_layout_flags(0)
self._figure.set_corner_radius(20)
self._figure.set_color(0.0, 0.0, 0.0, 1)
self._figure.set_color(*fill_color)
self._figure.set_line_width(2)
self._figure.set_padding(15, 20, 15, 20)
self.add(self._figure)
attrs = []
if self.attributes.get("using_temporary_table"):
attrs.append("tmp table")
if self.attributes.get("using_filesort"):
attrs.append("filesort")
if attrs:
self._figure_message = TextFigure(",".join(attrs))
self._figure_message.set_font_bold(True)
self._figure_message.set_font_size(10)
self.add(self._figure_message)
else:
self._figure_message = None
@property
def varrow_target(self):
if self._figure_message:
return int(self.root_x + self.vconnect_pos_offset)+0.5, self._figure.root_y + self._figure_message.height + self.inner_height + 5
else:
return int(self.root_x + self.vconnect_pos_offset)+0.5, self._figure.root_y + self.inner_height + 1
@property
def children(self):
return [self.child] if self.child else []
def do_render_extras(self, cr):
if self.parent and not isinstance(self.parent, MaterializedTableNode) and not isinstance(self.parent, MaterializedJoinNode):
cr.save()
cr.set_source_rgba(0, 0, 0, 1)
if isinstance(self.parent, NestedLoopNode) and self.parent.child_aside == self:
# special case
self.draw_harrow(cr, self.varrow_source[0], self.parent.harrow_target[0], self.parent.harrow_target[1])
elif isinstance(self.parent, OperationNode):
self.draw_harrow(cr, self.harrow_source[0], self.parent.harrow_target[0], self.harrow_source[1])
else:
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
cr.restore()
def do_relayout(self, ctx):
VBoxFigure.do_relayout(self, ctx)
child = self.child
child.do_relayout(ctx)
if (isinstance(child, NestedLoopNode) or isinstance(child, MaterializedJoinNode)) or isinstance(child, TableNode):
self._width = max(child.width, self.width)
self._height = child.height + self._context.vspacing + self.inner_height
if child.width > self._figure.width:
self._figure.move(child.vconnect_pos_offset - self._figure.width/2,
0)
child.move(0, self._figure.height + self._context.vspacing)
else:
self._figure.move(0, 0)
child.move((self._figure.width - child.width) / 2,
self._figure.height + self._context.vspacing)
else:
self._width = child.width + self._context.hspacing + self.inner_width
self._height = max(child.height, self.inner_height)
self._figure.move(child.width + self._context.hspacing,
0)
child.move(0, 0)
if self._figure_message:
self._figure_message.move(self._figure.x, self._figure.y + self._figure.height + 4)
def get_hint_text(self):
if self.operation == "grouping_operation":
text = "*Grouping Operation\n"
elif self.operation == "ordering_operation":
text = "*Ordering Operation\n"
elif self.operation == "duplicates_removal":
text = "*Duplicates Removal\n"
else:
text = self.operation+"\n"
text += "\n"
if "using_temporary_table" in self.attributes:
text += "Using Temporary Table: %s\n" % self.attributes["using_temporary_table"]
if "using_filesort" in self.attributes:
text += "Using Filesort: %s\n" % self.attributes["using_filesort"]
if self.cost_info and "sort_cost" in self.cost_info:
text += "Sort Cost: %s\n" % self.cost_info["sort_cost"]
return text
@property
def rows_count(self):
if self.children:
return self.children[0].rows_count
else:
print "Node", self, "has no children"
return 0
def __repr__(self):
return self.operation
class QueryBlockNode(ExplainNode):
def __init__(self, context, nested_loop, optimized_away_subnode=None, select_list_subqueries=None, info=None, cost_info=None):
ExplainNode.__init__(self, context)
if nested_loop:
nested_loop.parent = self
self.info = info
self.cost_info = cost_info
self.child = nested_loop
self.child_optimized_away = optimized_away_subnode
if optimized_away_subnode:
optimized_away_subnode.parent = self
self.select_list_subqueries = select_list_subqueries
if select_list_subqueries:
select_list_subqueries.parent = self
self.set_spacing(8)
if info and "select_id" in info:
self._figure = RectangleShapeFigure("query_block #%s" % info["select_id"])
else:
self._figure = RectangleShapeFigure("query_block")
self._figure.set_layout_flags(0)
self._figure.set_padding(10, 10, 10, 10)
self.add(self._figure)
if info and "message" in info:
self._figure_message = TextFigure(info["message"])
self._figure_message.set_font_size(11)
self._figure_message.set_text_color(0, 0, 0, 1)
self._figure_message.set_alignment(0.5, 0)
self.add(self._figure_message)
else:
self._figure_message = None
@property
def inner_height(self):
h = self._figure.height
if self._figure_message:
h += self._figure_message.height
return h
@property
def children(self):
result = []
if self.child:
result.append(self.child)
if self.select_list_subqueries:
result.append(self.select_list_subqueries)
return result
def do_relayout(self, ctx):
VBoxFigure.do_relayout(self, ctx)
# calculate layout of the child item
child = self.child
if child:
child.do_relayout(ctx)
# extra space for cost info at top
voffset = 20
# get the offset of the point in the child item that should be
# aligned with the parent item
child_align_x = child.vconnect_pos_offset
child_width = child.width
# increase the size of this item, to allow fitting the child item
self._width = child_width
self._height = self.inner_height + self._context.vspacing + child.height + voffset
# position the child
child.move(0, self.inner_height + self._context.vspacing)
# position the inner figure of the node so it aligns with the center of the child
self._figure.move(child_align_x - self.inner_width/2, voffset)
# for subselects in the SELECT list, attach them from the right side
# select (select ...) from ...
child = self.select_list_subqueries
if child:
child.do_relayout(ctx)
child.move(self.width + self._context.small_hspacing, self._figure.y + self._context.frame_padding)
self._width += self._context.small_hspacing + child.width
self._height = max(self._height, child.y + child.height)
self._width += self._context.frame_padding * 2
self._height += self._context.frame_padding
def get_hint_text(self):
text = "Select ID: %s\n" % self.info["select_id"]
if self.cost_info and "query_cost" in self.cost_info:
text += "Query Cost: %s\n" % self.cost_info["query_cost"]
return text
def render_cost(self, cr, x, y):
if self.cost_info:
cost = self.cost_info.get("query_cost")
if cost is not None:
cr.set_source_rgba(0, 0, 0, 1)
cr.move_to(x, y)
cr.set_font_size(10)
cr.show_text("Query cost: %s" % cost)
def do_render_extras(self, cr):
cr.save()
#is_root_node = self.parent is None
if False:
# draw rectangle around the whole query block
cr.save()
cr.set_source_rgba(0, 0, 0, .3)
cr.set_line_width(2)
cr.rectangle(self.root_x - self._context.frame_padding, self._figure.root_y, self.width, self.height - self._figure.y)
cr.stroke()
cr.restore()
cr.set_source_rgba(0, 0, 0, 1)
self.render_cost(cr, self._figure.root_x, self._figure.root_y - 5)
if self.parent and not isinstance(self.parent, MaterializedTableNode):
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
cr.restore()
def __repr__(self):
return "query_block"
class SubQueryBlockNode(QueryBlockNode):
def __init__(self, context, nested_loop, optimized_away_subnode=None, select_list_subqueries=None, info=None, cost_info=None):
QueryBlockNode.__init__(self, context, nested_loop, optimized_away_subnode, select_list_subqueries, info, cost_info)
self.attributes = None
if info and "select_id" in info:
self._figure.set_text("subquery #%s" % info["select_id"])
else:
self._figure.set_text("subquery")
def set_attributes(self, attributes):
self.attributes = attributes
# @property
# def varrow_target(self):
# return None, self.root_y + self.inner_height
def get_hint_text(self):
text = "Subquery\n"
if "select_id" in self.info:
text += "Select ID: %s\n" % self.info["select_id"]
if self.cost_info and "query_cost" in self.cost_info:
text += "Query Cost: %s\n" % self.cost_info["query_cost"]
text += "\n"
if "using_temporary_table" in self.attributes:
text += "Using Temporary Table: %s\n" % self.attributes["using_temporary_table"]
if "dependent" in self.attributes:
text += "Dependent: %s\n" % self.attributes["dependent"]
if "cacheable" in self.attributes:
text += "Cacheable: %s\n" % self.attributes["cacheable"]
return text
def __repr__(self):
return "subquery"
class MaterializedJoinNode(ExplainNode):
is_container = True
def __init__(self, context, name, nested_loop, info, cost_info, attributes):
ExplainNode.__init__(self, context)
self.set_spacing(0)
self.set_padding(10, 10, 10, 10)
self._figure = RectangleShapeFigure(name)
self._figure.set_layout_flags(HFill)
self._figure.set_line_width(1)
self._figure.set_color(0.5, 0.5, 0.5, 0.8)
self._figure.set_fill_color(0.5, 0.5, 0.5, 0.8)
self._figure.set_font_bold(True)
self._figure.set_padding(6, 4, 6, 4)
self.add(self._figure)
self.attributes = attributes
attrs = []
if self.attributes.get("using_temporary_table"):
attrs.append("tmp table")
if attrs:
self._figure_message = TextFigure(",".join(attrs))
self._figure_message.set_font_bold(True)
self._figure_message.set_font_size(10)
self.add(self._figure_message)
else:
self._figure_message = None
self.nested_loop = nested_loop
nested_loop.parent = self
self.info = info
self.cost_info = cost_info
self.child = nested_loop
@property
def inner_height(self):
h = self._figure.height
return h
@property
def inner_width(self):
return self.width
@property
def vconnect_pos_offset(self):
return self.width/2
@property
def children(self):
result = []
if self.child:
result.append(self.child)
return result
def get_hint_text(self):
d = {
"using_temporary_table":False
}
d.update(self.attributes)
text = """*Buffered Join Result
Using Temporary Table: %(using_temporary_table)s
""" % d
return text
def do_relayout(self, ctx):
ExplainNode.do_relayout(self, ctx)
# calculate layout of the child item
child = self.child
if child:
child.do_relayout(ctx)
child_width = child.width
# increase the size of this item, to allow fitting the child item
self._width = child_width + self.padding_left + self.padding_right
self._height = self.inner_height + self._context.vspacing + child.height + self.padding_top + self.padding_bottom
# position the child
child.move(self.padding_left, self.inner_height + self._context.vspacing)
# position the inner figure of the node so it aligns with the center of the child
self._figure.move(0, 0)
def __repr__(self):
return "<"+self.name+">"
def do_render(self, ctx):
ExplainNode.do_render(self, ctx)
ctx.save()
ctx.translate(self.x, self.y)
ctx.rectangle(0.5, 0.5, int(self._width), int(self._height)-1)
ctx.set_line_width(2)
ctx.set_dash([4.0, 2.0], 0)
ctx.set_source_rgba(0.5, 0.5, 0.5, 0.9)
ctx.stroke()
ctx.restore()
def do_render_extras(self, cr):
if self.parent and not isinstance(self.parent, MaterializedTableNode):
cr.save()
cr.set_source_rgba(0, 0, 0, 1)
if isinstance(self.parent, NestedLoopNode):
self.draw_harrow(cr, self.harrow_source[0], self.parent.harrow_target[0], self.parent.harrow_target[1])
self.render_row_count(cr, self.harrow_source[0] + 4, self.harrow_source[1] - 8)
else:
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
self.render_row_count(cr, self.varrow_source[0] + 4, self.varrow_source[1])
cr.restore()
class SubQueries(ExplainNode):
def __init__(self, context, what, nodes):
ExplainNode.__init__(self, context)
self.what = what
for n in nodes:
n.parent = self
self.children = nodes
self._figure = RectangleShapeFigure(what)
self._figure.set_line_dash([2.0, 2.0], 0)
self._figure.set_padding(8, 10, 8, 10)
self._figure.set_line_width(1)
self.add(self._figure)
def __repr__(self):
return self.what
def do_relayout(self, ctx):
VBoxFigure.do_relayout(self, ctx)
max_height = 0
total_width = 0
for child in reversed(self.children):
child.do_relayout(ctx)
child.move(total_width, self.inner_height + self._context.small_vspacing)
total_width += child.width + self._context.small_hspacing
max_height = max(max_height, child.height)
if self.children:
total_width -= self._context.small_hspacing
self._width = total_width
self._height = self.inner_height + self._context.small_vspacing + max_height
def do_render_extras(self, cr):
cr.save()
cr.set_source_rgba(0, 0, 0, 1)
self.render_cost(cr, self._figure.root_x, self._figure.root_y - 5)
if self.what in ("select_list_subqueries", "attached_subqueries"):
# parent is a QueryBlockNode or TableNode
target_x = self.parent._figure.root_x + self.parent._figure.width
self.draw_harrow(cr, self.root_x, target_x, self.harrow_source[1], -10, 6)
elif self.parent and not isinstance(self.parent, MaterializedTableNode):
self.draw_varrow(cr, self.varrow_source[0], self.varrow_source[1], self.parent.varrow_target[1])
cr.restore()
@property
def inner_height(self):
return self._figure.height
# union_result nodes are the result of merging their parent query_block node and the union_result
class UnionResult(SubQueries):
def __init__(self, context, info, queries):
SubQueries.__init__(self, context, "UNION", queries)
self.set_spacing(4)
self._figure.set_line_dash(None, None)
self._figure.set_color(0, 0, 0, 1)
self._figure.set_fill_color(0.7, 0.7, 0.7, 1)
if "table_name" in info:
self._figure_name = TextFigure(info["table_name"])
self._figure_name.set_font_size(11)
self._figure_name.set_text_color(0, 0, 0, 1)
self._figure_name.set_alignment(0.5, 0)
self.add(self._figure_name)
else:
self._figure_name = None
self.info = info
@property
def inner_height(self):
h = SubQueries.inner_height.fget(self)
if self._figure_name:
h += 4 + self._figure_name.height
return h
def set_attributes(self, attributes):
# this is called by handle_materialized_from_subquery, but the attributes don't belong
# to the UNION node, they belong to the materialized table node
pass
print attributes, self, "!!!!!!"
def get_hint_text(self):
text = "UNION Result\n"
text = """*%(table_name)s
Access Type: %(access_type)s
Using Temporary Table: %(using_temporary_table)s""" % self.info
return text
#
# JSON Explain Data Parser
#
# Takes a JSON object (bunch of dicts and lists) and turns into internal node objects
#
class ExplainContext:
default_height = 65
vspacing = 50
hspacing = 50
small_vspacing = 30
small_hspacing = 30
frame_padding = 10
global_padding = 20
def __init__(self, json, server_version):
self._json = json
self.server_version = server_version
nodes = self.process_explain_output(json)
if not nodes:
log_error("Could not process JSON data\n")
self._root = None
else:
self._root = nodes[0]
if False:
s = StringIO.StringIO()
self._root.dump(s)
print s.getvalue()
self._old_offset = None
self.overview_mode = False
self._scale = 1.0
self._offset = (0, 0)
self._extra_offset = (0, 0)
self._canvas = None
self._view = None
self.size = None
self.aggregate_costs = False
self.displayed_cost_info = None
self.cost_value_is_amount = False
def unexpected(self, node, context=""):
if context:
log_error("While parsing JSON output: unexpected node in %s: %s\n" % (context, node))
else:
log_error("While parsing JSON output: unexpected node: %s\n" % node)
def handle_table(self, table):
name = table.get("table_name", "")
materialized_from_subquery = table.get("materialized_from_subquery")
materialized_from_subquery_node = None
materialized_attributes = {}
if materialized_from_subquery:
materialized_from_subquery_node, materialized_attributes = self.handle_materialized_from_subquery("materialized_from_subquery", materialized_from_subquery)
attached_subqueries_ = table.get("attached_subqueries")
if attached_subqueries_:
attached_subqueries = self.handle_attached_subqueries("attached_subqueries", attached_subqueries_)
else:
attached_subqueries = None
if 'rows_examined_per_scan' not in table:
table['rows_examined_per_scan'] = (table.get('rows') or 0)
if 'rows_produced_per_join' not in table:
table['rows_produced_per_join'] = (table.get('rows') or 0) * int(table.get('filtered', 0)) / 100
# table nodes that have a materialized_from_subquery node are not real tables
# so show them as a container for the subquery that it executes
if materialized_from_subquery_node:
return MaterializedTableNode(self, name,
materialized_from=materialized_from_subquery_node,
materialize_attributes=materialized_attributes,
attached_subqueries=attached_subqueries, # ??
access_type=table.get('access_type', ""),
key_name=table.get('key', None),
info=table,
cost_info=table.get('cost_info'),
rows_examined=table.get('rows_examined_per_scan'),
rows_produced=table.get('rows_produced_per_join')
)
else:
return TableNode(self, name,
attached_subqueries=attached_subqueries,
access_type=table.get('access_type', ""),
key_name=table.get('key', None),
info=table,
cost_info=table.get('cost_info'),
rows_examined=table.get('rows_examined_per_scan'),
rows_produced=table.get('rows_produced_per_join')
)
def handle_nested_loop(self, data):
parts = []
for node in data:
if type(node) is dict and len(node) == 1 and 'table' in node:
table = self.handle_table(node['table'])
parts.append(table)
if len(parts) == 2:
if 'using_join_buffer' in node['table']:
join_buffer = node['table']['using_join_buffer']
else:
join_buffer = "nested_loop"
loop_node = NestedLoopNode(self, join_buffer, parts[0], parts[1])
parts = [loop_node]
elif len(parts) > 2:
raise Exception("uh oh")
elif type(node) is dict and len(node) == 1 and 'duplicates_removal' in node:
operation = self.handle_query_block('duplicates_removal', node['duplicates_removal'])
parts.append(operation)
if len(parts) == 2:
join_buffer = "nested_loop"
loop_node = NestedLoopNode(self, join_buffer, parts[0], parts[1])
parts = [loop_node]
elif len(parts) > 2:
raise Exception("uh oh")
else:
self.unexpected(node, "nested_loop")
# at the end, there should be a single node which would be the root node
assert len(parts) == 1
return parts[0]
def handle_optimized_away_subqueries(self, name, subquery_list):
subqueries = []
for data in subquery_list:
qblock = None
attributes = {}
for key, value in data.items():
if key == "query_block":
qblock = self.handle_query_block(key, value, True)
elif key in ("dependent", "cacheable", "using_temporary_table"):
attributes[key] = value
else:
self.unexpected(key, name)
qblock.set_attributes(attributes)
subqueries.append(qblock)
return SubQueries(self, name, subqueries)
def handle_attached_subqueries(self, name, subquery_list):
subqueries = []
for data in subquery_list:
qblock = None
attributes = {}
for key, value in data.items():
if key == "query_block":
qblock = self.handle_query_block(key, value, True)
elif key in ("dependent", "cacheable", "using_temporary_table"):
attributes[key] = value
elif key == "table": # handles bug #18997475
qblock = self.handle_table(value)
else:
self.unexpected(key, name)
if attributes:
qblock.set_attributes(attributes)
subqueries.append(qblock)
return SubQueries(self, name, subqueries)
def handle_materialized_from_subquery(self, name, data):
inner_qblock = None
attributes = {}
for key, value in data.items():
if key == "query_block":
inner_qblock = self.handle_query_block(key, value, is_subquery=True, is_materialized=True)
elif key in ("dependent", "cacheable", "using_temporary_table"):
attributes[key] = value
else:
self.unexpected(key, name)
return inner_qblock, attributes
def handle_union_result(self, name, data):
info = {}
qblocks = []
for key, value in data.items():
if key in ("using_temporary_table", "access_type", "table_name"):
info[key] = value
elif key == "query_specifications":
for qspec in value:
qspec.get("dependent")
qspec.get("cacheable")
qblocks.append(self.handle_query_block("query_block", qspec.get("query_block")))
else:
self.unexpected(key, name)
return UnionResult(self, info=info, queries=qblocks)
def handle_query_block(self, name, data, is_subquery=False, is_materialized=False):
# used for query_block or operation
content = None
cost_info = None
attributes = {}
select_list_subqueries = None
optimized_away_subqueries = None
for key, value in data.items():
if key == "nested_loop":
assert content is None
content = self.handle_nested_loop(value)
elif key == "table":
# in 5.6, it was possible that a query_block would have a table node with just message:"No tables used"
# that was changed in 5.7, so the useless table node would be removed
# so we do some special handling here, so that 5.6 output looks like 5.7
if "message" in value and len(value) == 1:
data["message"] = value["message"]
else:
content = self.handle_table(value)
elif key == "optimized_away_subqueries":
optimized_away_subqueries = self.handle_optimized_away_subqueries(key, value)
elif key in ("grouping_operation", "ordering_operation", "duplicates_removal"):
assert content is None
content = self.handle_query_block(key, value)
elif key in ("using_temporary_table", "using_filesort", "dependent"):
attributes[key] = value
elif key == "cost_info":
cost_info = value
elif key == "select_id":
pass
elif key == "message":
pass
elif key == "union_result":
assert content is None
# the parent query_block node seems to be redundant in this case, since it has only 1 child node
content = self.handle_union_result(key, value)
elif key == "select_list_subqueries":
# select (select ...) from ...
select_list_subqueries = self.handle_attached_subqueries(key, value)
elif key == "buffer_result":
# buffer_result is a materialized JOIN
assert content is None
content = self.handle_query_block(key, value)
else:
self.unexpected(key, name)
if name == "query_block":
if is_materialized:
return content
if is_subquery:
return SubQueryBlockNode(self,
content,
optimized_away_subqueries,
select_list_subqueries,
info=data,
cost_info=cost_info)
else:
return QueryBlockNode(self,
content,
optimized_away_subqueries,
select_list_subqueries,
info=data,
cost_info=cost_info)
elif name == "buffer_result":
return MaterializedJoinNode(self, name, content, data, cost_info, attributes)
else:
if optimized_away_subqueries:
return OperationNode(self, name, content, cost_info, attributes, optimized_away_subqueries)
else:
return OperationNode(self, name, content, cost_info, attributes)
def handle(self, data):
output = []
for key, value in data.items():
if key == "query_block":
output.append(self.handle_query_block(key, value))
return output
def process_explain_output(self, data):
return self.handle(data)
# Public interface
def dump(self):
if self._root:
s = StringIO.StringIO()
self._root.dump(s, 0)
print s.getvalue()
def _set_tooltip(self, v):
self._canvas.tooltip = v
def _get_tooltip(self):
return self._canvas.tooltip
tooltip = property(_get_tooltip, _set_tooltip)
def init_canvas(self, view, scroll, queue_repaint_cb):
self._canvas = MyCanvas(queue_repaint_cb)
self._canvas.add(self._root)
self._view = view
self._scroll = scroll
self._root._figure.set_fill_color(0.8, 0.8, 0.8, 1)
def set_offset(self, x, y):
self._offset = (x, y)
def client_to_screen(self, x, y):
x += (self._offset[0] + self._extra_offset[0])
y += (self._offset[1] + self._extra_offset[1])
return self._view.client_to_screen(int(x), int(y))
def export_to_png(self, path):
img = ImageSurface(width=self.size[0], height=self.size[1])
cr = Context(img)
self._canvas.repaint(cr, 0, 0, self.size[0], self.size[1])
img.write_to_png(path)
def layout(self, padding = 20):
c = Context(ImageSurface(width=1, height=1))
self._root.do_relayout(c)
self._root.move(self.global_padding, self.global_padding)
w, h = self._root.size
self.size = w + self.global_padding * 2, h + self.global_padding * 2
return self.size
def repaint(self, cr):
cr.translate(self._offset[0] + self._extra_offset[0], self._offset[1] + self._extra_offset[1])
cr.scale(self._scale, self._scale)
try:
self._canvas.repaint(cr, 0, 0, self.size[0], self.size[1])
if self.overview_mode:
x, y, w, h = self._overview_visible_rect
total_w, total_h = self.size
total_w = max(total_w, w)
total_h = max(total_h, h)
cr.set_line_width(1)
cr.rectangle(0, 0, total_w, total_h)
cr.new_sub_path()
cr.rectangle(x, y, w, h)
cr.set_fill_rule(cairo.CAIRO_FILL_RULE_EVEN_ODD)
cr.set_source_rgba(0, 0, 0, 0.3)
cr.fill()
cr.rectangle(x, y, w, h)
cr.set_source_rgba(0, 0, 0, 0.5)
cr.stroke()
except Exception:
import traceback
log_error("Exception repainting explain: %s\n" % traceback.format_exc())
def enter_overview_mode(self):
self._old_offset = self._offset
self._old_scale = self._scale
r = self._scroll.get_content_rect()
_, _, view_width, view_height = r
# calculate how much we have to scale to fit the whole diagram on screen
total_width, total_height = self.size
# check if whole thing already fits on screen
if total_width <= view_width and total_height <= view_height:
return
dw = float(total_width) / view_width
dh = float(total_height) / view_height
if dw > dh:
self._scale = 1/dw
else:
self._scale = 1/dh
self.overview_mode = True
self._overview_visible_rect = r
# extra offset needed to center contents
self._extra_offset = (view_width - total_width * self._scale)/2, (view_height - total_height * self._scale)/2
self._view.set_back_color("#b3b3b3")
self._view.set_size(int(view_width), int(view_height))
self._view.set_needs_repaint()
def leave_overview_mode(self):
x, y, w, h = self._overview_visible_rect
self.overview_mode = False
self._scale = self._old_scale
self._extra_offset = (0, 0)
self._view.set_back_color("#ffffff")
self._view.set_size(max(self._scroll.get_width(), self.size[0]), max(self._scroll.get_height(), self.size[1]))
self._scroll.scroll_to(x, y)
self._view.set_needs_repaint()
def mouse_moved(self, x, y):
x -= (self._offset[0] + self._extra_offset[0])
y -= (self._offset[1] + self._extra_offset[1])
x /= self._scale
y /= self._scale
total_width, total_height = self.size
xx, yy, ww, hh = self._overview_visible_rect
x -= ww / 2
y -= hh / 2
ww = min(ww, total_width)
hh = min(hh, total_height)
x = min(max(x, 0), total_width - ww)
y = min(max(y, 0), total_height - hh)
self._overview_visible_rect = int(x), int(y), ww, hh
self._view.set_needs_repaint()
def mouse_down(self, x, y):
self.leave_overview_mode()
def fmt_cost(self, value):
if self.cost_value_is_amount:
return fmt_number(value)
else:
return str(value)
def show_cost_info_type(self, name):
self.cost_value_is_amount = "data_read_per_join" == name
self.displayed_cost_info = name
def show_aggregated_cost_info(self, flag):
self.aggregate_costs = flag
def close_tooltip(self):
if self.tooltip:
self.tooltip.close()
self.tooltip = None
|