MySQL 8.0.37
Source Code Documentation
window.h
Go to the documentation of this file.
1/* Copyright (c) 2017, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef WINDOWS_INCLUDED
26#define WINDOWS_INCLUDED
27
28#include <assert.h>
29#include <sys/types.h>
30#include <cstring> // std::memcpy
31
32#include "my_inttypes.h"
33#include "sql/enum_query_type.h"
34#include "sql/handler.h"
35#include "sql/mem_root_array.h"
36#include "sql/sql_lex.h"
37#include "sql/sql_list.h"
38#include "sql/table.h"
39
40/*
41 Some Window-related symbols must be known to sql_lex.h which is a frequently
42 included header.
43 To avoid that any change to window.h causes a recompilation of the whole
44 Server, those symbols go into this header:
45*/
46#include "sql/window_lex.h"
47
48class Cached_item;
49class Item;
50class Item_func;
51class Item_string;
52class Item_sum;
53class PT_border;
54class PT_frame;
55class PT_order_list;
56class PT_window;
57class String;
58class THD;
60
61/**
62 Position hints for the frame buffer are saved for these kind of row
63 accesses, cf. #Window::m_frame_buffer_positions.
64*/
66 WONT_UPDATE_HINT = -1, // special value when using restore_special_row
68 CURRENT = 1,
70 LAST_IN_FRAME = 3,
72 MISC_POSITIONS = 5 // NTH_VALUE, LEAD/LAG have dynamic indexes 5..N
73};
74
75/**
76 The number of windows is limited to avoid the stack blowing up
77 when constructing iterators recursively. There used to be no limit, but
78 it would be unsafe since QEP_shared::m_idx of tmp tables assigned for windows
79 would exceed the old range of its type plan_idx (int8). It
80 has now been widened, so the max number of windows could be increased
81 if need be, modulo other problems. We could also make it a system variable.
82*/
83constexpr int kMaxWindows = 127;
84
85/**
86 Represents the (explicit) window of a SQL 2003 section 7.11 <window clause>,
87 or the implicit (inlined) window of a window function call, or a reference to
88 a named window in a window function call (instead of the inlined definition)
89 before resolution. After resolving referencing instances become unused,
90 having been replaced with the window resolved to in the w.f. call.
91
92 @verbatim
93 Cf. 7.11 <window definition> and <existing window name>
94 6.10 <window name or specification> and
95 <in-line window specification>
96 5.4 <window name>
97 @endverbatim
98
99 See also PT_window (which wraps Window as a parse_tree_node), and the related
100 classes PT_frame, PT_border and PT_exclusion in parse_tree_nodes.
101
102 Currently includes both prepared query and execution state information.
103 The latter is marked as such for ease of separation later.
104*/
105class Window {
106 /*------------------------------------------------------------------------
107 *
108 * Variables stable during execution
109 *
110 *------------------------------------------------------------------------*/
111 protected:
112 Query_block *m_query_block; ///< The SELECT the window is on
113 PT_order_list *const m_partition_by; ///< <window partition clause>
114 PT_order_list *const m_order_by; ///< <window order clause>
115 ORDER *m_sorting_order; ///< merged partition/order by
116 PT_frame *const m_frame; ///< <window frame clause>
117 Item_string *m_name; ///< <window name>
118 /**
119 Position of definition in query's text, 1 for leftmost. References don't
120 count. Thus, anonymous windows in SELECT list, then windows of WINDOW
121 clause, then anonymous windows in ORDER BY.
122 */
124 Item_string *const m_inherit_from; ///< <existing window name>
125 /**
126 If true, m_name is an unbound window reference, other fields
127 are unused.
128 */
129 const bool m_is_reference;
130
131 /**
132 (At least) one window function needs to buffer frame rows for evaluation
133 i.e. it cannot be evaluated on the fly just from previous rows seen
134 */
136
137 /**
138 (At least) one window function needs the peer set of the current row to
139 evaluate the wf for the current row
140 */
142
143 /**
144 (At least) one window function (currently JSON_OBJECTAGG) needs the
145 last peer for the current row to evaluate the wf for the current row.
146 (This is used only during inversion/optimization)
147 */
149
150 /**
151 (At least) one window function needs the cardinality of the partition of
152 the current row to evaluate the wf for the current row
153 */
155
156 /**
157 The functions are optimizable with ROW unit. For example SUM is, MAX is
158 not always optimizable. Optimized means we can use the optimized evaluation
159 path in process_buffered_windowing_record which uses inversion to avoid
160 revisiting all frame rows for every row being evaluated.
161 */
163
164 /**
165 The functions are optimizable with RANGE unit. For example SUM is, MAX is
166 not always optimizable. Optimized means we can use the optimized evaluation
167 path in process_buffered_windowing_record which uses inversion to avoid
168 revisiting all frame rows for every row being evaluated.
169 */
171
172 /**
173 The aggregates (SUM, etc) can be evaluated once for a partition, since it
174 is static, i.e. all rows will have the same value for the aggregates, e.g.
175 ROWS/RANGE BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING.
176 */
178
179 /**
180 Window equires re-evaluation of the first row in optimized moving frame mode
181 e.g. FIRST_VALUE.
182 */
184
185 /**
186 Window requires re-evaluation of the last row in optimized moving frame mode
187 e.g. LAST_VALUE.
188 */
190
191 /**
192 The last window to be evaluated at execution time.
193 */
194 bool m_last;
195
196 public:
197 struct st_offset {
200 st_offset() : m_rowno(0), m_from_last(false) {}
201 /**
202 Used for sorting offsets in ascending order for faster traversal of
203 frame buffer tmp file
204 */
205 bool operator<(const st_offset &a) const { return m_rowno < a.m_rowno; }
206 };
207
209 int64 m_rowno; ///< negative values is LEAD
210 st_ll_offset() : m_rowno(INT_MIN64 /* uninitialized marker*/) {}
211 /**
212 Used for sorting offsets in ascending order for faster traversal of
213 frame buffer tmp file
214 */
215 bool operator<(const st_ll_offset &a) const { return m_rowno < a.m_rowno; }
216 };
217
218 struct st_nth {
220 m_offsets; ///< sorted set of NTH_VALUE offsets
221 };
222
223 struct st_lead_lag {
225 m_offsets; ///< sorted set of LEAD/LAG offsets
226 };
227
228 protected:
229 /**
230 Window requires re-evaluation of the Nth row in optimized moving frame mode
231 e.g. NTH_VALUE.
232 */
235
236 protected:
237 const Window *m_ancestor; ///< resolved from existing window name
238 List<Item_sum> m_functions; ///< window functions based on 'this'
240 m_partition_items; ///< items for the PARTITION BY columns
242 m_order_by_items; ///< items for the ORDER BY exprs.
243
244 /*------------------------------------------------------------------------
245 *
246 * Execution state variables
247 *
248 *------------------------------------------------------------------------*/
249 public:
250 /**
251 Cardinality of m_frame_buffer_positions if no NTH_VALUE, LEAD/LAG
252 */
253 static constexpr int FRAME_BUFFER_POSITIONS_CARD =
255
256 /**
257 Holds information about a position in the buffer frame as stored in a
258 temporary file (cf. m_frame_buffer). We save a number of such positions
259 to speed up lookup when we move the window frame, cf.
260 m_frame_buffer_positions
261 */
263 ///< The size of the file position is determined by handler::ref_length
265 ///< Row number in partition, 1-based
268 : m_position(position), m_rowno(rowno) {}
269 };
270
271 /**
272 Execution state: used iff m_needs_frame_buffering. Holds pointers to
273 positions in the file in m_frame_buffer. We use these saved positions to
274 avoid having to position to the first row in the partition and then
275 making many read calls to find the desired row. By repositioning to a
276 suitably(*) saved position we normally (**) need to do only one positioned
277 read and one ha_rdn_next call to get at a desired row.
278 @verbatim
279
280 [0] the first row in the partition: at the
281 beginning of a new partition that is the first row in the partition.
282 Its rowno == 1 by definition.
283 [1] position of the current row N (for jump-back to current row or next
284 current row in combo with ha_rnd_next)
285 [2] position of the current first row M in frame (for aggregation looping
286 jump-back)
287 [3] position of the current last row in a frame
288 [4] position and line number of the row last read
289 and optionally:
290 [5..X] positions of Nth row of X-5+1 NTH_VALUE functions invoked on window
291 [X+1..Y] position of last row of lead/lag functions invoked on window
292
293 @endverbatim
294 Pointers are lazily initialized if needed.
295
296 (*) We use the position closest below the desired position, cf logic in
297 read_frame_buffer_row.
298
299 (**) Unless we have a frame beyond the current row, in which case we need
300 to do some scanning for the first row in the partition.
301 Also NTH_VALUE with RANGE might sometimes needs to read several rows, since
302 the frame start can jump several rows ahead when the current row moves
303 forward.
304 */
306
307 /**
308 Sometimes we read one row too many, so that the saved position will
309 be too far out because we subsequently need to read an earlier (previous)
310 row of the same kind (reason). For such cases, we first save the
311 current position, read, and if we see we read too far, restore the old
312 position. See #save_pos and #restore_pos.
313 */
315
316 /**
317 See #m_tmp_pos
318 */
320 int reason_index = static_cast<int>(reason);
321 m_tmp_pos.m_rowno = m_frame_buffer_positions[reason_index].m_rowno;
322 std::memcpy(m_tmp_pos.m_position,
323 m_frame_buffer_positions[reason_index].m_position,
324 frame_buffer()->file->ref_length);
325 }
326
327 /**
328 See #m_tmp_pos
329 */
331 int reason_index = static_cast<int>(reason);
332 m_frame_buffer_positions[reason_index].m_rowno = m_tmp_pos.m_rowno;
333 std::memcpy(m_frame_buffer_positions[reason_index].m_position,
334 m_tmp_pos.m_position, frame_buffer()->file->ref_length);
335 }
336
337 /**
338 Copy frame buffer position hint from one to another.
339 */
342 int from_index = static_cast<int>(from_reason);
343 int to_index = static_cast<int>(to_reason);
344 m_frame_buffer_positions[to_index].m_rowno =
345 m_frame_buffer_positions[from_index].m_rowno;
346
347 std::memcpy(m_frame_buffer_positions[to_index].m_position,
348 m_frame_buffer_positions[from_index].m_position,
349 frame_buffer()->file->ref_length);
350 }
351
352 /**
353 Keys for m_special_rows_cache, for special
354 rows (see the comment on m_special_row_cache). Note that they are negative,
355 so that they will never collide with actual row numbers in the frame.
356 This allows us to treat them interchangeably with real row numbers
357 as function arguments; e.g., bring_back_frame_row() can restore either
358 a “normal” row from the frame, or one of the special rows, and does not
359 need to take in separate flags for the two.
360 TODO(Chaithra): We have only one special key. Do we need the enum?
361 Also m_special_rows_cache/cache_length/max_cache_length should be looked
362 into.
363 */
365 /**
366 We read an incoming row. We notice it is the start of a new
367 partition. We must thus process the just-finished partition, but that
368 processing uses this row's buffer; so, we save this row first, process
369 the partition, and restore it later.
370 */
372 // Insert new values here.
373 // And keep the ones below up to date.
376 };
377
378 protected:
379 /**
380 Execution state: used iff m_needs_frame_buffering. Holds the temporary
381 file (used for the frame buffering) parameters
382 */
384
385 /**
386 Holds whether this window should be “short-circuit”, ie., goes directly
387 to the query output instead of to a temporary table.
388 */
389 bool m_short_circuit = false;
390
391 /**
392 Execution state: used iff m_needs_frame_buffering. Holds the TABLE
393 object for the the temporary file used for the frame buffering.
394 */
396
397 /**
398 Execution state: The frame buffer tmp file is not truncated for each new
399 partition. We need to keep track of where a partition starts in case we
400 need to switch from heap to innodb tmp file on overflow, in order to
401 re-initialize m_frame_buffer_positions with the current partition's row 1
402 (which is the minimum hint required) as we cross over. This number is
403 incremented for each write.
404 */
406
407 /**
408 Execution state: Snapshot of m_frame_buffer_total_rows when we start a new
409 partition, i.e. for the first row in the first partition we will have a
410 value of 1.
411 */
413
414 /**
415 If >=1: the row with this number (1-based, relative to start of
416 partition) currently has its fields in the record buffer of the IN table
417 and of the OUT table. 0 means "unset".
418 Usable only with buffering. Set and read by bring_back_frame_row(), so
419 that multiple successive calls to it for same row do only one read from
420 FB (optimization).
421 */
423
424 /**
425 Holds a fixed number of copies of special rows; each copy can use up to
426 #m_special_rows_cache_max_length bytes. Special rows are those that are
427 not part of our frame, but that we need to store away nevertheless, because
428 they might be in the table's buffers, which we need for our own purposes
429 during window processing.
430 cf. the Special_keys enumeration.
431 */
433 /// Length of each copy in #m_special_rows_cache, in bytes
435 /// Maximum allocated size in #m_special_rows_cache
437
438 /**
439 Execution state: used iff m_needs_frame_buffering. Holds the row
440 number (in the partition) of the last row (hitherto) saved in the frame
441 buffer
442 */
444
445 /**
446 Execution state: used iff m_needs_peerset. Holds the rowno
447 for the last row in this peer set.
448 */
450
451 /**
452 Execution state: used iff m_needs_last_peer_in_frame. True if a row
453 leaving the frame is the last row in the peer set within the frame.
454 */
456
457 /**
458 Execution state: the current row number in the current partition.
459 Set in check_partition_boundary. Used while reading input rows, in contrast
460 to m_rowno_in_partition, which is used when processing buffered rows.
461 Cf. check_partition_boundary.
462 */
464
465 /**
466 Execution state: the current row starts a new partition.
467 Set in check_partition_boundary.
468 */
470
471 /**
472 Execution state: The number, in the current partition, of the last output
473 row, i.e. the row number of the last row hitherto evaluated and output to
474 the next phase.
475 */
477
478 /**
479 Execution state: The number of the row being visited for its contribution
480 to a window function, relative to the start of the partition. Note that
481 this will often be different from the current row for which we are
482 processing the window function, readying it for output. That is given by
483 \c m_rowno_in_partition, q.v. Contrast also with \c m_rowno_in_frame
484 which is frame relative.
485 */
487
488 /**
489 Execution state: the row number of the row we are looking at for evaluating
490 its contribution to some window function(s). It is relative to start of
491 the frame and 1-based. It is typically set after fetching a row from the
492 frame buffer using \c bring_back_frame_row and before calling
493 \c copy_funcs. Cf. also \c m_is_last_row_in_frame.
494 */
496
497 /**
498 Execution state: The row number of the current row being readied for
499 output within the partition. 1-based.
500 In \c process_buffered_windowing_record this is known as \c current_row.
501 */
503
504 /**
505 Execution state: for optimizable aggregates, cf. m_row_optimizable and
506 m_range_optimizable, we need to keep track of when we have computed the
507 first aggregate, since aggregates for rows 2..N are computed in an optimized
508 way by inverse aggregation of the row moving out of the frame.
509 */
511
512 /*------------------------------------------------------------------------
513 *
514 * RANGE boundary frame state variables.
515 *
516 *------------------------------------------------------------------------*/
517 public:
518 /*
519 For RANGE bounds, we need to be able to check if a given row is
520 before the lower bound, or after the upper bound, as we don't know
521 ahead of time how many rows to skip (unlike for ROW bounds).
522 Often, the lower and upper bounds are the same, as they are
523 inclusive.
524
525 We solve this by having an array of comparators of the type
526
527 value ⋛ <cache>(ref_value)
528
529 where ⋛ is a three-way comparator, and <cache>(ref_value) is an
530 Item_cache where we can store the value of the reference row
531 before we invoke the comparison. For instance, if we have a
532 row bound such as
533
534 ... OVER (ORDER BY a,b) FROM t1
535
536 we will have an array with the two comparators
537
538 t1.a ⋛ <cache>(a)
539 t1.b ⋛ <cache>(b)
540
541 and when we evaluate the frame bounds for a given row, we insert
542 the reference values in the caches and then do the comparison to
543 figure out if we're before, in or after the bound. As this is a
544 lexicographic comparison, we only need to evaluate the second
545 comparator if the first one returns equality.
546
547 The expressions on the right-hand side can be somewhat more
548 complicated; say that we have a window specification like
549
550 ... OVER (ORDER BY a RANGE BETWEEN 2 PRECEDING AND 3 FOLLOWING)
551
552 In this case, the lower bound and upper bound are different
553 (both arrays will always contain only a single element):
554
555 Lower: t1.a ⋛ <cache>(a) - 2
556 Upper: t1.a ⋛ <cache>(a) + 3
557
558 ie., there is an Item_func_plus or Item_func_minus with some
559 constant expression as the second argument.
560
561 The comparators for the lower bound is stored in [0], and for
562 the upper bound in [1].
563 */
565
566 /**
567 The logical ordering index (into LogicalOrderings) needed by this window's
568 PARTITION BY and ORDER BY clauses together (if any; else, 0). Used only by
569 the hypergraph join optimizer.
570 */
572
573 /**
574 Used temporarily by the hypergraph join optimizer to mark which windows
575 are referred to by a given ordering (so that one doesn't try to satisfy
576 a window's ordering by an ordering referring to that window).
577 */
578 bool m_mark;
579
580 protected:
581 /**
582 Execution state: the row number of the first row in a frame when evaluating
583 RANGE based frame bounds. When using RANGE bounds, we don't know a priori
584 when moving the frame which row number will be the next lower bound, but
585 we know it will have to be a row number higher than the lower bound of
586 the previous frame, since the bounds increase monotonically as long
587 as the frame bounds are static within the query (current limitation).
588 So, it makes sense to remember the first row number in a frame until
589 we have determined the start of the next frame.
590
591 If the frame for the previous current row in the partition was empty (cf.
592 "current_row" in process_buffered_windowing_record), this should point
593 to the next possible frame start. Relative to partition start, 1-based.
594 */
596
597 /**
598 Execution state: used for RANGE bounds frame evaluation
599 for the continued evaluation for current row > 2 in a partition.
600 If the frame for the current row visited (cf "current_row" in
601 process_buffered_windowing_record) was empty, the invariant
602
603 m_last_rowno_in_range_frame < m_first_rowno_in_range_frame
604
605 should hold after the visit. Relative to partition start. 1-based.
606 */
608
609 /**
610 Execution state. Only used for ROWS frame optimized MIN/MAX.
611 The (1-based) number in the partition of first row in the current frame.
612 */
614
615 /*------------------------------------------------------------------------
616 *
617 * Window function special behaviour toggles. These boolean flag influence
618 * the action taken when a window function is evaluated, i.e.
619 *
620 * Item_xxx::val_xxx
621 *
622 * They are set locally just before and after a call to evaluate functions,
623 * i.e.
624 *
625 * w.set_<toggle>(true)
626 * copy_<kind>_window_functions() [see process_buffered_windowing_record]
627 * w.set_<toggle>(false)
628 *
629 * to achieve a special semantic, since we cannot pass down extra parameters.
630 *
631 *------------------------------------------------------------------------*/
632
633 /**
634 Execution state: the current row is the last row in a window frame
635 For some aggregate functions, e.g AVG, we can save computation by not
636 evaluating the entire function value before the last row has been read.
637 For AVG, do the summation for each row in the frame, but the division only
638 for the last row, at which time the result is needed for the wf.
639 Probably only useful for ROW based or static frames.
640 For frame with peer set computation, determining the last row in the
641 peer set ahead of processing is not possible, so we use a pessimistic
642 assumption.
643 */
645
646 /**
647 Execution state: make frame wf produce a NULL (or 0 depending, e.g. if
648 COUNT) value because no rows are available for aggregation: e.g. for first
649 row in partition if frame is ROWS BETWEEN 2 PRECEDING and 1 PRECEDING has
650 no rows for which aggregation can happen
651 */
653
654 /**
655 Execution state: do inverse, e.g. subtract rather than add in aggregates.
656 Used for optimizing computation of sliding frames for eligible aggregates,
657 cf. Item_sum::check_wf_semantics.
658 */
660
661 /*------------------------------------------------------------------------
662 *
663 * Constructors
664 *
665 *------------------------------------------------------------------------*/
666 private:
667 /**
668 Generic window constructor, shared
669 */
671 PT_frame *frame, bool is_reference, Item_string *inherit)
673 m_partition_by(part),
674 m_order_by(ord),
676 m_frame(frame),
677 m_name(name),
678 m_def_pos(0),
679 m_inherit_from(inherit),
682 m_needs_peerset(false),
685 m_row_optimizable(true),
687 m_static_aggregates(false),
688 m_opt_first_row(false),
689 m_opt_last_row(false),
690 m_last(false),
694 m_tmp_pos(nullptr, -1),
705 m_partition_border(true),
710 m_aggregates_primed(false),
714 m_do_copy_null(false),
715 m_inverse_aggregation(false) {
716 m_opt_nth_row.m_offsets.init_empty_const();
717 m_opt_lead_lag.m_offsets.init_empty_const();
718 m_frame_buffer_positions.init_empty_const();
719 }
720
721 public:
722 /**
723 Reference to a named window. This kind is only used before resolution,
724 references to it being replaced by the referenced window object thereafter.
725 */
727 : Window(name, nullptr, nullptr, nullptr, true, nullptr) {}
728
729 /**
730 Unnamed window. If the window turns out to be named, the name will be set
731 later, cf. #set_name().
732 */
733 Window(PT_order_list *partition_by, PT_order_list *order_by, PT_frame *frame)
734 : Window(nullptr, partition_by, order_by, frame, false, nullptr) {}
735
736 /**
737 Unnamed window based on a named window. If the window turns out to be
738 named, the name will be set later, cf. #set_name().
739 */
740 Window(PT_order_list *partition_by, PT_order_list *order_by, PT_frame *frame,
741 Item_string *inherit)
742 : Window(nullptr, partition_by, order_by, frame, false, inherit) {}
743
744 /*------------------------------------------------------------------------
745 *
746 * Methods
747 *
748 *------------------------------------------------------------------------*/
749
750 /**
751 We have a named window. Now set its name. Used once, if at all, for a
752 window as part of parsing.
753 */
755
756 /**
757 After resolving an existing window name reference in a window definition,
758 we set the ancestor pointer to easy access later.
759 */
761
762 /**
763 Get the name of a window. Can be empty, cf. #printable_name which is not.
764 */
765 Item_string *name() const { return m_name; }
766
767 uint def_pos() const { return m_def_pos; } ///< @see #m_def_pos
768 void set_def_pos(uint pos) { m_def_pos = pos; } ///< @see #m_def_pos
769
770 /**
771 Get the frame, if any. SQL 2011 7.11 GR 1.b.i.6
772 */
773 const PT_frame *frame() const { return m_frame; }
774
775 /**
776 Get the ORDER BY, if any. That is, the first we find along
777 the ancestor chain. Uniqueness checked in #setup_windows1
778 SQL 2011 7.11 GR 1.b.i.5.A-C
779 */
781 const PT_order_list *o = m_order_by;
782 const Window *w = m_ancestor;
783
784 while (o == nullptr && w != nullptr) {
785 o = w->m_order_by;
786 w = w->m_ancestor;
787 }
788 return o;
789 }
790
791 /**
792 Get the first argument of the ORDER BY clause for this window
793 if any. "ORDER BY" is not checked in ancestor unlike
794 effective_order_by().
795 Use when the goal is to operate on the set of item clauses for
796 all windows of a query. When interrogating the effective order
797 by for a window (specified for it or inherited from another
798 window) use effective_order_by().
799 */
800 ORDER *first_order_by() const;
801
802 /**
803 Get partition, if any. That is, the partition if any, of the
804 root window. SQL 2011 7.11 GR 1.b.i.4.A-C
805 */
808 const Window *w = m_ancestor;
809 while (w != nullptr) {
810 if (w->m_ancestor == nullptr) {
811 /* root */
812 p = w->m_partition_by;
813 } else {
814 /* See #setup_windows for checking */
815 assert(w->m_partition_by == nullptr);
816 }
817 w = w->m_ancestor;
818 }
819 return p;
820 }
821 /**
822 Get the first argument of the PARTITION clause for this window
823 if any. "PARTITION BY" is not checked in ancestor unlike
824 effective_partition_by().
825 Use when the goal is to operate on the set of item clauses for
826 all windows of a query. When interrogating the effective
827 partition by for a window (specified for it or inherited from
828 another window) use effective_partition_by().
829 */
830 ORDER *first_partition_by() const;
831
832 /**
833 Get the list of functions invoked on this window.
834 */
836
837 /**
838 Concatenation of columns in PARTITION BY and ORDER BY.
839 Columns present in both list (redundancies) are eliminated, while
840 making sure the order of columns in the ORDER BY is maintained
841 in the merged list.
842
843 @param thd Optional. Session state. If not nullptr,
844 initialize the cache.
845
846 @param implicit_grouping Optional. If true, we won't sort (single row
847 result set). Presence implies thd != nullptr for
848 the first call when we lazily set up this
849 information. Succeeding calls return the cached
850 value.
851
852 @returns The start of the concatenated ordering expressions, or nullptr
853 */
854 ORDER *sorting_order(THD *thd = nullptr, bool implicit_grouping = false);
855
856 /**
857 Check that the semantic requirements for window functions over this
858 window are fulfilled, and accumulate evaluation requirements.
859 This is run at resolution.
860 */
861 bool check_window_functions1(THD *thd, Query_block *select);
862 /**
863 Like check_window_functions1() but contains checks which must wait until
864 the start of the execution phase.
865 */
866 bool check_window_functions2(THD *thd);
867
868 /**
869 For RANGE frames we need to do computations involving add/subtract and
870 less than, smaller than. To make this work across types, we construct
871 item trees to do the computations, so we can reuse all the special case
872 handling, e.g. for signed/unsigned int wrap-around, overflow etc.
873 */
874 bool setup_range_expressions(THD *thd);
875
876 /**
877 Return if this window represents an unresolved window reference seen
878 in a window function OVER clause.
879 */
880 bool is_reference() const { return m_is_reference; }
881
882 /**
883 Check if the just read input row marks the start of a new partition.
884 Sets the member variables:
885
886 m_partition_border and m_part_row_number
887
888 */
890
891 /**
892 Reset the current row's ORDER BY expressions when starting a new
893 peer set.
894 */
896
897 /**
898 Determine if the current row is not in the same peer set as the previous
899 row. Used for RANGE frame and implicit RANGE frame (the latter is used by
900 aggregates in the presence of ORDER BY).
901
902 The current row is in the same peer set if all ORDER BY columns
903 have the same value as in the previous row.
904
905 For JSON_OBJECTAGG only the first order by column needs to be
906 compared to check if a row is in peer set.
907
908 @param compare_all_order_by_items If true, compare all the order by items
909 to determine if a row is in peer set.
910 Else, compare only the first order by
911 item to determine peer set.
912
913 @return true if current row is in a new peer set
914 */
915 bool in_new_order_by_peer_set(bool compare_all_order_by_items = true);
916
917 /**
918 While processing buffered rows in RANGE frame mode we, determine
919 if the present row revisited from the buffer is before the row
920 being processed; i.e. the current row.
921
922 @return true if the present row is before the RANGE, i.e. not to
923 be included
924 */
925 bool before_frame() { return before_or_after_frame(true); }
926
927 ///< See before_frame()
928 bool after_frame() { return before_or_after_frame(false); }
929
930 /**
931 Check if we have read all the rows in a partition, possibly
932 having buffered them for further processing
933
934 @returns true if this is the case
935 */
937
938 void save_special_row(uint64 special_rowno, TABLE *t);
939 void restore_special_row(uint64 special_rowno, uchar *record);
940
941 /**
942 Resolve any named window to its definition
943 and update m_window to point to the definition instead
944 */
945 static bool resolve_reference(THD *thd, Item_sum *wf, PT_window **m_window);
946
947 /**
948 Semantic checking of windows. Run at resolution.
949
950 * Process any window inheritance, that is a window, that in its
951 specification refer to another named window.
952
953 Rules:
954 1) There should be no loops
955 2) The inheriting window can not specify partitioning
956 3) The inheriting window can not specify is already specify by
957 an ancestor.
958 4) An ancestor can not specify window framing clause.
959
960 Cf. SQL 2011 7.11 window clause SR 10-11.
961
962 * Check requirements to the window from its using window functions and
963 make a note of those so we know at execution time, for example if we need
964 to buffer rows to process the window functions, whether inversion
965 optimzation will be used for moving frames etc.
966
967 * Prepare the physical ordering lists used by sorting at execution time.
968
969 * Set up cached items for partition determination and for range/peer
970 determination based on order by columns.
971
972 * Check any frame semantics and for RANGE frames, set up bounds computation
973 item trees.
974
975 @param thd The session's execution thread
976 @param select The select for which we are doing windowing
977 @param ref_item_array The base ref items
978 @param tables The list of tables involved
979 @param fields The list of all fields, including hidden ones
980 @param windows The list of windows defined for this select
981
982 @return false if success, true if error
983 */
984 static bool setup_windows1(THD *thd, Query_block *select,
985 Ref_item_array ref_item_array, Table_ref *tables,
987 List<Window> *windows);
988 /**
989 Like setup_windows1() but contains operations which must wait until
990 the start of the execution phase.
991
992 @param thd The session's execution thread
993 @param windows The list of windows defined for this select
994
995 @return false if success, true if error
996 */
997 static bool setup_windows2(THD *thd, List<Window> *windows);
998
999 /**
1000 Check window definitions to remove unused windows. We do this
1001 only after syntactic and semantic checking for errors has been performed.
1002 Eliminate redundant sorts after unused windows are removed.
1003
1004 @param windows The list of windows defined for this select
1005 */
1006 static void eliminate_unused_objects(List<Window> *windows);
1007
1008 /**
1009 Resolve and set up the PARTITION BY or an ORDER BY list of a window.
1010
1011 @param thd The session's execution thread
1012 @param ref_item_array The base ref items
1013 @param tables The list of tables involved
1014 @param fields The list of all fields, including hidden ones
1015 @param o A list of order by expressions
1016 @param partition_order If true, o represent a windowing PARTITION BY,
1017 else it represents a windowing ORDER BY
1018 @returns false if success, true if error
1019 */
1020 bool resolve_window_ordering(THD *thd, Ref_item_array ref_item_array,
1021 Table_ref *tables,
1022 mem_root_deque<Item *> *fields, ORDER *o,
1023 bool partition_order);
1024 /**
1025 Return true if this window's name is not unique in windows
1026 */
1027 bool check_unique_name(const List<Window> &windows);
1028
1029 /**
1030 Specify that this window is to be evaluated after a given
1031 temporary table. This means that all expressions that have been
1032 materialized (as given by items_to_copy) will be replaced with the
1033 given temporary table fields. (If there are multiple materializations,
1034 this function must be called for each of them in order.)
1035
1036 Only the hypergraph join optimizer uses this currently; the old
1037 join optimizer instead uses Item_ref objects that point to the
1038 base slice, which is then replaced at runtime depending on which
1039 temporary table we are to evaluate from.
1040 */
1041 void apply_temp_table(THD *thd, const Func_ptr_array &items_to_copy);
1042
1043 /**
1044 Set up cached items for an partition or an order by list
1045 updating m_partition_items or m_order_by_items respectively.
1046
1047 @param thd The session's execution thread
1048 @param select The select for which we are doing windowing
1049 @param o The list of ordering expressions
1050 @param partition_order If true, o represents a partition order list,
1051 else an ORDER BY list.
1052
1053 @returns false if success, true if error
1054 */
1055 bool setup_ordering_cached_items(THD *thd, Query_block *select,
1056 const PT_order_list *o,
1057 bool partition_order);
1058
1059 /**
1060 Determine if the window had either a partition clause (inclusive) or a
1061 ORDER BY clause, either defined by itself or inherited from another window.
1062
1063 @return true if we have such a clause, which means we need to sort the
1064 input table before evaluating the window functions, unless it has
1065 been made redundant by a previous windowing step, cf.
1066 reorder_and_eliminate_sorts, or due to a single row result set,
1067 cf. Query_block::is_implicitly_grouped().
1068 */
1069 bool needs_sorting() const { return m_sorting_order != nullptr; }
1070
1071 /**
1072 If we cannot compute one of window functions without looking at succeeding
1073 rows, return true, else false.
1074 */
1076
1077 /**
1078 If we cannot compute one of window functions without looking at all
1079 rows in the peerset of the current row, return true, else
1080 false. E.g. CUME_DIST.
1081 */
1082 bool needs_peerset() const { return m_needs_peerset; }
1083
1084 /**
1085 If we cannot compute one of window functions without looking at all
1086 rows in the peerset of the current row in this frame, return true, else
1087 false. E.g. JSON_OBJECTAGG.
1088 */
1090 /**
1091 If we need to read the entire partition before we can evaluate
1092 some window function(s) on this window,
1093 @returns true if that is the case, else false
1094 */
1097 }
1098
1099 /**
1100 Return true if the set of window functions are all ROW unit optimizable.
1101 Only relevant if m_needs_buffering and m_row_optimizable are true.
1102 */
1104
1105 /**
1106 Return true if the set of window functions are all RANGE unit optimizable.
1107 Only relevant if m_needs_buffering and m_range_optimizable are true.
1108 */
1110
1111 /**
1112 Return true if the aggregates are static, i.e. the same aggregate values for
1113 all rows in partition. Only relevant if m_needs_buffering is true.
1114 */
1116
1117 /**
1118 See #m_opt_first_row
1119 */
1120 bool opt_first_row() const { return m_opt_first_row; }
1121
1122 /**
1123 See #m_opt_last_row
1124 */
1125 bool opt_last_row() const { return m_opt_last_row; }
1126
1127 /**
1128 See #m_last
1129 */
1130 bool is_last() const { return m_last; }
1131
1132 /**
1133 An override used by the hypergraph join optimizer only.
1134 */
1135 void set_is_last(bool last) { m_last = last; }
1136
1137 /**
1138 See #m_opt_nth_row
1139 */
1140 const st_nth &opt_nth_row() const { return m_opt_nth_row; }
1141
1142 /**
1143 See #m_opt_lead_lag
1144 */
1145 const st_lead_lag &opt_lead_lag() const { return m_opt_lead_lag; }
1146
1147 /**
1148 Getter for m_frame_buffer_param, q.v.
1149 */
1151
1152 /**
1153 Setter for m_frame_buffer_param, q.v.
1154 */
1156
1157 /**
1158 Getter for m_frame_buffer, q.v.
1159 */
1160 TABLE *frame_buffer() const { return m_frame_buffer; }
1161
1162 /**
1163 Setter for m_frame_buffer, q.v.
1164 */
1166
1167 bool short_circuit() const { return m_short_circuit; }
1170 }
1171
1172 /**
1173 Getter for m_part_row_number, q.v., the current row number within the
1174 partition.
1175 */
1177
1178 /**
1179 Allocate the cache for special rows
1180 @param thd thread handle
1181 @param out_tbl The table where this window function's value is written to
1182 @returns true if error.
1183 */
1184 bool make_special_rows_cache(THD *thd, TABLE *out_tbl);
1185
1186 /**
1187 See #m_last_row_output
1188 */
1190
1191 /**
1192 See #m_last_row_output
1193 */
1195
1196 /**
1197 See #m_rowno_being_visited
1198 */
1200
1201 /**
1202 See #m_rowno_being_visited
1203 */
1205
1206 /**
1207 See #m_last_rowno_in_cache
1208 */
1210
1211 /**
1212 See #m_last_rowno_in_cache
1213 */
1215
1216 /**
1217 See #m_last_rowno_in_range_frame
1218 */
1221 }
1222
1223 /**
1224 See #m_last_rowno_in_range_frame
1225 */
1228 }
1229
1230 /**
1231 See #m_last_rowno_in_peerset
1232 */
1234
1235 /**
1236 See #m_last_rowno_in_peerset
1237 */
1239
1240 /**
1241 See #m_is_last_row_in_peerset_within_frame
1242 */
1245 }
1246
1247 /**
1248 See #m_is_last_row_in_peerset_within_frame
1249 */
1252 }
1253
1254 /**
1255 See #m_do_copy_null
1256 */
1257 bool do_copy_null() const { return m_do_copy_null; }
1258
1259 /**
1260 See #m_do_copy_null
1261 */
1262 void set_do_copy_null(bool b) { m_do_copy_null = b; }
1263
1264 /**
1265 See #m_inverse_aggregation
1266 */
1267 bool do_inverse() const { return m_inverse_aggregation; }
1268
1269 /**
1270 See #m_inverse_aggregation
1271 */
1274 return *this;
1275 }
1276
1277 /**
1278 See #m_aggregates_primed
1279 */
1281
1282 /**
1283 See #m_aggregates_primed
1284 */
1286
1287 /**
1288 See #m_is_last_row_in_frame
1289 */
1291 return m_is_last_row_in_frame || m_query_block->m_table_list.elements == 0;
1292 }
1293
1294 /**
1295 See #m_is_last_row_in_frame
1296 */
1298
1299 /**
1300 Return the size of the frame in number of rows
1301 @returns frame size
1302 */
1303 // int64 frame_cardinality();
1304
1305 /**
1306 See #m_rowno_in_frame
1307 */
1309
1310 /**
1311 See #m_rowno_in_frame
1312 */
1314 m_rowno_in_frame = rowno;
1315 return *this;
1316 }
1317
1318 /**
1319 See #m_rowno_in_partition
1320 */
1322
1323 /**
1324 See #m_rowno_in_partition
1325 */
1327
1328 /**
1329 See #m_first_rowno_in_rows_frame
1330 */
1333 }
1334
1337 }
1338
1339 /**
1340 See #m_first_rowno_in_range_frame
1341 */
1344 }
1345
1346 /**
1347 See #m_first_rowno_in_range_frame
1348 */
1351 }
1352
1353 /**
1354 See #m_frame_buffer_total_rows
1355 */
1358 }
1359
1360 /**
1361 See #m_frame_buffer_total_rows
1362 */
1364
1365 /**
1366 See #m_frame_buffer_partition_offset
1367 */
1370 }
1371
1372 /**
1373 See #m_frame_buffer_partition_offset
1374 */
1377 }
1378
1379 /**
1380 See #m_row_has_fields_in_out_table
1381 */
1384 }
1385
1386 /**
1387 See #m_row_has_fields_in_out_table
1388 */
1391 }
1392
1393 /**
1394 Free up any resource used to process the window functions of this window,
1395 e.g. temporary files and in-memory data structures. Called when done
1396 with all window processing steps from Query_block::cleanup.
1397 */
1398 void cleanup();
1399
1400 /**
1401 Free structures that were set up during preparation of window functions
1402 */
1403 void destroy();
1404
1405 /**
1406 Reset window state for a new partition.
1407
1408 Reset the temporary storage used for window frames, typically when we find
1409 a new partition. The rows in the buffer are then no longer needed.
1410 */
1412
1413 /**
1414 Reset execution state for next call to JOIN::exec, cf. JOIN::reset,
1415 or using [Buffering]WindowingIterator::Init.
1416 */
1418
1419 /**
1420 Reset execution state for LEAD/LAG for the current row in partition.
1421 */
1422 void reset_lead_lag();
1423
1424 private:
1426
1427 /// Common function for all types of resetting
1429
1430 public:
1431 /**
1432 Reset the execution state for all window functions defined on this window.
1433 */
1434 void reset_all_wf_state();
1435
1436 const char *printable_name() const;
1437
1438 void print(const THD *thd, String *str, enum_query_type qt,
1439 bool expand_definition) const;
1440
1441 bool has_windowing_steps() const;
1442
1443 /**
1444 Compute sorting costs for windowing.
1445
1446 @param cost Cost of sorting result set once
1447 @param windows The set of windows
1448
1449 @returns the aggregated sorting costs of the windowing
1450 */
1451 static double compute_cost(double cost, const List<Window> &windows);
1452
1453 private:
1454 /**
1455 Common implementation of before_frame() and after_frame().
1456 @param before True if 'before' is wanted; false if 'after' is.
1457 */
1458 bool before_or_after_frame(bool before);
1459 void print_frame(const THD *thd, String *str, enum_query_type qt) const;
1460 void print_border(const THD *thd, String *str, PT_border *b,
1461 enum_query_type qt) const;
1462
1463 /**
1464 Reorder windows and eliminate redundant ordering. If a window has the
1465 same ordering requirements as another, we will move them next to each other
1466 in the evaluation sequence, so we can sort only once, i.e. before the
1467 first window step. This allows us to fulfill the guarantee given by
1468 SQL standard when it comes to repeatability of non-deterministic (partially
1469 ordered) result sets for windowing inside a query, cf. #equal_sort.
1470 If more than two have the same ordering, the same applies, we only sort
1471 before the first (sort equivalent) window. The hypergraph optimizer uses
1472 the interesting order framework instead, eliding all sorts eliminated by
1473 this function and possibly more.
1474
1475 Note that we do not merge windows that have the same ordering requirements,
1476 so we may still get the extra materialization and multiple rounds of
1477 buffering. Yet, we should get _correctness_, as long as materialization
1478 preserves row ordering (which it does for all of our supported temporary
1479 table types).
1480
1481 If the result set is implicitly grouped, we also skip any sorting for
1482 windows.
1483
1484 @param windows list of windows
1485 */
1486 static void reorder_and_eliminate_sorts(List<Window> *windows);
1487
1488 /**
1489 Return true of the physical[1] sort orderings for the two windows are the
1490 same, cf. guarantee of
1491 SQL 2014 4.15.15 Windowed tables bullet two: The windowing functions are
1492 computed using the same row ordering if they specify the same ordering.
1493
1494 Collation and null handling is not supported, so moot.
1495
1496 The two other bullet points are also covered by this test.
1497
1498 [1] After concatenating effective PARTITION BY and ORDER BY (including
1499 inheritance) expressions.
1500 */
1501 static bool equal_sort(Window *w1, Window *w2);
1502
1503 /**
1504 Check that a frame border is constant during execution and that it does
1505 not contain subqueries (relevant for INTERVAL only): implementation
1506 limitation.
1507
1508 @param thd Session thread
1509 @param border The border to check
1510
1511 @return false if OK, true if error
1512 */
1513 bool check_constant_bound(THD *thd, PT_border *border);
1514
1515 /**
1516 Check that frame borders are sane; resolution phase.
1517
1518 @param thd Session thread
1519
1520 @returns true if error
1521 */
1522 bool check_border_sanity1(THD *thd);
1523 /**
1524 Like check_border_sanity1() but contains checks which must wait until
1525 the start of the execution phase.
1526
1527 @param thd Session thread
1528
1529 @returns true if error
1530 */
1531 bool check_border_sanity2(THD *thd);
1532};
1533
1534/**
1535 Collects evaluation requirements from a window function,
1536 used by Item_sum::check_wf_semantics and its overrides.
1537*/
1539 /**
1540 Set to true if window function requires row buffering
1541 */
1543 /**
1544 Set to true if we need peerset for evaluation (e.g. CUME_DIST)
1545 */
1547 /**
1548 Set to true if we need last peer for evaluation within a frame
1549 (e.g. JSON_OBJECTAGG)
1550 */
1552 /**
1553 Set to true if we need FIRST_VALUE or optimized MIN/MAX
1554 */
1556 /**
1557 Set to true if we need LAST_VALUE or optimized MIN/MAX
1558 */
1560 Window::st_offset opt_nth_row; ///< Used if we have NTH_VALUE
1561 Window::st_ll_offset opt_ll_row; ///< Used if we have LEAD or LAG
1562 /**
1563 Set to true if we can compute a sliding window by a combination of
1564 undoing the contribution of rows going out of the frame and adding the
1565 contribution of rows coming into the frame. For example, SUM and AVG
1566 allows this, but MAX/MIN do not. Only applicable if the frame has ROW
1567 bounds unit.
1568 */
1570 /**
1571 Similar to row_optimizable but for RANGE frame bounds unit
1572 */
1574
1576 : needs_buffer(false),
1577 needs_peerset(false),
1579 opt_first_row(false),
1580 opt_last_row(false),
1581 row_optimizable(true),
1582 range_optimizable(true) {}
1583};
1584
1585#endif /* WINDOWS_INCLUDED */
A wrapper class which provides array bounds checking.
Definition: sql_array.h:47
This is used for segregating rows in groups (e.g.
Definition: item.h:6340
Definition: item_func.h:102
Definition: item.h:5262
Class Item_sum is the base class used for special expressions that SQL calls 'set functions'.
Definition: item_sum.h:399
Base class that is used to represent any kind of expression in a relational query.
Definition: item.h:851
Definition: sql_list.h:434
A typesafe replacement for DYNAMIC_ARRAY.
Definition: mem_root_array.h:61
A typesafe replacement for DYNAMIC_ARRAY.
Definition: mem_root_array.h:426
Parse tree node for a single of a window extent's borders, cf.
Definition: parse_tree_nodes.h:1243
Parse tree node for a window's frame, cf.
Definition: parse_tree_nodes.h:1322
Definition: parse_tree_nodes.h:214
Parse tree node for a window; just a shallow wrapper for class Window, q.v.
Definition: parse_tree_window.h:39
This class represents a query block, aka a query specification, which is a query consisting of a SELE...
Definition: sql_lex.h:1156
SQL_I_List< Table_ref > m_table_list
List of tables in FROM clause - use Table_ref::next_local to traverse.
Definition: sql_lex.h:1897
Using this class is fraught with peril, and you need to be very careful when doing so.
Definition: sql_string.h:168
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_lexer_thd.h:34
Definition: table.h:2790
Object containing parameters used when creating and using temporary tables.
Definition: temp_table_param.h:95
Represents the (explicit) window of a SQL 2003 section 7.11 <window clause>, or the implicit (inlined...
Definition: window.h:105
static bool equal_sort(Window *w1, Window *w2)
Return true of the physical[1] sort orderings for the two windows are the same, cf.
Definition: window.cc:736
int64 rowno_in_partition() const
See m_rowno_in_partition.
Definition: window.h:1321
Item_string *const m_inherit_from
<existing window name>
Definition: window.h:124
bool m_is_last_row_in_frame
Execution state: the current row is the last row in a window frame For some aggregate functions,...
Definition: window.h:644
bool m_row_optimizable
The functions are optimizable with ROW unit.
Definition: window.h:162
bool check_border_sanity2(THD *thd)
Like check_border_sanity1() but contains checks which must wait until the start of the execution phas...
Definition: window.cc:875
const bool m_is_reference
If true, m_name is an unbound window reference, other fields are unused.
Definition: window.h:129
bool needs_last_peer_in_frame() const
If we cannot compute one of window functions without looking at all rows in the peerset of the curren...
Definition: window.h:1089
void reset_order_by_peer_set()
Reset the current row's ORDER BY expressions when starting a new peer set.
Definition: window.cc:507
int64 last_rowno_in_range_frame() const
See m_last_rowno_in_range_frame.
Definition: window.h:1219
bool before_or_after_frame(bool before)
Common implementation of before_frame() and after_frame().
Definition: window.cc:540
void reset_all_wf_state()
Reset the execution state for all window functions defined on this window.
Definition: window.cc:1507
void apply_temp_table(THD *thd, const Func_ptr_array &items_to_copy)
Specify that this window is to be evaluated after a given temporary table.
Definition: window.cc:1528
bool in_new_order_by_peer_set(bool compare_all_order_by_items=true)
Determine if the current row is not in the same peer set as the previous row.
Definition: window.cc:528
bool opt_last_row() const
See m_opt_last_row.
Definition: window.h:1125
int64 m_rowno_in_partition
Execution state: The row number of the current row being readied for output within the partition.
Definition: window.h:502
void set_last_rowno_in_range_frame(uint64 rno)
See m_last_rowno_in_range_frame.
Definition: window.h:1226
void set_def_pos(uint pos)
Definition: window.h:768
Window & set_rowno_in_frame(int64 rowno)
See m_rowno_in_frame.
Definition: window.h:1313
int64 m_first_rowno_in_range_frame
Execution state: the row number of the first row in a frame when evaluating RANGE based frame bounds.
Definition: window.h:595
void reset_partition_state()
Reset window state for a new partition.
Definition: window.h:1411
Item_string * m_name
<window name>
Definition: window.h:117
Frame_buffer_position m_tmp_pos
Sometimes we read one row too many, so that the saved position will be too far out because we subsequ...
Definition: window.h:314
bool static_aggregates() const
Return true if the aggregates are static, i.e.
Definition: window.h:1115
int64 first_rowno_in_range_frame() const
See m_first_rowno_in_range_frame.
Definition: window.h:1349
bool after_frame()
Definition: window.h:928
int64 m_row_has_fields_in_out_table
If >=1: the row with this number (1-based, relative to start of partition) currently has its fields i...
Definition: window.h:422
void copy_pos(Window_retrieve_cached_row_reason from_reason, Window_retrieve_cached_row_reason to_reason)
Copy frame buffer position hint from one to another.
Definition: window.h:340
int64 m_frame_buffer_partition_offset
Execution state: Snapshot of m_frame_buffer_total_rows when we start a new partition,...
Definition: window.h:412
bool resolve_window_ordering(THD *thd, Ref_item_array ref_item_array, Table_ref *tables, mem_root_deque< Item * > *fields, ORDER *o, bool partition_order)
Resolve and set up the PARTITION BY or an ORDER BY list of a window.
Definition: window.cc:673
void restore_special_row(uint64 special_rowno, uchar *record)
Restore row special_rowno into record from in-memory copy.
Definition: window_iterators.cc:506
void set_row_has_fields_in_out_table(int64 rowno)
See m_row_has_fields_in_out_table.
Definition: window.h:1389
bool m_needs_peerset
(At least) one window function needs the peer set of the current row to evaluate the wf for the curre...
Definition: window.h:141
ORDER * m_sorting_order
merged partition/order by
Definition: window.h:115
const st_nth & opt_nth_row() const
See m_opt_nth_row.
Definition: window.h:1140
void set_first_rowno_in_range_frame(int64 rowno)
See m_first_rowno_in_range_frame.
Definition: window.h:1342
const Window * m_ancestor
resolved from existing window name
Definition: window.h:237
uint m_def_pos
Position of definition in query's text, 1 for leftmost.
Definition: window.h:123
Temp_table_param * m_frame_buffer_param
Execution state: used iff m_needs_frame_buffering.
Definition: window.h:383
const st_lead_lag & opt_lead_lag() const
See m_opt_lead_lag.
Definition: window.h:1145
bool aggregates_primed() const
See m_aggregates_primed.
Definition: window.h:1280
int64 row_has_fields_in_out_table() const
See m_row_has_fields_in_out_table.
Definition: window.h:1382
int64 m_is_last_row_in_peerset_within_frame
Execution state: used iff m_needs_last_peer_in_frame.
Definition: window.h:455
bool make_special_rows_cache(THD *thd, TABLE *out_tbl)
Allocate the cache for special rows.
Definition: window.cc:1320
size_t m_special_rows_cache_length[FBC_FIRST_KEY - FBC_LAST_KEY+1]
Length of each copy in m_special_rows_cache, in bytes.
Definition: window.h:434
void set_short_circuit(bool short_circuit)
Definition: window.h:1168
const PT_frame * frame() const
Get the frame, if any.
Definition: window.h:773
int64 m_part_row_number
Execution state: the current row number in the current partition.
Definition: window.h:463
PT_order_list *const m_order_by
<window order clause>
Definition: window.h:114
bool check_border_sanity1(THD *thd)
Check that frame borders are sane; resolution phase.
Definition: window.cc:802
int64 rowno_in_frame() const
Return the size of the frame in number of rows.
Definition: window.h:1308
static bool resolve_reference(THD *thd, Item_sum *wf, PT_window **m_window)
Resolve any named window to its definition and update m_window to point to the definition instead.
Definition: window.cc:428
void set_frame_buffer_param(Temp_table_param *p)
Setter for m_frame_buffer_param, q.v.
Definition: window.h:1155
bool short_circuit() const
Definition: window.h:1167
void set_frame_buffer(TABLE *tab)
Setter for m_frame_buffer, q.v.
Definition: window.h:1165
int64 frame_buffer_total_rows() const
See m_frame_buffer_total_rows.
Definition: window.h:1363
const PT_order_list * effective_partition_by() const
Get partition, if any.
Definition: window.h:806
Window(Item_string *name)
Reference to a named window.
Definition: window.h:726
bool needs_buffering() const
If we cannot compute one of window functions without looking at succeeding rows, return true,...
Definition: window.h:1075
int64 m_frame_buffer_total_rows
Execution state: The frame buffer tmp file is not truncated for each new partition.
Definition: window.h:405
bool check_window_functions2(THD *thd)
Like check_window_functions1() but contains checks which must wait until the start of the execution p...
Definition: window.cc:1275
bool m_do_copy_null
Execution state: make frame wf produce a NULL (or 0 depending, e.g.
Definition: window.h:652
bool m_opt_first_row
Window equires re-evaluation of the first row in optimized moving frame mode e.g.
Definition: window.h:183
bool m_inverse_aggregation
Execution state: do inverse, e.g.
Definition: window.h:659
bool m_range_optimizable
The functions are optimizable with RANGE unit.
Definition: window.h:170
bool m_static_aggregates
The aggregates (SUM, etc) can be evaluated once for a partition, since it is static,...
Definition: window.h:177
bool setup_ordering_cached_items(THD *thd, Query_block *select, const PT_order_list *o, bool partition_order)
Set up cached items for an partition or an order by list updating m_partition_items or m_order_by_ite...
Definition: window.cc:644
bool check_window_functions1(THD *thd, Query_block *select)
Check that the semantic requirements for window functions over this window are fulfilled,...
Definition: window.cc:121
Window(PT_order_list *partition_by, PT_order_list *order_by, PT_frame *frame)
Unnamed window.
Definition: window.h:733
static void eliminate_unused_objects(List< Window > *windows)
Check window definitions to remove unused windows.
Definition: window.cc:1024
bool check_unique_name(const List< Window > &windows)
Return true if this window's name is not unique in windows.
Definition: window.cc:629
ORDER * first_order_by() const
Get the first argument of the ORDER BY clause for this window if any.
Definition: window.cc:117
bool is_last_row_in_frame() const
See m_is_last_row_in_frame.
Definition: window.h:1290
void set_is_last_row_in_peerset_within_frame(bool value)
See m_is_last_row_in_peerset_within_frame.
Definition: window.h:1250
bool opt_first_row() const
See m_opt_first_row.
Definition: window.h:1120
bool m_needs_partition_cardinality
(At least) one window function needs the cardinality of the partition of the current row to evaluate ...
Definition: window.h:154
void set_name(Item_string *name)
We have a named window.
Definition: window.h:754
uchar * m_special_rows_cache
Holds a fixed number of copies of special rows; each copy can use up to m_special_rows_cache_max_leng...
Definition: window.h:432
static constexpr int FRAME_BUFFER_POSITIONS_CARD
Cardinality of m_frame_buffer_positions if no NTH_VALUE, LEAD/LAG.
Definition: window.h:253
static double compute_cost(double cost, const List< Window > &windows)
Compute sorting costs for windowing.
Definition: window.cc:1521
void set_is_last(bool last)
An override used by the hypergraph join optimizer only.
Definition: window.h:1135
int64 m_rowno_being_visited
Execution state: The number of the row being visited for its contribution to a window function,...
Definition: window.h:486
int64 first_rowno_in_rows_frame() const
Definition: window.h:1335
bool at_partition_border() const
Check if we have read all the rows in a partition, possibly having buffered them for further processi...
Definition: window.h:936
bool m_needs_last_peer_in_frame
(At least) one window function (currently JSON_OBJECTAGG) needs the last peer for the current row to ...
Definition: window.h:148
bool m_last
The last window to be evaluated at execution time.
Definition: window.h:194
void set_first_rowno_in_rows_frame(int64 rowno)
See m_first_rowno_in_rows_frame.
Definition: window.h:1331
const PT_order_list * effective_order_by() const
Get the ORDER BY, if any.
Definition: window.h:780
int64 m_rowno_in_frame
Execution state: the row number of the row we are looking at for evaluating its contribution to some ...
Definition: window.h:495
bool m_aggregates_primed
Execution state: for optimizable aggregates, cf.
Definition: window.h:510
Window(PT_order_list *partition_by, PT_order_list *order_by, PT_frame *frame, Item_string *inherit)
Unnamed window based on a named window.
Definition: window.h:740
Mem_root_array< Cached_item * > m_order_by_items
items for the ORDER BY exprs.
Definition: window.h:242
void set_ancestor(Window *a)
After resolving an existing window name reference in a window definition, we set the ancestor pointer...
Definition: window.h:760
void set_last_row_output(int64 rno)
See m_last_row_output.
Definition: window.h:1194
void save_special_row(uint64 special_rowno, TABLE *t)
Save row special_rowno in table t->record[0] to an in-memory copy for later restoration.
Definition: window_iterators.cc:488
int64 is_last_row_in_peerset_within_frame() const
See m_is_last_row_in_peerset_within_frame.
Definition: window.h:1243
bool needs_sorting() const
Determine if the window had either a partition clause (inclusive) or a ORDER BY clause,...
Definition: window.h:1069
st_lead_lag m_opt_lead_lag
Definition: window.h:234
bool before_frame()
While processing buffered rows in RANGE frame mode we, determine if the present row revisited from th...
Definition: window.h:925
void save_pos(Window_retrieve_cached_row_reason reason)
See m_tmp_pos.
Definition: window.h:319
int64 last_row_output() const
See m_last_row_output.
Definition: window.h:1189
bool setup_range_expressions(THD *thd)
For RANGE frames we need to do computations involving add/subtract and less than, smaller than.
Definition: window.cc:240
bool m_short_circuit
Holds whether this window should be “short-circuit”, ie., goes directly to the query output instead o...
Definition: window.h:389
void set_last_rowno_in_peerset(uint64 rno)
See m_last_rowno_in_peerset.
Definition: window.h:1238
Item_string * name() const
Get the name of a window.
Definition: window.h:765
int64 partition_rowno() const
Getter for m_part_row_number, q.v., the current row number within the partition.
Definition: window.h:1176
Query_block * m_query_block
The SELECT the window is on.
Definition: window.h:112
void reset_execution_state(Reset_level level)
Common function for all types of resetting.
Definition: window.cc:1371
ORDER * first_partition_by() const
Get the first argument of the PARTITION clause for this window if any.
Definition: window.cc:113
bool do_inverse() const
See m_inverse_aggregation.
Definition: window.h:1267
int64 m_first_rowno_in_rows_frame
Execution state.
Definition: window.h:613
void destroy()
Free structures that were set up during preparation of window functions.
Definition: window.cc:1350
static bool setup_windows1(THD *thd, Query_block *select, Ref_item_array ref_item_array, Table_ref *tables, mem_root_deque< Item * > *fields, List< Window > *windows)
Semantic checking of windows.
Definition: window.cc:1090
void set_rowno_being_visited(int64 rno)
See m_rowno_being_visited.
Definition: window.h:1204
size_t m_special_rows_cache_max_length
Maximum allocated size in m_special_rows_cache.
Definition: window.h:436
TABLE * frame_buffer() const
Getter for m_frame_buffer, q.v.
Definition: window.h:1160
const char * printable_name() const
Definition: window.cc:1500
TABLE * m_frame_buffer
Execution state: used iff m_needs_frame_buffering.
Definition: window.h:395
bool do_copy_null() const
See m_do_copy_null.
Definition: window.h:1257
Window & set_inverse(bool b)
See m_inverse_aggregation.
Definition: window.h:1272
void cleanup()
Free up any resource used to process the window functions of this window, e.g.
Definition: window.cc:1335
bool is_reference() const
Return if this window represents an unresolved window reference seen in a window function OVER clause...
Definition: window.h:880
bool m_partition_border
Execution state: the current row starts a new partition.
Definition: window.h:469
List< Item_sum > & functions()
Get the list of functions invoked on this window.
Definition: window.h:835
int64 m_last_rowno_in_peerset
Execution state: used iff m_needs_peerset.
Definition: window.h:449
void set_last_rowno_in_cache(uint64 rno)
See m_last_rowno_in_cache.
Definition: window.h:1214
void reset_lead_lag()
Reset execution state for LEAD/LAG for the current row in partition.
Definition: window.cc:1362
Temp_table_param * frame_buffer_param() const
Getter for m_frame_buffer_param, q.v.
Definition: window.h:1150
void reset_round()
Reset execution state for next call to JOIN::exec, cf.
Definition: window.h:1417
void set_frame_buffer_partition_offset(int64 offset)
See m_frame_buffer_partition_offset.
Definition: window.h:1368
int64 last_rowno_in_peerset() const
See m_last_rowno_in_peerset.
Definition: window.h:1233
bool optimizable_row_aggregates() const
Return true if the set of window functions are all ROW unit optimizable.
Definition: window.h:1103
Mem_root_array_YY< Frame_buffer_position > m_frame_buffer_positions
Execution state: used iff m_needs_frame_buffering.
Definition: window.h:305
int m_ordering_idx
The logical ordering index (into LogicalOrderings) needed by this window's PARTITION BY and ORDER BY ...
Definition: window.h:571
bool check_constant_bound(THD *thd, PT_border *border)
Check that a frame border is constant during execution and that it does not contain subqueries (relev...
Definition: window.cc:772
bool m_needs_frame_buffering
(At least) one window function needs to buffer frame rows for evaluation i.e.
Definition: window.h:135
bool is_last() const
See m_last.
Definition: window.h:1130
int64 m_last_rowno_in_cache
Execution state: used iff m_needs_frame_buffering.
Definition: window.h:443
Special_keys
Keys for m_special_rows_cache, for special rows (see the comment on m_special_row_cache).
Definition: window.h:364
@ FBC_LAST_KEY
Definition: window.h:375
@ FBC_FIRST_KEY
Definition: window.h:374
@ FBC_FIRST_IN_NEXT_PARTITION
We read an incoming row.
Definition: window.h:371
void print_frame(const THD *thd, String *str, enum_query_type qt) const
Definition: window.cc:1453
bool needs_peerset() const
If we cannot compute one of window functions without looking at all rows in the peerset of the curren...
Definition: window.h:1082
Reset_level
Definition: window.h:1425
@ RL_ROUND
Definition: window.h:1425
@ RL_PARTITION
Definition: window.h:1425
bool m_mark
Used temporarily by the hypergraph join optimizer to mark which windows are referred to by a given or...
Definition: window.h:578
Mem_root_array< Cached_item * > m_partition_items
items for the PARTITION BY columns
Definition: window.h:240
int64 m_last_rowno_in_range_frame
Execution state: used for RANGE bounds frame evaluation for the continued evaluation for current row ...
Definition: window.h:607
int64 m_last_row_output
Execution state: The number, in the current partition, of the last output row, i.e.
Definition: window.h:476
void print_border(const THD *thd, String *str, PT_border *b, enum_query_type qt) const
Definition: window.cc:1422
Bounds_checked_array< Arg_comparator > m_comparators[2]
Definition: window.h:564
uint def_pos() const
Definition: window.h:767
Window(Item_string *name, PT_order_list *part, PT_order_list *ord, PT_frame *frame, bool is_reference, Item_string *inherit)
Generic window constructor, shared.
Definition: window.h:670
PT_frame *const m_frame
<window frame clause>
Definition: window.h:116
void print(const THD *thd, String *str, enum_query_type qt, bool expand_definition) const
Definition: window.cc:1466
int64 rowno_being_visited() const
See m_rowno_being_visited.
Definition: window.h:1199
bool optimizable_range_aggregates() const
Return true if the set of window functions are all RANGE unit optimizable.
Definition: window.h:1109
void check_partition_boundary()
Check if the just read input row marks the start of a new partition.
Definition: window.cc:456
void set_rowno_in_partition(int64 rowno)
See m_rowno_in_partition.
Definition: window.h:1326
void restore_pos(Window_retrieve_cached_row_reason reason)
See m_tmp_pos.
Definition: window.h:330
bool has_windowing_steps() const
Definition: window.cc:1516
void set_frame_buffer_total_rows(int64 rows)
See m_frame_buffer_total_rows.
Definition: window.h:1356
int64 frame_buffer_partition_offset() const
See m_frame_buffer_partition_offset.
Definition: window.h:1375
void set_is_last_row_in_frame(bool b)
See m_is_last_row_in_frame.
Definition: window.h:1297
void set_aggregates_primed(bool b)
See m_aggregates_primed.
Definition: window.h:1285
st_nth m_opt_nth_row
Window requires re-evaluation of the Nth row in optimized moving frame mode e.g.
Definition: window.h:233
int64 last_rowno_in_cache() const
See m_last_rowno_in_cache.
Definition: window.h:1209
bool needs_partition_cardinality() const
If we need to read the entire partition before we can evaluate some window function(s) on this window...
Definition: window.h:1095
ORDER * sorting_order(THD *thd=nullptr, bool implicit_grouping=false)
Concatenation of columns in PARTITION BY and ORDER BY.
Definition: window.cc:393
List< Item_sum > m_functions
window functions based on 'this'
Definition: window.h:238
void set_do_copy_null(bool b)
See m_do_copy_null.
Definition: window.h:1262
PT_order_list *const m_partition_by
<window partition clause>
Definition: window.h:113
static void reorder_and_eliminate_sorts(List< Window > *windows)
Reorder windows and eliminate redundant ordering.
Definition: window.cc:752
bool m_opt_last_row
Window requires re-evaluation of the last row in optimized moving frame mode e.g.
Definition: window.h:189
static bool setup_windows2(THD *thd, List< Window > *windows)
Like setup_windows1() but contains operations which must wait until the start of the execution phase.
Definition: window.cc:1308
A (partial) implementation of std::deque allocating its blocks on a MEM_ROOT.
Definition: mem_root_deque.h:110
const char * p
Definition: ctype-mb.cc:1237
enum_query_type
Query type constants (usable as bitmap flags).
Definition: enum_query_type.h:31
Fido Client Authentication nullptr
Definition: fido_client_plugin.cc:222
Some integer typedefs for easier portability.
#define INT_MIN64
Definition: my_inttypes.h:75
unsigned char uchar
Definition: my_inttypes.h:52
int64_t int64
Definition: my_inttypes.h:68
uint64_t uint64
Definition: my_inttypes.h:69
thread_local MEM_ROOT ** THR_MALLOC
Definition: mysqld.cc:1560
static int record
Definition: mysqltest.cc:188
std::string str(const mysqlrouter::ConfigGenerator::Options::Endpoint &ep)
Definition: config_generator.cc:1044
Definition: os0file.h:86
Definition: table.h:281
Definition: table.h:1398
Holds information about a position in the buffer frame as stored in a temporary file (cf.
Definition: window.h:262
int64 m_rowno
Definition: window.h:266
uchar * m_position
< The size of the file position is determined by handler::ref_length
Definition: window.h:264
Frame_buffer_position(uchar *position, int64 rowno)
Definition: window.h:267
Definition: window.h:223
Mem_root_array_YY< st_ll_offset > m_offsets
sorted set of LEAD/LAG offsets
Definition: window.h:225
Definition: window.h:208
st_ll_offset()
Definition: window.h:210
int64 m_rowno
negative values is LEAD
Definition: window.h:209
bool operator<(const st_ll_offset &a) const
Used for sorting offsets in ascending order for faster traversal of frame buffer tmp file.
Definition: window.h:215
Definition: window.h:218
Mem_root_array_YY< st_offset > m_offsets
sorted set of NTH_VALUE offsets
Definition: window.h:220
Definition: window.h:197
bool operator<(const st_offset &a) const
Used for sorting offsets in ascending order for faster traversal of frame buffer tmp file.
Definition: window.h:205
st_offset()
Definition: window.h:200
bool m_from_last
Definition: window.h:199
int64 m_rowno
Definition: window.h:198
Collects evaluation requirements from a window function, used by Item_sum::check_wf_semantics and its...
Definition: window.h:1538
bool needs_buffer
Set to true if window function requires row buffering.
Definition: window.h:1542
bool needs_last_peer_in_frame
Set to true if we need last peer for evaluation within a frame (e.g.
Definition: window.h:1551
bool opt_first_row
Set to true if we need FIRST_VALUE or optimized MIN/MAX.
Definition: window.h:1555
bool range_optimizable
Similar to row_optimizable but for RANGE frame bounds unit.
Definition: window.h:1573
Window_evaluation_requirements()
Definition: window.h:1575
Window::st_offset opt_nth_row
Used if we have NTH_VALUE.
Definition: window.h:1560
bool opt_last_row
Set to true if we need LAST_VALUE or optimized MIN/MAX.
Definition: window.h:1559
bool row_optimizable
Set to true if we can compute a sliding window by a combination of undoing the contribution of rows g...
Definition: window.h:1569
bool needs_peerset
Set to true if we need peerset for evaluation (e.g.
Definition: window.h:1546
Window::st_ll_offset opt_ll_row
Used if we have LEAD or LAG.
Definition: window.h:1561
unsigned int uint
Definition: uca9-dump.cc:75
constexpr int kMaxWindows
The number of windows is limited to avoid the stack blowing up when constructing iterators recursivel...
Definition: window.h:83
Window_retrieve_cached_row_reason
Position hints for the frame buffer are saved for these kind of row accesses, cf.
Definition: window.h:65