1 /*-------------------------------------------------------------------------
4 * The query optimizer external interface.
6 * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $Header: /cvsroot/pgsql/src/backend/optimizer/plan/planner.c,v 1.159 2003/08/04 02:40:01 momjian Exp $
13 *-------------------------------------------------------------------------
20 #include "catalog/pg_operator.h"
21 #include "catalog/pg_type.h"
22 #include "executor/executor.h"
23 #include "miscadmin.h"
24 #include "nodes/makefuncs.h"
25 #ifdef OPTIMIZER_DEBUG
26 #include "nodes/print.h"
28 #include "optimizer/clauses.h"
29 #include "optimizer/cost.h"
30 #include "optimizer/pathnode.h"
31 #include "optimizer/paths.h"
32 #include "optimizer/planmain.h"
33 #include "optimizer/planner.h"
34 #include "optimizer/prep.h"
35 #include "optimizer/subselect.h"
36 #include "optimizer/tlist.h"
37 #include "optimizer/var.h"
38 #include "parser/analyze.h"
39 #include "parser/parsetree.h"
40 #include "parser/parse_expr.h"
41 #include "parser/parse_oper.h"
42 #include "utils/selfuncs.h"
43 #include "utils/syscache.h"
46 /* Expression kind codes for preprocess_expression */
47 #define EXPRKIND_QUAL 0
48 #define EXPRKIND_TARGET 1
49 #define EXPRKIND_RTFUNC 2
50 #define EXPRKIND_LIMIT 3
51 #define EXPRKIND_ININFO 4
54 static Node *preprocess_expression(Query *parse, Node *expr, int kind);
55 static void preprocess_qual_conditions(Query *parse, Node *jtnode);
56 static Plan *inheritance_planner(Query *parse, List *inheritlist);
57 static Plan *grouping_planner(Query *parse, double tuple_fraction);
58 static bool hash_safe_grouping(Query *parse);
59 static List *make_subplanTargetList(Query *parse, List *tlist,
60 AttrNumber **groupColIdx, bool *need_tlist_eval);
61 static void locate_grouping_columns(Query *parse,
64 AttrNumber *groupColIdx);
65 static List *postprocess_setop_tlist(List *new_tlist, List *orig_tlist);
68 /*****************************************************************************
70 * Query optimizer entry point
72 *****************************************************************************/
74 planner(Query *parse, bool isCursor, int cursorOptions)
76 double tuple_fraction;
78 Index save_PlannerQueryLevel;
79 List *save_PlannerParamList;
82 * The planner can be called recursively (an example is when
83 * eval_const_expressions tries to pre-evaluate an SQL function). So,
84 * these global state variables must be saved and restored.
86 * These vars cannot be moved into the Query structure since their whole
87 * purpose is communication across multiple sub-Queries.
89 * Note we do NOT save and restore PlannerPlanId: it exists to assign
90 * unique IDs to SubPlan nodes, and we want those IDs to be unique for
91 * the life of a backend. Also, PlannerInitPlan is saved/restored in
92 * subquery_planner, not here.
94 save_PlannerQueryLevel = PlannerQueryLevel;
95 save_PlannerParamList = PlannerParamList;
97 /* Initialize state for handling outer-level references and params */
98 PlannerQueryLevel = 0; /* will be 1 in top-level subquery_planner */
99 PlannerParamList = NIL;
101 /* Determine what fraction of the plan is likely to be scanned */
105 * We have no real idea how many tuples the user will ultimately
106 * FETCH from a cursor, but it seems a good bet that he doesn't
107 * want 'em all. Optimize for 10% retrieval (you gotta better
108 * number? Should this be a SETtable parameter?)
110 tuple_fraction = 0.10;
114 /* Default assumption is we need all the tuples */
115 tuple_fraction = 0.0;
118 /* primary planning entry point (may recurse for subqueries) */
119 result_plan = subquery_planner(parse, tuple_fraction);
121 Assert(PlannerQueryLevel == 0);
124 * If creating a plan for a scrollable cursor, make sure it can run
125 * backwards on demand. Add a Material node at the top at need.
127 if (isCursor && (cursorOptions & CURSOR_OPT_SCROLL))
129 if (!ExecSupportsBackwardScan(result_plan))
130 result_plan = materialize_finished_plan(result_plan);
133 /* executor wants to know total number of Params used overall */
134 result_plan->nParamExec = length(PlannerParamList);
136 /* final cleanup of the plan */
137 set_plan_references(result_plan, parse->rtable);
139 /* restore state for outer planner, if any */
140 PlannerQueryLevel = save_PlannerQueryLevel;
141 PlannerParamList = save_PlannerParamList;
147 /*--------------------
149 * Invokes the planner on a subquery. We recurse to here for each
150 * sub-SELECT found in the query tree.
152 * parse is the querytree produced by the parser & rewriter.
153 * tuple_fraction is the fraction of tuples we expect will be retrieved.
154 * tuple_fraction is interpreted as explained for grouping_planner, below.
156 * Basically, this routine does the stuff that should only be done once
157 * per Query object. It then calls grouping_planner. At one time,
158 * grouping_planner could be invoked recursively on the same Query object;
159 * that's not currently true, but we keep the separation between the two
160 * routines anyway, in case we need it again someday.
162 * subquery_planner will be called recursively to handle sub-Query nodes
163 * found within the query's expressions and rangetable.
165 * Returns a query plan.
166 *--------------------
169 subquery_planner(Query *parse, double tuple_fraction)
171 List *saved_initplan = PlannerInitPlan;
172 int saved_planid = PlannerPlanId;
178 /* Set up for a new level of subquery */
180 PlannerInitPlan = NIL;
183 * Look for IN clauses at the top level of WHERE, and transform them
184 * into joins. Note that this step only handles IN clauses originally
185 * at top level of WHERE; if we pull up any subqueries in the next
186 * step, their INs are processed just before pulling them up.
188 parse->in_info_list = NIL;
189 if (parse->hasSubLinks)
190 parse->jointree->quals = pull_up_IN_clauses(parse,
191 parse->jointree->quals);
194 * Check to see if any subqueries in the rangetable can be merged into
197 parse->jointree = (FromExpr *)
198 pull_up_subqueries(parse, (Node *) parse->jointree, false);
201 * Detect whether any rangetable entries are RTE_JOIN kind; if not, we
202 * can avoid the expense of doing flatten_join_alias_vars(). Also
203 * check for outer joins --- if none, we can skip
204 * reduce_outer_joins(). This must be done after we have done
205 * pull_up_subqueries, of course.
207 parse->hasJoinRTEs = false;
208 hasOuterJoins = false;
209 foreach(lst, parse->rtable)
211 RangeTblEntry *rte = (RangeTblEntry *) lfirst(lst);
213 if (rte->rtekind == RTE_JOIN)
215 parse->hasJoinRTEs = true;
216 if (IS_OUTER_JOIN(rte->jointype))
218 hasOuterJoins = true;
219 /* Can quit scanning once we find an outer join */
226 * Do expression preprocessing on targetlist and quals.
228 parse->targetList = (List *)
229 preprocess_expression(parse, (Node *) parse->targetList,
232 preprocess_qual_conditions(parse, (Node *) parse->jointree);
234 parse->havingQual = preprocess_expression(parse, parse->havingQual,
237 parse->limitOffset = preprocess_expression(parse, parse->limitOffset,
239 parse->limitCount = preprocess_expression(parse, parse->limitCount,
242 parse->in_info_list = (List *)
243 preprocess_expression(parse, (Node *) parse->in_info_list,
246 /* Also need to preprocess expressions for function RTEs */
247 foreach(lst, parse->rtable)
249 RangeTblEntry *rte = (RangeTblEntry *) lfirst(lst);
251 if (rte->rtekind == RTE_FUNCTION)
252 rte->funcexpr = preprocess_expression(parse, rte->funcexpr,
257 * A HAVING clause without aggregates is equivalent to a WHERE clause
258 * (except it can only refer to grouped fields). Transfer any
259 * agg-free clauses of the HAVING qual into WHERE. This may seem like
260 * wasting cycles to cater to stupidly-written queries, but there are
261 * other reasons for doing it. Firstly, if the query contains no aggs
262 * at all, then we aren't going to generate an Agg plan node, and so
263 * there'll be no place to execute HAVING conditions; without this
264 * transfer, we'd lose the HAVING condition entirely, which is wrong.
265 * Secondly, when we push down a qual condition into a sub-query, it's
266 * easiest to push the qual into HAVING always, in case it contains
267 * aggs, and then let this code sort it out.
269 * Note that both havingQual and parse->jointree->quals are in
270 * implicitly-ANDed-list form at this point, even though they are
271 * declared as Node *.
274 foreach(lst, (List *) parse->havingQual)
276 Node *havingclause = (Node *) lfirst(lst);
278 if (contain_agg_clause(havingclause))
279 newHaving = lappend(newHaving, havingclause);
281 parse->jointree->quals = (Node *)
282 lappend((List *) parse->jointree->quals, havingclause);
284 parse->havingQual = (Node *) newHaving;
287 * If we have any outer joins, try to reduce them to plain inner
288 * joins. This step is most easily done after we've done expression
292 reduce_outer_joins(parse);
295 * See if we can simplify the jointree; opportunities for this may
296 * come from having pulled up subqueries, or from flattening explicit
297 * JOIN syntax. We must do this after flattening JOIN alias
298 * variables, since eliminating explicit JOIN nodes from the jointree
299 * will cause get_relids_for_join() to fail. But it should happen
300 * after reduce_outer_joins, anyway.
302 parse->jointree = (FromExpr *)
303 simplify_jointree(parse, (Node *) parse->jointree);
306 * Do the main planning. If we have an inherited target relation,
307 * that needs special processing, else go straight to
310 if (parse->resultRelation &&
311 (lst = expand_inherited_rtentry(parse, parse->resultRelation,
313 plan = inheritance_planner(parse, lst);
315 plan = grouping_planner(parse, tuple_fraction);
318 * If any subplans were generated, or if we're inside a subplan, build
319 * initPlan list and extParam/allParam sets for plan nodes.
321 if (PlannerPlanId != saved_planid || PlannerQueryLevel > 1)
323 Cost initplan_cost = 0;
325 /* Prepare extParam/allParam sets for all nodes in tree */
326 SS_finalize_plan(plan, parse->rtable);
329 * SS_finalize_plan doesn't handle initPlans, so we have to
330 * manually attach them to the topmost plan node, and add their
331 * extParams to the topmost node's, too.
333 * We also add the total_cost of each initPlan to the startup cost of
334 * the top node. This is a conservative overestimate, since in
335 * fact each initPlan might be executed later than plan startup,
336 * or even not at all.
338 plan->initPlan = PlannerInitPlan;
340 foreach(lst, plan->initPlan)
342 SubPlan *initplan = (SubPlan *) lfirst(lst);
344 plan->extParam = bms_add_members(plan->extParam,
345 initplan->plan->extParam);
346 initplan_cost += initplan->plan->total_cost;
349 plan->startup_cost += initplan_cost;
350 plan->total_cost += initplan_cost;
353 /* Return to outer subquery context */
355 PlannerInitPlan = saved_initplan;
356 /* we do NOT restore PlannerPlanId; that's not an oversight! */
362 * preprocess_expression
363 * Do subquery_planner's preprocessing work for an expression,
364 * which can be a targetlist, a WHERE clause (including JOIN/ON
365 * conditions), or a HAVING clause.
368 preprocess_expression(Query *parse, Node *expr, int kind)
371 * If the query has any join RTEs, replace join alias variables with
372 * base-relation variables. We must do this before sublink processing,
373 * else sublinks expanded out from join aliases wouldn't get
376 if (parse->hasJoinRTEs)
377 expr = flatten_join_alias_vars(parse, expr);
380 * Simplify constant expressions.
382 * Note that at this point quals have not yet been converted to
383 * implicit-AND form, so we can apply eval_const_expressions directly.
385 expr = eval_const_expressions(expr);
388 * If it's a qual or havingQual, canonicalize it, and convert it to
389 * implicit-AND format.
391 * XXX Is there any value in re-applying eval_const_expressions after
394 if (kind == EXPRKIND_QUAL)
396 expr = (Node *) canonicalize_qual((Expr *) expr, true);
398 #ifdef OPTIMIZER_DEBUG
399 printf("After canonicalize_qual()\n");
404 /* Expand SubLinks to SubPlans */
405 if (parse->hasSubLinks)
406 expr = SS_process_sublinks(expr, (kind == EXPRKIND_QUAL));
409 * XXX do not insert anything here unless you have grokked the
410 * comments in SS_replace_correlation_vars ...
413 /* Replace uplevel vars with Param nodes */
414 if (PlannerQueryLevel > 1)
415 expr = SS_replace_correlation_vars(expr);
421 * preprocess_qual_conditions
422 * Recursively scan the query's jointree and do subquery_planner's
423 * preprocessing work on each qual condition found therein.
426 preprocess_qual_conditions(Query *parse, Node *jtnode)
430 if (IsA(jtnode, RangeTblRef))
432 /* nothing to do here */
434 else if (IsA(jtnode, FromExpr))
436 FromExpr *f = (FromExpr *) jtnode;
439 foreach(l, f->fromlist)
440 preprocess_qual_conditions(parse, lfirst(l));
442 f->quals = preprocess_expression(parse, f->quals, EXPRKIND_QUAL);
444 else if (IsA(jtnode, JoinExpr))
446 JoinExpr *j = (JoinExpr *) jtnode;
448 preprocess_qual_conditions(parse, j->larg);
449 preprocess_qual_conditions(parse, j->rarg);
451 j->quals = preprocess_expression(parse, j->quals, EXPRKIND_QUAL);
454 elog(ERROR, "unrecognized node type: %d",
455 (int) nodeTag(jtnode));
458 /*--------------------
459 * inheritance_planner
460 * Generate a plan in the case where the result relation is an
463 * We have to handle this case differently from cases where a source
464 * relation is an inheritance set. Source inheritance is expanded at
465 * the bottom of the plan tree (see allpaths.c), but target inheritance
466 * has to be expanded at the top. The reason is that for UPDATE, each
467 * target relation needs a different targetlist matching its own column
468 * set. (This is not so critical for DELETE, but for simplicity we treat
469 * inherited DELETE the same way.) Fortunately, the UPDATE/DELETE target
470 * can never be the nullable side of an outer join, so it's OK to generate
473 * parse is the querytree produced by the parser & rewriter.
474 * inheritlist is an integer list of RT indexes for the result relation set.
476 * Returns a query plan.
477 *--------------------
480 inheritance_planner(Query *parse, List *inheritlist)
482 int parentRTindex = parse->resultRelation;
483 Oid parentOID = getrelid(parentRTindex, parse->rtable);
484 int mainrtlength = length(parse->rtable);
485 List *subplans = NIL;
489 foreach(l, inheritlist)
491 int childRTindex = lfirsti(l);
492 Oid childOID = getrelid(childRTindex, parse->rtable);
497 /* Generate modified query with this rel as target */
498 subquery = (Query *) adjust_inherited_attrs((Node *) parse,
499 parentRTindex, parentOID,
500 childRTindex, childOID);
502 subplan = grouping_planner(subquery, 0.0 /* retrieve all tuples */ );
503 subplans = lappend(subplans, subplan);
506 * It's possible that additional RTEs got added to the rangetable
507 * due to expansion of inherited source tables (see allpaths.c).
508 * If so, we must copy 'em back to the main parse tree's rtable.
510 * XXX my goodness this is ugly. Really need to think about ways to
511 * rein in planner's habit of scribbling on its input.
513 subrtlength = length(subquery->rtable);
514 if (subrtlength > mainrtlength)
516 List *subrt = subquery->rtable;
518 while (mainrtlength-- > 0) /* wish we had nthcdr() */
519 subrt = lnext(subrt);
520 parse->rtable = nconc(parse->rtable, subrt);
521 mainrtlength = subrtlength;
523 /* Save preprocessed tlist from first rel for use in Append */
525 tlist = subplan->targetlist;
528 /* Save the target-relations list for the executor, too */
529 parse->resultRelations = inheritlist;
531 /* Mark result as unordered (probably unnecessary) */
532 parse->query_pathkeys = NIL;
534 return (Plan *) make_append(subplans, true, tlist);
537 /*--------------------
539 * Perform planning steps related to grouping, aggregation, etc.
540 * This primarily means adding top-level processing to the basic
541 * query plan produced by query_planner.
543 * parse is the querytree produced by the parser & rewriter.
544 * tuple_fraction is the fraction of tuples we expect will be retrieved
546 * tuple_fraction is interpreted as follows:
547 * 0: expect all tuples to be retrieved (normal case)
548 * 0 < tuple_fraction < 1: expect the given fraction of tuples available
549 * from the plan to be retrieved
550 * tuple_fraction >= 1: tuple_fraction is the absolute number of tuples
551 * expected to be retrieved (ie, a LIMIT specification)
553 * Returns a query plan. Also, parse->query_pathkeys is returned as the
554 * actual output ordering of the plan (in pathkey format).
555 *--------------------
558 grouping_planner(Query *parse, double tuple_fraction)
560 List *tlist = parse->targetList;
562 List *current_pathkeys;
565 if (parse->setOperations)
568 * Construct the plan for set operations. The result will not
569 * need any work except perhaps a top-level sort and/or LIMIT.
571 result_plan = plan_set_operations(parse);
574 * We should not need to call preprocess_targetlist, since we must
575 * be in a SELECT query node. Instead, use the targetlist
576 * returned by plan_set_operations (since this tells whether it
577 * returned any resjunk columns!), and transfer any sort key
578 * information from the original tlist.
580 Assert(parse->commandType == CMD_SELECT);
582 tlist = postprocess_setop_tlist(result_plan->targetlist, tlist);
585 * Can't handle FOR UPDATE here (parser should have checked
586 * already, but let's make sure).
590 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
591 errmsg("SELECT FOR UPDATE is not allowed with UNION/INTERSECT/EXCEPT")));
594 * We set current_pathkeys NIL indicating we do not know sort
595 * order. This is correct when the top set operation is UNION
596 * ALL, since the appended-together results are unsorted even if
597 * the subplans were sorted. For other set operations we could be
598 * smarter --- room for future improvement!
600 current_pathkeys = NIL;
603 * Calculate pathkeys that represent ordering requirements
605 sort_pathkeys = make_pathkeys_for_sortclauses(parse->sortClause,
607 sort_pathkeys = canonicalize_pathkeys(parse, sort_pathkeys);
611 /* No set operations, do regular planning */
613 List *group_pathkeys;
614 AttrNumber *groupColIdx = NULL;
615 bool need_tlist_eval = true;
617 double sub_tuple_fraction;
620 double dNumGroups = 0;
623 int numGroupCols = length(parse->groupClause);
624 bool use_hashed_grouping = false;
626 /* Preprocess targetlist in case we are inside an INSERT/UPDATE. */
627 tlist = preprocess_targetlist(tlist,
629 parse->resultRelation,
633 * Add TID targets for rels selected FOR UPDATE (should this be
634 * done in preprocess_targetlist?). The executor uses the TID to
635 * know which rows to lock, much as for UPDATE or DELETE.
642 * We've got trouble if the FOR UPDATE appears inside
643 * grouping, since grouping renders a reference to individual
644 * tuple CTIDs invalid. This is also checked at parse time,
645 * but that's insufficient because of rule substitution, query
648 CheckSelectForUpdate(parse);
651 * Currently the executor only supports FOR UPDATE at top
654 if (PlannerQueryLevel > 1)
656 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
657 errmsg("SELECT FOR UPDATE is not allowed in subselects")));
659 foreach(l, parse->rowMarks)
661 Index rti = lfirsti(l);
667 resname = (char *) palloc(32);
668 snprintf(resname, 32, "ctid%u", rti);
669 resdom = makeResdom(length(tlist) + 1,
676 SelfItemPointerAttributeNumber,
681 ctid = makeTargetEntry(resdom, (Expr *) var);
682 tlist = lappend(tlist, ctid);
687 * Generate appropriate target list for subplan; may be different
688 * from tlist if grouping or aggregation is needed.
690 sub_tlist = make_subplanTargetList(parse, tlist,
691 &groupColIdx, &need_tlist_eval);
694 * Calculate pathkeys that represent grouping/ordering
697 group_pathkeys = make_pathkeys_for_sortclauses(parse->groupClause,
699 sort_pathkeys = make_pathkeys_for_sortclauses(parse->sortClause,
703 * Will need actual number of aggregates for estimating costs.
704 * Also, it's possible that optimization has eliminated all
705 * aggregates, and we may as well check for that here.
707 * Note: we do not attempt to detect duplicate aggregates here; a
708 * somewhat-overestimated count is okay for our present purposes.
712 numAggs = count_agg_clause((Node *) tlist) +
713 count_agg_clause(parse->havingQual);
715 parse->hasAggs = false;
719 * Figure out whether we need a sorted result from query_planner.
721 * If we have a GROUP BY clause, then we want a result sorted
722 * properly for grouping. Otherwise, if there is an ORDER BY
723 * clause, we want to sort by the ORDER BY clause. (Note: if we
724 * have both, and ORDER BY is a superset of GROUP BY, it would be
725 * tempting to request sort by ORDER BY --- but that might just
726 * leave us failing to exploit an available sort order at all.
727 * Needs more thought...)
729 if (parse->groupClause)
730 parse->query_pathkeys = group_pathkeys;
731 else if (parse->sortClause)
732 parse->query_pathkeys = sort_pathkeys;
734 parse->query_pathkeys = NIL;
737 * Adjust tuple_fraction if we see that we are going to apply
738 * limiting/grouping/aggregation/etc. This is not overridable by
739 * the caller, since it reflects plan actions that this routine
740 * will certainly take, not assumptions about context.
742 if (parse->limitCount != NULL)
745 * A LIMIT clause limits the absolute number of tuples
746 * returned. However, if it's not a constant LIMIT then we
747 * have to punt; for lack of a better idea, assume 10% of the
748 * plan's result is wanted.
750 double limit_fraction = 0.0;
752 if (IsA(parse->limitCount, Const))
754 Const *limitc = (Const *) parse->limitCount;
755 int32 count = DatumGetInt32(limitc->constvalue);
758 * A NULL-constant LIMIT represents "LIMIT ALL", which we
759 * treat the same as no limit (ie, expect to retrieve all
762 if (!limitc->constisnull && count > 0)
764 limit_fraction = (double) count;
765 /* We must also consider the OFFSET, if present */
766 if (parse->limitOffset != NULL)
768 if (IsA(parse->limitOffset, Const))
772 limitc = (Const *) parse->limitOffset;
773 offset = DatumGetInt32(limitc->constvalue);
774 if (!limitc->constisnull && offset > 0)
775 limit_fraction += (double) offset;
779 /* OFFSET is an expression ... punt ... */
780 limit_fraction = 0.10;
787 /* LIMIT is an expression ... punt ... */
788 limit_fraction = 0.10;
791 if (limit_fraction > 0.0)
794 * If we have absolute limits from both caller and LIMIT,
795 * use the smaller value; if one is fractional and the
796 * other absolute, treat the fraction as a fraction of the
797 * absolute value; else we can multiply the two fractions
800 if (tuple_fraction >= 1.0)
802 if (limit_fraction >= 1.0)
805 tuple_fraction = Min(tuple_fraction, limit_fraction);
809 /* caller absolute, limit fractional */
810 tuple_fraction *= limit_fraction;
811 if (tuple_fraction < 1.0)
812 tuple_fraction = 1.0;
815 else if (tuple_fraction > 0.0)
817 if (limit_fraction >= 1.0)
819 /* caller fractional, limit absolute */
820 tuple_fraction *= limit_fraction;
821 if (tuple_fraction < 1.0)
822 tuple_fraction = 1.0;
826 /* both fractional */
827 tuple_fraction *= limit_fraction;
832 /* no info from caller, just use limit */
833 tuple_fraction = limit_fraction;
839 * With grouping or aggregation, the tuple fraction to pass to
840 * query_planner() may be different from what it is at top level.
842 sub_tuple_fraction = tuple_fraction;
844 if (parse->groupClause)
847 * In GROUP BY mode, we have the little problem that we don't
848 * really know how many input tuples will be needed to make a
849 * group, so we can't translate an output LIMIT count into an
850 * input count. For lack of a better idea, assume 25% of the
851 * input data will be processed if there is any output limit.
852 * However, if the caller gave us a fraction rather than an
853 * absolute count, we can keep using that fraction (which
854 * amounts to assuming that all the groups are about the same
857 if (sub_tuple_fraction >= 1.0)
858 sub_tuple_fraction = 0.25;
861 * If both GROUP BY and ORDER BY are specified, we will need
862 * two levels of sort --- and, therefore, certainly need to
863 * read all the input tuples --- unless ORDER BY is a subset
864 * of GROUP BY. (We have not yet canonicalized the pathkeys,
865 * so must use the slower noncanonical comparison method.)
867 if (parse->groupClause && parse->sortClause &&
868 !noncanonical_pathkeys_contained_in(sort_pathkeys,
870 sub_tuple_fraction = 0.0;
872 else if (parse->hasAggs)
875 * Ungrouped aggregate will certainly want all the input
878 sub_tuple_fraction = 0.0;
880 else if (parse->distinctClause)
883 * SELECT DISTINCT, like GROUP, will absorb an unpredictable
884 * number of input tuples per output tuple. Handle the same
887 if (sub_tuple_fraction >= 1.0)
888 sub_tuple_fraction = 0.25;
892 * Generate the best unsorted and presorted paths for this Query
893 * (but note there may not be any presorted path).
895 query_planner(parse, sub_tlist, sub_tuple_fraction,
896 &cheapest_path, &sorted_path);
899 * We couldn't canonicalize group_pathkeys and sort_pathkeys
900 * before running query_planner(), so do it now.
902 group_pathkeys = canonicalize_pathkeys(parse, group_pathkeys);
903 sort_pathkeys = canonicalize_pathkeys(parse, sort_pathkeys);
906 * Consider whether we might want to use hashed grouping.
908 if (parse->groupClause)
911 double cheapest_path_rows;
912 int cheapest_path_width;
915 * Beware in this section of the possibility that
916 * cheapest_path->parent is NULL. This could happen if user
917 * does something silly like SELECT 'foo' GROUP BY 1;
919 if (cheapest_path->parent)
921 cheapest_path_rows = cheapest_path->parent->rows;
922 cheapest_path_width = cheapest_path->parent->width;
926 cheapest_path_rows = 1; /* assume non-set result */
927 cheapest_path_width = 100; /* arbitrary */
931 * Always estimate the number of groups. We can't do this
932 * until after running query_planner(), either.
934 groupExprs = get_sortgrouplist_exprs(parse->groupClause,
936 dNumGroups = estimate_num_groups(parse,
939 /* Also want it as a long int --- but 'ware overflow! */
940 numGroups = (long) Min(dNumGroups, (double) LONG_MAX);
943 * Check can't-do-it conditions, including whether the
944 * grouping operators are hashjoinable.
946 * Executor doesn't support hashed aggregation with DISTINCT
947 * aggregates. (Doing so would imply storing *all* the input
948 * values in the hash table, which seems like a certain
951 if (!enable_hashagg || !hash_safe_grouping(parse))
952 use_hashed_grouping = false;
953 else if (parse->hasAggs &&
954 (contain_distinct_agg_clause((Node *) tlist) ||
955 contain_distinct_agg_clause(parse->havingQual)))
956 use_hashed_grouping = false;
960 * Use hashed grouping if (a) we think we can fit the
961 * hashtable into SortMem, *and* (b) the estimated cost is
962 * no more than doing it the other way. While avoiding
963 * the need for sorted input is usually a win, the fact
964 * that the output won't be sorted may be a loss; so we
965 * need to do an actual cost comparison.
967 * In most cases we have no good way to estimate the size of
968 * the transition value needed by an aggregate;
969 * arbitrarily assume it is 100 bytes. Also set the
970 * overhead per hashtable entry at 64 bytes.
972 int hashentrysize = cheapest_path_width + 64 + numAggs * 100;
974 if (hashentrysize * dNumGroups <= SortMem * 1024L)
977 * Okay, do the cost comparison. We need to consider
978 * cheapest_path + hashagg [+ final sort] versus
979 * either cheapest_path [+ sort] + group or agg [+
980 * final sort] or presorted_path + group or agg [+
981 * final sort] where brackets indicate a step that may
982 * not be needed. We assume query_planner() will have
983 * returned a presorted path only if it's a winner
984 * compared to cheapest_path for this purpose.
986 * These path variables are dummies that just hold cost
987 * fields; we don't make actual Paths for these steps.
992 cost_agg(&hashed_p, parse,
994 numGroupCols, dNumGroups,
995 cheapest_path->startup_cost,
996 cheapest_path->total_cost,
998 /* Result of hashed agg is always unsorted */
1000 cost_sort(&hashed_p, parse, sort_pathkeys,
1001 hashed_p.total_cost,
1003 cheapest_path_width);
1007 sorted_p.startup_cost = sorted_path->startup_cost;
1008 sorted_p.total_cost = sorted_path->total_cost;
1009 current_pathkeys = sorted_path->pathkeys;
1013 sorted_p.startup_cost = cheapest_path->startup_cost;
1014 sorted_p.total_cost = cheapest_path->total_cost;
1015 current_pathkeys = cheapest_path->pathkeys;
1017 if (!pathkeys_contained_in(group_pathkeys,
1020 cost_sort(&sorted_p, parse, group_pathkeys,
1021 sorted_p.total_cost,
1023 cheapest_path_width);
1024 current_pathkeys = group_pathkeys;
1027 cost_agg(&sorted_p, parse,
1028 AGG_SORTED, numAggs,
1029 numGroupCols, dNumGroups,
1030 sorted_p.startup_cost,
1031 sorted_p.total_cost,
1032 cheapest_path_rows);
1034 cost_group(&sorted_p, parse,
1035 numGroupCols, dNumGroups,
1036 sorted_p.startup_cost,
1037 sorted_p.total_cost,
1038 cheapest_path_rows);
1039 /* The Agg or Group node will preserve ordering */
1040 if (sort_pathkeys &&
1041 !pathkeys_contained_in(sort_pathkeys,
1044 cost_sort(&sorted_p, parse, sort_pathkeys,
1045 sorted_p.total_cost,
1047 cheapest_path_width);
1051 * Now make the decision using the top-level tuple
1052 * fraction. First we have to convert an absolute
1053 * count (LIMIT) into fractional form.
1055 if (tuple_fraction >= 1.0)
1056 tuple_fraction /= dNumGroups;
1058 if (compare_fractional_path_costs(&hashed_p, &sorted_p,
1059 tuple_fraction) < 0)
1061 /* Hashed is cheaper, so use it */
1062 use_hashed_grouping = true;
1069 * Select the best path and create a plan to execute it.
1071 * If we are doing hashed grouping, we will always read all the input
1072 * tuples, so use the cheapest-total path. Otherwise, trust
1073 * query_planner's decision about which to use.
1075 if (sorted_path && !use_hashed_grouping)
1077 result_plan = create_plan(parse, sorted_path);
1078 current_pathkeys = sorted_path->pathkeys;
1082 result_plan = create_plan(parse, cheapest_path);
1083 current_pathkeys = cheapest_path->pathkeys;
1087 * create_plan() returns a plan with just a "flat" tlist of
1088 * required Vars. Usually we need to insert the sub_tlist as the
1089 * tlist of the top plan node. However, we can skip that if we
1090 * determined that whatever query_planner chose to return will be
1093 if (need_tlist_eval)
1096 * If the top-level plan node is one that cannot do expression
1097 * evaluation, we must insert a Result node to project the
1098 * desired tlist. Currently, the only plan node we might see
1099 * here that falls into that category is Append.
1101 if (IsA(result_plan, Append))
1103 result_plan = (Plan *) make_result(sub_tlist, NULL,
1109 * Otherwise, just replace the subplan's flat tlist with
1110 * the desired tlist.
1112 result_plan->targetlist = sub_tlist;
1116 * Also, account for the cost of evaluation of the sub_tlist.
1118 * Up to now, we have only been dealing with "flat" tlists,
1119 * containing just Vars. So their evaluation cost is zero
1120 * according to the model used by cost_qual_eval() (or if you
1121 * prefer, the cost is factored into cpu_tuple_cost). Thus we
1122 * can avoid accounting for tlist cost throughout
1123 * query_planner() and subroutines. But now we've inserted a
1124 * tlist that might contain actual operators, sub-selects, etc
1125 * --- so we'd better account for its cost.
1127 * Below this point, any tlist eval cost for added-on nodes
1128 * should be accounted for as we create those nodes.
1129 * Presently, of the node types we can add on, only Agg and
1130 * Group project new tlists (the rest just copy their input
1131 * tuples) --- so make_agg() and make_group() are responsible
1132 * for computing the added cost.
1134 cost_qual_eval(&tlist_cost, sub_tlist);
1135 result_plan->startup_cost += tlist_cost.startup;
1136 result_plan->total_cost += tlist_cost.startup +
1137 tlist_cost.per_tuple * result_plan->plan_rows;
1142 * Since we're using query_planner's tlist and not the one
1143 * make_subplanTargetList calculated, we have to refigure any
1144 * grouping-column indexes make_subplanTargetList computed.
1146 locate_grouping_columns(parse, tlist, result_plan->targetlist,
1151 * Insert AGG or GROUP node if needed, plus an explicit sort step
1154 * HAVING clause, if any, becomes qual of the Agg node
1156 if (use_hashed_grouping)
1158 /* Hashed aggregate plan --- no sort needed */
1159 result_plan = (Plan *) make_agg(parse,
1161 (List *) parse->havingQual,
1168 /* Hashed aggregation produces randomly-ordered results */
1169 current_pathkeys = NIL;
1171 else if (parse->hasAggs)
1173 /* Plain aggregate plan --- sort if needed */
1174 AggStrategy aggstrategy;
1176 if (parse->groupClause)
1178 if (!pathkeys_contained_in(group_pathkeys, current_pathkeys))
1180 result_plan = (Plan *)
1181 make_sort_from_groupcols(parse,
1185 current_pathkeys = group_pathkeys;
1187 aggstrategy = AGG_SORTED;
1190 * The AGG node will not change the sort ordering of its
1191 * groups, so current_pathkeys describes the result too.
1196 aggstrategy = AGG_PLAIN;
1197 /* Result will be only one row anyway; no sort order */
1198 current_pathkeys = NIL;
1201 result_plan = (Plan *) make_agg(parse,
1203 (List *) parse->havingQual,
1214 * If there are no Aggs, we shouldn't have any HAVING qual
1217 Assert(parse->havingQual == NULL);
1220 * If we have a GROUP BY clause, insert a group node (plus the
1221 * appropriate sort node, if necessary).
1223 if (parse->groupClause)
1226 * Add an explicit sort if we couldn't make the path come
1227 * out the way the GROUP node needs it.
1229 if (!pathkeys_contained_in(group_pathkeys, current_pathkeys))
1231 result_plan = (Plan *)
1232 make_sort_from_groupcols(parse,
1236 current_pathkeys = group_pathkeys;
1239 result_plan = (Plan *) make_group(parse,
1245 /* The Group node won't change sort ordering */
1248 } /* end of if (setOperations) */
1251 * If we were not able to make the plan come out in the right order,
1252 * add an explicit sort step.
1254 if (parse->sortClause)
1256 if (!pathkeys_contained_in(sort_pathkeys, current_pathkeys))
1258 result_plan = (Plan *)
1259 make_sort_from_sortclauses(parse,
1263 current_pathkeys = sort_pathkeys;
1268 * If there is a DISTINCT clause, add the UNIQUE node.
1270 if (parse->distinctClause)
1272 result_plan = (Plan *) make_unique(tlist, result_plan,
1273 parse->distinctClause);
1276 * If there was grouping or aggregation, leave plan_rows as-is
1277 * (ie, assume the result was already mostly unique). If not,
1278 * it's reasonable to assume the UNIQUE filter has effects
1279 * comparable to GROUP BY.
1281 if (!parse->groupClause && !parse->hasAggs)
1283 List *distinctExprs;
1285 distinctExprs = get_sortgrouplist_exprs(parse->distinctClause,
1287 result_plan->plan_rows = estimate_num_groups(parse,
1289 result_plan->plan_rows);
1294 * Finally, if there is a LIMIT/OFFSET clause, add the LIMIT node.
1296 if (parse->limitOffset || parse->limitCount)
1298 result_plan = (Plan *) make_limit(tlist, result_plan,
1304 * Return the actual output ordering in query_pathkeys for possible
1305 * use by an outer query level.
1307 parse->query_pathkeys = current_pathkeys;
1313 * hash_safe_grouping - are grouping operators hashable?
1315 * We assume hashed aggregation will work if the datatype's equality operator
1316 * is marked hashjoinable.
1319 hash_safe_grouping(Query *parse)
1323 foreach(gl, parse->groupClause)
1325 GroupClause *grpcl = (GroupClause *) lfirst(gl);
1326 TargetEntry *tle = get_sortgroupclause_tle(grpcl, parse->targetList);
1330 optup = equality_oper(tle->resdom->restype, false);
1331 oprcanhash = ((Form_pg_operator) GETSTRUCT(optup))->oprcanhash;
1332 ReleaseSysCache(optup);
1340 * make_subplanTargetList
1341 * Generate appropriate target list when grouping is required.
1343 * When grouping_planner inserts Aggregate or Group plan nodes above
1344 * the result of query_planner, we typically want to pass a different
1345 * target list to query_planner than the outer plan nodes should have.
1346 * This routine generates the correct target list for the subplan.
1348 * The initial target list passed from the parser already contains entries
1349 * for all ORDER BY and GROUP BY expressions, but it will not have entries
1350 * for variables used only in HAVING clauses; so we need to add those
1351 * variables to the subplan target list. Also, if we are doing either
1352 * grouping or aggregation, we flatten all expressions except GROUP BY items
1353 * into their component variables; the other expressions will be computed by
1354 * the inserted nodes rather than by the subplan. For example,
1355 * given a query like
1356 * SELECT a+b,SUM(c+d) FROM table GROUP BY a+b;
1357 * we want to pass this targetlist to the subplan:
1359 * where the a+b target will be used by the Sort/Group steps, and the
1360 * other targets will be used for computing the final results. (In the
1361 * above example we could theoretically suppress the a and b targets and
1362 * pass down only c,d,a+b, but it's not really worth the trouble to
1363 * eliminate simple var references from the subplan. We will avoid doing
1364 * the extra computation to recompute a+b at the outer level; see
1365 * replace_vars_with_subplan_refs() in setrefs.c.)
1367 * If we are grouping or aggregating, *and* there are no non-Var grouping
1368 * expressions, then the returned tlist is effectively dummy; we do not
1369 * need to force it to be evaluated, because all the Vars it contains
1370 * should be present in the output of query_planner anyway.
1372 * 'parse' is the query being processed.
1373 * 'tlist' is the query's target list.
1374 * 'groupColIdx' receives an array of column numbers for the GROUP BY
1375 * expressions (if there are any) in the subplan's target list.
1376 * 'need_tlist_eval' is set true if we really need to evaluate the
1379 * The result is the targetlist to be passed to the subplan.
1383 make_subplanTargetList(Query *parse,
1385 AttrNumber **groupColIdx,
1386 bool *need_tlist_eval)
1392 *groupColIdx = NULL;
1395 * If we're not grouping or aggregating, nothing to do here;
1396 * query_planner should receive the unmodified target list.
1398 if (!parse->hasAggs && !parse->groupClause)
1400 *need_tlist_eval = true;
1405 * Otherwise, start with a "flattened" tlist (having just the vars
1406 * mentioned in the targetlist and HAVING qual --- but not upper-
1407 * level Vars; they will be replaced by Params later on).
1409 sub_tlist = flatten_tlist(tlist);
1410 extravars = pull_var_clause(parse->havingQual, false);
1411 sub_tlist = add_to_flat_tlist(sub_tlist, extravars);
1412 freeList(extravars);
1413 *need_tlist_eval = false; /* only eval if not flat tlist */
1416 * If grouping, create sub_tlist entries for all GROUP BY expressions
1417 * (GROUP BY items that are simple Vars should be in the list
1418 * already), and make an array showing where the group columns are in
1421 numCols = length(parse->groupClause);
1425 AttrNumber *grpColIdx;
1428 grpColIdx = (AttrNumber *) palloc(sizeof(AttrNumber) * numCols);
1429 *groupColIdx = grpColIdx;
1431 foreach(gl, parse->groupClause)
1433 GroupClause *grpcl = (GroupClause *) lfirst(gl);
1434 Node *groupexpr = get_sortgroupclause_expr(grpcl, tlist);
1435 TargetEntry *te = NULL;
1438 /* Find or make a matching sub_tlist entry */
1439 foreach(sl, sub_tlist)
1441 te = (TargetEntry *) lfirst(sl);
1442 if (equal(groupexpr, te->expr))
1447 te = makeTargetEntry(makeResdom(length(sub_tlist) + 1,
1448 exprType(groupexpr),
1449 exprTypmod(groupexpr),
1452 (Expr *) groupexpr);
1453 sub_tlist = lappend(sub_tlist, te);
1454 *need_tlist_eval = true; /* it's not flat anymore */
1457 /* and save its resno */
1458 grpColIdx[keyno++] = te->resdom->resno;
1466 * locate_grouping_columns
1467 * Locate grouping columns in the tlist chosen by query_planner.
1469 * This is only needed if we don't use the sub_tlist chosen by
1470 * make_subplanTargetList. We have to forget the column indexes found
1471 * by that routine and re-locate the grouping vars in the real sub_tlist.
1474 locate_grouping_columns(Query *parse,
1477 AttrNumber *groupColIdx)
1483 * No work unless grouping.
1485 if (!parse->groupClause)
1487 Assert(groupColIdx == NULL);
1490 Assert(groupColIdx != NULL);
1492 foreach(gl, parse->groupClause)
1494 GroupClause *grpcl = (GroupClause *) lfirst(gl);
1495 Node *groupexpr = get_sortgroupclause_expr(grpcl, tlist);
1496 TargetEntry *te = NULL;
1499 foreach(sl, sub_tlist)
1501 te = (TargetEntry *) lfirst(sl);
1502 if (equal(groupexpr, te->expr))
1506 elog(ERROR, "failed to locate grouping columns");
1508 groupColIdx[keyno++] = te->resdom->resno;
1513 * postprocess_setop_tlist
1514 * Fix up targetlist returned by plan_set_operations().
1516 * We need to transpose sort key info from the orig_tlist into new_tlist.
1517 * NOTE: this would not be good enough if we supported resjunk sort keys
1518 * for results of set operations --- then, we'd need to project a whole
1519 * new tlist to evaluate the resjunk columns. For now, just ereport if we
1520 * find any resjunk columns in orig_tlist.
1523 postprocess_setop_tlist(List *new_tlist, List *orig_tlist)
1527 foreach(l, new_tlist)
1529 TargetEntry *new_tle = (TargetEntry *) lfirst(l);
1530 TargetEntry *orig_tle;
1532 /* ignore resjunk columns in setop result */
1533 if (new_tle->resdom->resjunk)
1536 Assert(orig_tlist != NIL);
1537 orig_tle = (TargetEntry *) lfirst(orig_tlist);
1538 orig_tlist = lnext(orig_tlist);
1539 if (orig_tle->resdom->resjunk) /* should not happen */
1540 elog(ERROR, "resjunk output columns are not implemented");
1541 Assert(new_tle->resdom->resno == orig_tle->resdom->resno);
1542 Assert(new_tle->resdom->restype == orig_tle->resdom->restype);
1543 new_tle->resdom->ressortgroupref = orig_tle->resdom->ressortgroupref;
1545 if (orig_tlist != NIL)
1546 elog(ERROR, "resjunk output columns are not implemented");