1 /*-------------------------------------------------------------------------
4 * Definitions for planner's internal data structures.
7 * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * $PostgreSQL: pgsql/src/include/nodes/relation.h,v 1.157 2008/08/05 02:43:17 tgl Exp $
12 *-------------------------------------------------------------------------
17 #include "access/sdir.h"
18 #include "nodes/bitmapset.h"
19 #include "nodes/params.h"
20 #include "nodes/parsenodes.h"
21 #include "storage/block.h"
26 * Set of relation identifiers (indexes into the rangetable).
28 typedef Bitmapset *Relids;
31 * When looking for a "cheapest path", this enum specifies whether we want
32 * cheapest startup cost or cheapest total cost.
34 typedef enum CostSelector
36 STARTUP_COST, TOTAL_COST
40 * The cost estimate produced by cost_qual_eval() includes both a one-time
41 * (startup) cost, and a per-tuple cost.
43 typedef struct QualCost
45 Cost startup; /* one-time cost */
46 Cost per_tuple; /* per-evaluation cost */
52 * Global information for planning/optimization
54 * PlannerGlobal holds state for an entire planner invocation; this state
55 * is shared across all levels of sub-Queries that exist in the command being
59 typedef struct PlannerGlobal
63 ParamListInfo boundParams; /* Param values provided to planner() */
65 List *paramlist; /* to keep track of cross-level Params */
67 List *subplans; /* Plans for SubPlan nodes */
69 List *subrtables; /* Rangetables for SubPlan nodes */
71 Bitmapset *rewindPlanIDs; /* indices of subplans that require REWIND */
73 List *finalrtable; /* "flat" rangetable for executor */
75 List *relationOids; /* OIDs of relations the plan depends on */
77 bool transientPlan; /* redo plan when TransactionXmin changes? */
80 /* macro for fetching the Plan associated with a SubPlan node */
81 #define planner_subplan_get_plan(root, subplan) \
82 ((Plan *) list_nth((root)->glob->subplans, (subplan)->plan_id - 1))
87 * Per-query information for planning/optimization
89 * This struct is conventionally called "root" in all the planner routines.
90 * It holds links to all of the planner's working state, in addition to the
91 * original Query. Note that at present the planner extensively modifies
92 * the passed-in Query data structure; someday that should stop.
95 typedef struct PlannerInfo
99 Query *parse; /* the Query being planned */
101 PlannerGlobal *glob; /* global info for current planner run */
103 Index query_level; /* 1 at the outermost Query */
106 * simple_rel_array holds pointers to "base rels" and "other rels" (see
107 * comments for RelOptInfo for more info). It is indexed by rangetable
108 * index (so entry 0 is always wasted). Entries can be NULL when an RTE
109 * does not correspond to a base relation, such as a join RTE or an
110 * unreferenced view RTE; or if the RelOptInfo hasn't been made yet.
112 struct RelOptInfo **simple_rel_array; /* All 1-rel RelOptInfos */
113 int simple_rel_array_size; /* allocated size of array */
116 * simple_rte_array is the same length as simple_rel_array and holds
117 * pointers to the associated rangetable entries. This lets us avoid
118 * rt_fetch(), which can be a bit slow once large inheritance sets have
121 RangeTblEntry **simple_rte_array; /* rangetable as an array */
124 * join_rel_list is a list of all join-relation RelOptInfos we have
125 * considered in this planning run. For small problems we just scan the
126 * list to do lookups, but when there are many join relations we build a
127 * hash table for faster lookups. The hash table is present and valid
128 * when join_rel_hash is not NULL. Note that we still maintain the list
129 * even when using the hash table for lookups; this simplifies life for
132 List *join_rel_list; /* list of join-relation RelOptInfos */
133 struct HTAB *join_rel_hash; /* optional hashtable for join relations */
135 List *resultRelations; /* integer list of RT indexes, or NIL */
137 List *returningLists; /* list of lists of TargetEntry, or NIL */
139 List *init_plans; /* init subplans for query */
141 List *eq_classes; /* list of active EquivalenceClasses */
143 List *canon_pathkeys; /* list of "canonical" PathKeys */
145 List *left_join_clauses; /* list of RestrictInfos for
146 * mergejoinable outer join clauses
147 * w/nonnullable var on left */
149 List *right_join_clauses; /* list of RestrictInfos for
150 * mergejoinable outer join clauses
151 * w/nonnullable var on right */
153 List *full_join_clauses; /* list of RestrictInfos for
154 * mergejoinable full join clauses */
156 List *oj_info_list; /* list of OuterJoinInfos */
158 List *in_info_list; /* list of InClauseInfos */
160 List *append_rel_list; /* list of AppendRelInfos */
162 List *query_pathkeys; /* desired pathkeys for query_planner(), and
163 * actual pathkeys afterwards */
165 List *group_pathkeys; /* groupClause pathkeys, if any */
166 List *distinct_pathkeys; /* distinctClause pathkeys, if any */
167 List *sort_pathkeys; /* sortClause pathkeys, if any */
169 List *initial_rels; /* RelOptInfos we are now trying to join */
171 MemoryContext planner_cxt; /* context holding PlannerInfo */
173 double total_table_pages; /* # of pages in all tables of query */
175 double tuple_fraction; /* tuple_fraction passed to query_planner */
177 bool hasJoinRTEs; /* true if any RTEs are RTE_JOIN kind */
178 bool hasOuterJoins; /* true if any RTEs are outer joins */
179 bool hasHavingQual; /* true if havingQual was non-null */
180 bool hasPseudoConstantQuals; /* true if any RestrictInfo has
181 * pseudoconstant = true */
186 * In places where it's known that simple_rte_array[] must have been prepared
187 * already, we just index into it to fetch RTEs. In code that might be
188 * executed before or after entering query_planner(), use this macro.
190 #define planner_rt_fetch(rti, root) \
191 ((root)->simple_rte_array ? (root)->simple_rte_array[rti] : \
192 rt_fetch(rti, (root)->parse->rtable))
197 * Per-relation information for planning/optimization
199 * For planning purposes, a "base rel" is either a plain relation (a table)
200 * or the output of a sub-SELECT or function that appears in the range table.
201 * In either case it is uniquely identified by an RT index. A "joinrel"
202 * is the joining of two or more base rels. A joinrel is identified by
203 * the set of RT indexes for its component baserels. We create RelOptInfo
204 * nodes for each baserel and joinrel, and store them in the PlannerInfo's
205 * simple_rel_array and join_rel_list respectively.
207 * Note that there is only one joinrel for any given set of component
208 * baserels, no matter what order we assemble them in; so an unordered
209 * set is the right datatype to identify it with.
211 * We also have "other rels", which are like base rels in that they refer to
212 * single RT indexes; but they are not part of the join tree, and are given
213 * a different RelOptKind to identify them.
215 * Currently the only kind of otherrels are those made for member relations
216 * of an "append relation", that is an inheritance set or UNION ALL subquery.
217 * An append relation has a parent RTE that is a base rel, which represents
218 * the entire append relation. The member RTEs are otherrels. The parent
219 * is present in the query join tree but the members are not. The member
220 * RTEs and otherrels are used to plan the scans of the individual tables or
221 * subqueries of the append set; then the parent baserel is given an Append
222 * plan comprising the best plans for the individual member rels. (See
223 * comments for AppendRelInfo for more information.)
225 * At one time we also made otherrels to represent join RTEs, for use in
226 * handling join alias Vars. Currently this is not needed because all join
227 * alias Vars are expanded to non-aliased form during preprocess_expression.
229 * Parts of this data structure are specific to various scan and join
230 * mechanisms. It didn't seem worth creating new node types for them.
232 * relids - Set of base-relation identifiers; it is a base relation
233 * if there is just one, a join relation if more than one
234 * rows - estimated number of tuples in the relation after restriction
235 * clauses have been applied (ie, output rows of a plan for it)
236 * width - avg. number of bytes per tuple in the relation after the
237 * appropriate projections have been done (ie, output width)
238 * reltargetlist - List of Var nodes for the attributes we need to
239 * output from this relation (in no particular order)
240 * NOTE: in a child relation, may contain RowExprs
241 * pathlist - List of Path nodes, one for each potentially useful
242 * method of generating the relation
243 * cheapest_startup_path - the pathlist member with lowest startup cost
244 * (regardless of its ordering)
245 * cheapest_total_path - the pathlist member with lowest total cost
246 * (regardless of its ordering)
247 * cheapest_unique_path - for caching cheapest path to produce unique
248 * (no duplicates) output from relation
250 * If the relation is a base relation it will have these fields set:
252 * relid - RTE index (this is redundant with the relids field, but
253 * is provided for convenience of access)
254 * rtekind - distinguishes plain relation, subquery, or function RTE
255 * min_attr, max_attr - range of valid AttrNumbers for rel
256 * attr_needed - array of bitmapsets indicating the highest joinrel
257 * in which each attribute is needed; if bit 0 is set then
258 * the attribute is needed as part of final targetlist
259 * attr_widths - cache space for per-attribute width estimates;
260 * zero means not computed yet
261 * indexlist - list of IndexOptInfo nodes for relation's indexes
262 * (always NIL if it's not a table)
263 * pages - number of disk pages in relation (zero if not a table)
264 * tuples - number of tuples in relation (not considering restrictions)
265 * subplan - plan for subquery (NULL if it's not a subquery)
266 * subrtable - rangetable for subquery (NIL if it's not a subquery)
268 * Note: for a subquery, tuples and subplan are not set immediately
269 * upon creation of the RelOptInfo object; they are filled in when
270 * set_base_rel_pathlist processes the object.
272 * For otherrels that are appendrel members, these fields are filled
273 * in just as for a baserel.
275 * The presence of the remaining fields depends on the restrictions
276 * and joins that the relation participates in:
278 * baserestrictinfo - List of RestrictInfo nodes, containing info about
279 * each non-join qualification clause in which this relation
280 * participates (only used for base rels)
281 * baserestrictcost - Estimated cost of evaluating the baserestrictinfo
282 * clauses at a single tuple (only used for base rels)
283 * joininfo - List of RestrictInfo nodes, containing info about each
284 * join clause in which this relation participates (but
285 * note this excludes clauses that might be derivable from
286 * EquivalenceClasses)
287 * has_eclass_joins - flag that EquivalenceClass joins are possible
288 * index_outer_relids - only used for base rels; set of outer relids
289 * that participate in indexable joinclauses for this rel
290 * index_inner_paths - only used for base rels; list of InnerIndexscanInfo
291 * nodes showing best indexpaths for various subsets of
292 * index_outer_relids.
294 * Note: Keeping a restrictinfo list in the RelOptInfo is useful only for
295 * base rels, because for a join rel the set of clauses that are treated as
296 * restrict clauses varies depending on which sub-relations we choose to join.
297 * (For example, in a 3-base-rel join, a clause relating rels 1 and 2 must be
298 * treated as a restrictclause if we join {1} and {2 3} to make {1 2 3}; but
299 * if we join {1 2} and {3} then that clause will be a restrictclause in {1 2}
300 * and should not be processed again at the level of {1 2 3}.) Therefore,
301 * the restrictinfo list in the join case appears in individual JoinPaths
302 * (field joinrestrictinfo), not in the parent relation. But it's OK for
303 * the RelOptInfo to store the joininfo list, because that is the same
304 * for a given rel no matter how we form it.
306 * We store baserestrictcost in the RelOptInfo (for base relations) because
307 * we know we will need it at least once (to price the sequential scan)
308 * and may need it multiple times to price index scans.
311 typedef enum RelOptKind
315 RELOPT_OTHER_MEMBER_REL
318 typedef struct RelOptInfo
322 RelOptKind reloptkind;
324 /* all relations included in this RelOptInfo */
325 Relids relids; /* set of base relids (rangetable indexes) */
327 /* size estimates generated by planner */
328 double rows; /* estimated number of result tuples */
329 int width; /* estimated avg width of result tuples */
331 /* materialization information */
332 List *reltargetlist; /* needed Vars */
333 List *pathlist; /* Path structures */
334 struct Path *cheapest_startup_path;
335 struct Path *cheapest_total_path;
336 struct Path *cheapest_unique_path;
338 /* information about a base rel (not set for join rels!) */
340 RTEKind rtekind; /* RELATION, SUBQUERY, or FUNCTION */
341 AttrNumber min_attr; /* smallest attrno of rel (often <0) */
342 AttrNumber max_attr; /* largest attrno of rel */
343 Relids *attr_needed; /* array indexed [min_attr .. max_attr] */
344 int32 *attr_widths; /* array indexed [min_attr .. max_attr] */
348 struct Plan *subplan; /* if subquery */
349 List *subrtable; /* if subquery */
351 /* used by various scans and joins: */
352 List *baserestrictinfo; /* RestrictInfo structures (if base
354 QualCost baserestrictcost; /* cost of evaluating the above */
355 List *joininfo; /* RestrictInfo structures for join clauses
356 * involving this rel */
357 bool has_eclass_joins; /* T means joininfo is incomplete */
359 /* cached info about inner indexscan paths for relation: */
360 Relids index_outer_relids; /* other relids in indexable join
362 List *index_inner_paths; /* InnerIndexscanInfo nodes */
365 * Inner indexscans are not in the main pathlist because they are not
366 * usable except in specific join contexts. We use the index_inner_paths
367 * list just to avoid recomputing the best inner indexscan repeatedly for
368 * similar outer relations. See comments for InnerIndexscanInfo.
374 * Per-index information for planning/optimization
376 * Prior to Postgres 7.0, RelOptInfo was used to describe both relations
377 * and indexes, but that created confusion without actually doing anything
378 * useful. So now we have a separate IndexOptInfo struct for indexes.
380 * opfamily[], indexkeys[], opcintype[], fwdsortop[], revsortop[],
381 * and nulls_first[] each have ncolumns entries.
382 * Note: for historical reasons, the opfamily array has an extra entry
383 * that is always zero. Some code scans until it sees a zero entry,
384 * rather than looking at ncolumns.
386 * Zeroes in the indexkeys[] array indicate index columns that are
387 * expressions; there is one element in indexprs for each such column.
389 * For an unordered index, the sortop arrays contains zeroes. Note that
390 * fwdsortop[] and nulls_first[] describe the sort ordering of a forward
391 * indexscan; we can also consider a backward indexscan, which will
392 * generate sort order described by revsortop/!nulls_first.
394 * The indexprs and indpred expressions have been run through
395 * prepqual.c and eval_const_expressions() for ease of matching to
396 * WHERE clauses. indpred is in implicit-AND form.
398 typedef struct IndexOptInfo
402 Oid indexoid; /* OID of the index relation */
403 RelOptInfo *rel; /* back-link to index's table */
405 /* statistics from pg_class */
406 BlockNumber pages; /* number of disk pages in index */
407 double tuples; /* number of index tuples in index */
409 /* index descriptor information */
410 int ncolumns; /* number of columns in index */
411 Oid *opfamily; /* OIDs of operator families for columns */
412 int *indexkeys; /* column numbers of index's keys, or 0 */
413 Oid *opcintype; /* OIDs of opclass declared input data types */
414 Oid *fwdsortop; /* OIDs of sort operators for each column */
415 Oid *revsortop; /* OIDs of sort operators for backward scan */
416 bool *nulls_first; /* do NULLs come first in the sort order? */
417 Oid relam; /* OID of the access method (in pg_am) */
419 RegProcedure amcostestimate; /* OID of the access method's cost fcn */
421 List *indexprs; /* expressions for non-simple index columns */
422 List *indpred; /* predicate if a partial index, else NIL */
424 bool predOK; /* true if predicate matches query */
425 bool unique; /* true if a unique index */
426 bool amoptionalkey; /* can query omit key for the first column? */
427 bool amsearchnulls; /* can AM search for NULL index entries? */
434 * Whenever we can determine that a mergejoinable equality clause A = B is
435 * not delayed by any outer join, we create an EquivalenceClass containing
436 * the expressions A and B to record this knowledge. If we later find another
437 * equivalence B = C, we add C to the existing EquivalenceClass; this may
438 * require merging two existing EquivalenceClasses. At the end of the qual
439 * distribution process, we have sets of values that are known all transitively
440 * equal to each other, where "equal" is according to the rules of the btree
441 * operator family(s) shown in ec_opfamilies. (We restrict an EC to contain
442 * only equalities whose operators belong to the same set of opfamilies. This
443 * could probably be relaxed, but for now it's not worth the trouble, since
444 * nearly all equality operators belong to only one btree opclass anyway.)
446 * We also use EquivalenceClasses as the base structure for PathKeys, letting
447 * us represent knowledge about different sort orderings being equivalent.
448 * Since every PathKey must reference an EquivalenceClass, we will end up
449 * with single-member EquivalenceClasses whenever a sort key expression has
450 * not been equivalenced to anything else. It is also possible that such an
451 * EquivalenceClass will contain a volatile expression ("ORDER BY random()"),
452 * which is a case that can't arise otherwise since clauses containing
453 * volatile functions are never considered mergejoinable. We mark such
454 * EquivalenceClasses specially to prevent them from being merged with
455 * ordinary EquivalenceClasses. Also, for volatile expressions we have
456 * to be careful to match the EquivalenceClass to the correct targetlist
457 * entry: consider SELECT random() AS a, random() AS b ... ORDER BY b,a.
458 * So we record the SortGroupRef of the originating sort clause.
460 * We allow equality clauses appearing below the nullable side of an outer join
461 * to form EquivalenceClasses, but these have a slightly different meaning:
462 * the included values might be all NULL rather than all the same non-null
463 * values. See src/backend/optimizer/README for more on that point.
465 * NB: if ec_merged isn't NULL, this class has been merged into another, and
466 * should be ignored in favor of using the pointed-to class.
468 typedef struct EquivalenceClass
472 List *ec_opfamilies; /* btree operator family OIDs */
473 List *ec_members; /* list of EquivalenceMembers */
474 List *ec_sources; /* list of generating RestrictInfos */
475 List *ec_derives; /* list of derived RestrictInfos */
476 Relids ec_relids; /* all relids appearing in ec_members */
477 bool ec_has_const; /* any pseudoconstants in ec_members? */
478 bool ec_has_volatile; /* the (sole) member is a volatile expr */
479 bool ec_below_outer_join; /* equivalence applies below an OJ */
480 bool ec_broken; /* failed to generate needed clauses? */
481 Index ec_sortref; /* originating sortclause label, or 0 */
482 struct EquivalenceClass *ec_merged; /* set if merged into another EC */
486 * If an EC contains a const and isn't below-outer-join, any PathKey depending
487 * on it must be redundant, since there's only one possible value of the key.
489 #define EC_MUST_BE_REDUNDANT(eclass) \
490 ((eclass)->ec_has_const && !(eclass)->ec_below_outer_join)
493 * EquivalenceMember - one member expression of an EquivalenceClass
495 * em_is_child signifies that this element was built by transposing a member
496 * for an inheritance parent relation to represent the corresponding expression
497 * on an inheritance child. The element should be ignored for all purposes
498 * except constructing inner-indexscan paths for the child relation. (Other
499 * types of join are driven from transposed joininfo-list entries.) Note
500 * that the EC's ec_relids field does NOT include the child relation.
502 * em_datatype is usually the same as exprType(em_expr), but can be
503 * different when dealing with a binary-compatible opfamily; in particular
504 * anyarray_ops would never work without this. Use em_datatype when
505 * looking up a specific btree operator to work with this expression.
507 typedef struct EquivalenceMember
511 Expr *em_expr; /* the expression represented */
512 Relids em_relids; /* all relids appearing in em_expr */
513 bool em_is_const; /* expression is pseudoconstant? */
514 bool em_is_child; /* derived version for a child relation? */
515 Oid em_datatype; /* the "nominal type" used by the opfamily */
521 * The sort ordering of a path is represented by a list of PathKey nodes.
522 * An empty list implies no known ordering. Otherwise the first item
523 * represents the primary sort key, the second the first secondary sort key,
524 * etc. The value being sorted is represented by linking to an
525 * EquivalenceClass containing that value and including pk_opfamily among its
526 * ec_opfamilies. This is a convenient method because it makes it trivial
527 * to detect equivalent and closely-related orderings. (See optimizer/README
528 * for more information.)
530 * Note: pk_strategy is either BTLessStrategyNumber (for ASC) or
531 * BTGreaterStrategyNumber (for DESC). We assume that all ordering-capable
532 * index types will use btree-compatible strategy numbers.
535 typedef struct PathKey
539 EquivalenceClass *pk_eclass; /* the value that is ordered */
540 Oid pk_opfamily; /* btree opfamily defining the ordering */
541 int pk_strategy; /* sort direction (ASC or DESC) */
542 bool pk_nulls_first; /* do NULLs come before normal values? */
546 * Type "Path" is used as-is for sequential-scan paths. For other
547 * path types it is the first component of a larger struct.
549 * Note: "pathtype" is the NodeTag of the Plan node we could build from this
550 * Path. It is partially redundant with the Path's NodeTag, but allows us
551 * to use the same Path type for multiple Plan types where there is no need
552 * to distinguish the Plan type during path processing.
559 NodeTag pathtype; /* tag identifying scan/join method */
561 RelOptInfo *parent; /* the relation this path can build */
563 /* estimated execution costs for path (see costsize.c for more info) */
564 Cost startup_cost; /* cost expended before fetching any tuples */
565 Cost total_cost; /* total cost (assuming all tuples fetched) */
567 List *pathkeys; /* sort ordering of path's output */
568 /* pathkeys is a List of PathKey nodes; see above */
572 * IndexPath represents an index scan over a single index.
574 * 'indexinfo' is the index to be scanned.
576 * 'indexclauses' is a list of index qualification clauses, with implicit
577 * AND semantics across the list. Each clause is a RestrictInfo node from
578 * the query's WHERE or JOIN conditions.
580 * 'indexquals' has the same structure as 'indexclauses', but it contains
581 * the actual indexqual conditions that can be used with the index.
582 * In simple cases this is identical to 'indexclauses', but when special
583 * indexable operators appear in 'indexclauses', they are replaced by the
584 * derived indexscannable conditions in 'indexquals'.
586 * 'isjoininner' is TRUE if the path is a nestloop inner scan (that is,
587 * some of the index conditions are join rather than restriction clauses).
588 * Note that the path costs will be calculated differently from a plain
589 * indexscan in this case, and in addition there's a special 'rows' value
590 * different from the parent RelOptInfo's (see below).
592 * 'indexscandir' is one of:
593 * ForwardScanDirection: forward scan of an ordered index
594 * BackwardScanDirection: backward scan of an ordered index
595 * NoMovementScanDirection: scan of an unordered index, or don't care
596 * (The executor doesn't care whether it gets ForwardScanDirection or
597 * NoMovementScanDirection for an indexscan, but the planner wants to
598 * distinguish ordered from unordered indexes for building pathkeys.)
600 * 'indextotalcost' and 'indexselectivity' are saved in the IndexPath so that
601 * we need not recompute them when considering using the same index in a
602 * bitmap index/heap scan (see BitmapHeapPath). The costs of the IndexPath
603 * itself represent the costs of an IndexScan plan type.
605 * 'rows' is the estimated result tuple count for the indexscan. This
606 * is the same as path.parent->rows for a simple indexscan, but it is
607 * different for a nestloop inner scan, because the additional indexquals
608 * coming from join clauses make the scan more selective than the parent
609 * rel's restrict clauses alone would do.
612 typedef struct IndexPath
615 IndexOptInfo *indexinfo;
619 ScanDirection indexscandir;
621 Selectivity indexselectivity;
622 double rows; /* estimated number of result tuples */
626 * BitmapHeapPath represents one or more indexscans that generate TID bitmaps
627 * instead of directly accessing the heap, followed by AND/OR combinations
628 * to produce a single bitmap, followed by a heap scan that uses the bitmap.
629 * Note that the output is always considered unordered, since it will come
630 * out in physical heap order no matter what the underlying indexes did.
632 * The individual indexscans are represented by IndexPath nodes, and any
633 * logic on top of them is represented by a tree of BitmapAndPath and
634 * BitmapOrPath nodes. Notice that we can use the same IndexPath node both
635 * to represent a regular IndexScan plan, and as the child of a BitmapHeapPath
636 * that represents scanning the same index using a BitmapIndexScan. The
637 * startup_cost and total_cost figures of an IndexPath always represent the
638 * costs to use it as a regular IndexScan. The costs of a BitmapIndexScan
639 * can be computed using the IndexPath's indextotalcost and indexselectivity.
641 * BitmapHeapPaths can be nestloop inner indexscans. The isjoininner and
642 * rows fields serve the same purpose as for plain IndexPaths.
644 typedef struct BitmapHeapPath
647 Path *bitmapqual; /* IndexPath, BitmapAndPath, BitmapOrPath */
648 bool isjoininner; /* T if it's a nestloop inner scan */
649 double rows; /* estimated number of result tuples */
653 * BitmapAndPath represents a BitmapAnd plan node; it can only appear as
654 * part of the substructure of a BitmapHeapPath. The Path structure is
655 * a bit more heavyweight than we really need for this, but for simplicity
656 * we make it a derivative of Path anyway.
658 typedef struct BitmapAndPath
661 List *bitmapquals; /* IndexPaths and BitmapOrPaths */
662 Selectivity bitmapselectivity;
666 * BitmapOrPath represents a BitmapOr plan node; it can only appear as
667 * part of the substructure of a BitmapHeapPath. The Path structure is
668 * a bit more heavyweight than we really need for this, but for simplicity
669 * we make it a derivative of Path anyway.
671 typedef struct BitmapOrPath
674 List *bitmapquals; /* IndexPaths and BitmapAndPaths */
675 Selectivity bitmapselectivity;
679 * TidPath represents a scan by TID
681 * tidquals is an implicitly OR'ed list of qual expressions of the form
682 * "CTID = pseudoconstant" or "CTID = ANY(pseudoconstant_array)".
683 * Note they are bare expressions, not RestrictInfos.
685 typedef struct TidPath
688 List *tidquals; /* qual(s) involving CTID = something */
692 * AppendPath represents an Append plan, ie, successive execution of
693 * several member plans.
695 * Note: it is possible for "subpaths" to contain only one, or even no,
696 * elements. These cases are optimized during create_append_plan.
697 * In particular, an AppendPath with no subpaths is a "dummy" path that
698 * is created to represent the case that a relation is provably empty.
700 typedef struct AppendPath
703 List *subpaths; /* list of component Paths */
706 #define IS_DUMMY_PATH(p) \
707 (IsA((p), AppendPath) && ((AppendPath *) (p))->subpaths == NIL)
710 * ResultPath represents use of a Result plan node to compute a variable-free
711 * targetlist with no underlying tables (a "SELECT expressions" query).
712 * The query could have a WHERE clause, too, represented by "quals".
714 * Note that quals is a list of bare clauses, not RestrictInfos.
716 typedef struct ResultPath
723 * MaterialPath represents use of a Material plan node, i.e., caching of
724 * the output of its subpath. This is used when the subpath is expensive
725 * and needs to be scanned repeatedly, or when we need mark/restore ability
726 * and the subpath doesn't have it.
728 typedef struct MaterialPath
735 * UniquePath represents elimination of distinct rows from the output of
738 * This is unlike the other Path nodes in that it can actually generate
739 * different plans: either hash-based or sort-based implementation, or a
740 * no-op if the input path can be proven distinct already. The decision
741 * is sufficiently localized that it's not worth having separate Path node
742 * types. (Note: in the no-op case, we could eliminate the UniquePath node
743 * entirely and just return the subpath; but it's convenient to have a
744 * UniquePath in the path tree to signal upper-level routines that the input
745 * is known distinct.)
749 UNIQUE_PATH_NOOP, /* input is known unique already */
750 UNIQUE_PATH_HASH, /* use hashing */
751 UNIQUE_PATH_SORT /* use sorting */
754 typedef struct UniquePath
758 UniquePathMethod umethod;
759 double rows; /* estimated number of result tuples */
763 * All join-type paths share these fields.
766 typedef struct JoinPath
772 Path *outerjoinpath; /* path for the outer side of the join */
773 Path *innerjoinpath; /* path for the inner side of the join */
775 List *joinrestrictinfo; /* RestrictInfos to apply to join */
778 * See the notes for RelOptInfo to understand why joinrestrictinfo is
779 * needed in JoinPath, and can't be merged into the parent RelOptInfo.
784 * A nested-loop path needs no special fields.
787 typedef JoinPath NestPath;
790 * A mergejoin path has these fields.
792 * path_mergeclauses lists the clauses (in the form of RestrictInfos)
793 * that will be used in the merge.
795 * Note that the mergeclauses are a subset of the parent relation's
796 * restriction-clause list. Any join clauses that are not mergejoinable
797 * appear only in the parent's restrict list, and must be checked by a
798 * qpqual at execution time.
800 * outersortkeys (resp. innersortkeys) is NIL if the outer path
801 * (resp. inner path) is already ordered appropriately for the
802 * mergejoin. If it is not NIL then it is a PathKeys list describing
803 * the ordering that must be created by an explicit sort step.
806 typedef struct MergePath
809 List *path_mergeclauses; /* join clauses to be used for merge */
810 List *outersortkeys; /* keys for explicit sort, if any */
811 List *innersortkeys; /* keys for explicit sort, if any */
815 * A hashjoin path has these fields.
817 * The remarks above for mergeclauses apply for hashclauses as well.
819 * Hashjoin does not care what order its inputs appear in, so we have
820 * no need for sortkeys.
823 typedef struct HashPath
826 List *path_hashclauses; /* join clauses used for hashing */
830 * Restriction clause info.
832 * We create one of these for each AND sub-clause of a restriction condition
833 * (WHERE or JOIN/ON clause). Since the restriction clauses are logically
834 * ANDed, we can use any one of them or any subset of them to filter out
835 * tuples, without having to evaluate the rest. The RestrictInfo node itself
836 * stores data used by the optimizer while choosing the best query plan.
838 * If a restriction clause references a single base relation, it will appear
839 * in the baserestrictinfo list of the RelOptInfo for that base rel.
841 * If a restriction clause references more than one base rel, it will
842 * appear in the joininfo list of every RelOptInfo that describes a strict
843 * subset of the base rels mentioned in the clause. The joininfo lists are
844 * used to drive join tree building by selecting plausible join candidates.
845 * The clause cannot actually be applied until we have built a join rel
846 * containing all the base rels it references, however.
848 * When we construct a join rel that includes all the base rels referenced
849 * in a multi-relation restriction clause, we place that clause into the
850 * joinrestrictinfo lists of paths for the join rel, if neither left nor
851 * right sub-path includes all base rels referenced in the clause. The clause
852 * will be applied at that join level, and will not propagate any further up
853 * the join tree. (Note: the "predicate migration" code was once intended to
854 * push restriction clauses up and down the plan tree based on evaluation
855 * costs, but it's dead code and is unlikely to be resurrected in the
856 * foreseeable future.)
858 * Note that in the presence of more than two rels, a multi-rel restriction
859 * might reach different heights in the join tree depending on the join
860 * sequence we use. So, these clauses cannot be associated directly with
861 * the join RelOptInfo, but must be kept track of on a per-join-path basis.
863 * RestrictInfos that represent equivalence conditions (i.e., mergejoinable
864 * equalities that are not outerjoin-delayed) are handled a bit differently.
865 * Initially we attach them to the EquivalenceClasses that are derived from
866 * them. When we construct a scan or join path, we look through all the
867 * EquivalenceClasses and generate derived RestrictInfos representing the
868 * minimal set of conditions that need to be checked for this particular scan
869 * or join to enforce that all members of each EquivalenceClass are in fact
870 * equal in all rows emitted by the scan or join.
872 * When dealing with outer joins we have to be very careful about pushing qual
873 * clauses up and down the tree. An outer join's own JOIN/ON conditions must
874 * be evaluated exactly at that join node, unless they are "degenerate"
875 * conditions that reference only Vars from the nullable side of the join.
876 * Quals appearing in WHERE or in a JOIN above the outer join cannot be pushed
877 * down below the outer join, if they reference any nullable Vars.
878 * RestrictInfo nodes contain a flag to indicate whether a qual has been
879 * pushed down to a lower level than its original syntactic placement in the
880 * join tree would suggest. If an outer join prevents us from pushing a qual
881 * down to its "natural" semantic level (the level associated with just the
882 * base rels used in the qual) then we mark the qual with a "required_relids"
883 * value including more than just the base rels it actually uses. By
884 * pretending that the qual references all the rels required to form the outer
885 * join, we prevent it from being evaluated below the outer join's joinrel.
886 * When we do form the outer join's joinrel, we still need to distinguish
887 * those quals that are actually in that join's JOIN/ON condition from those
888 * that appeared elsewhere in the tree and were pushed down to the join rel
889 * because they used no other rels. That's what the is_pushed_down flag is
890 * for; it tells us that a qual is not an OUTER JOIN qual for the set of base
891 * rels listed in required_relids. A clause that originally came from WHERE
892 * or an INNER JOIN condition will *always* have its is_pushed_down flag set.
893 * It's possible for an OUTER JOIN clause to be marked is_pushed_down too,
894 * if we decide that it can be pushed down into the nullable side of the join.
895 * In that case it acts as a plain filter qual for wherever it gets evaluated.
896 * (In short, is_pushed_down is only false for non-degenerate outer join
897 * conditions. Possibly we should rename it to reflect that meaning?)
899 * RestrictInfo nodes also contain an outerjoin_delayed flag, which is true
900 * if the clause's applicability must be delayed due to any outer joins
901 * appearing below its own syntactic level (ie, it references any Vars from
902 * the nullable side of any lower outer join).
904 * In general, the referenced clause might be arbitrarily complex. The
905 * kinds of clauses we can handle as indexscan quals, mergejoin clauses,
906 * or hashjoin clauses are limited (e.g., no volatile functions). The code
907 * for each kind of path is responsible for identifying the restrict clauses
908 * it can use and ignoring the rest. Clauses not implemented by an indexscan,
909 * mergejoin, or hashjoin will be placed in the plan qual or joinqual field
910 * of the finished Plan node, where they will be enforced by general-purpose
911 * qual-expression-evaluation code. (But we are still entitled to count
912 * their selectivity when estimating the result tuple count, if we
913 * can guess what it is...)
915 * When the referenced clause is an OR clause, we generate a modified copy
916 * in which additional RestrictInfo nodes are inserted below the top-level
917 * OR/AND structure. This is a convenience for OR indexscan processing:
918 * indexquals taken from either the top level or an OR subclause will have
919 * associated RestrictInfo nodes.
921 * The can_join flag is set true if the clause looks potentially useful as
922 * a merge or hash join clause, that is if it is a binary opclause with
923 * nonoverlapping sets of relids referenced in the left and right sides.
924 * (Whether the operator is actually merge or hash joinable isn't checked,
927 * The pseudoconstant flag is set true if the clause contains no Vars of
928 * the current query level and no volatile functions. Such a clause can be
929 * pulled out and used as a one-time qual in a gating Result node. We keep
930 * pseudoconstant clauses in the same lists as other RestrictInfos so that
931 * the regular clause-pushing machinery can assign them to the correct join
932 * level, but they need to be treated specially for cost and selectivity
933 * estimates. Note that a pseudoconstant clause can never be an indexqual
934 * or merge or hash join clause, so it's of no interest to large parts of
937 * When join clauses are generated from EquivalenceClasses, there may be
938 * several equally valid ways to enforce join equivalence, of which we need
939 * apply only one. We mark clauses of this kind by setting parent_ec to
940 * point to the generating EquivalenceClass. Multiple clauses with the same
941 * parent_ec in the same join are redundant.
944 typedef struct RestrictInfo
948 Expr *clause; /* the represented clause of WHERE or JOIN */
950 bool is_pushed_down; /* TRUE if clause was pushed down in level */
952 bool outerjoin_delayed; /* TRUE if delayed by lower outer join */
954 bool can_join; /* see comment above */
956 bool pseudoconstant; /* see comment above */
958 /* The set of relids (varnos) actually referenced in the clause: */
959 Relids clause_relids;
961 /* The set of relids required to evaluate the clause: */
962 Relids required_relids;
964 /* These fields are set for any binary opclause: */
965 Relids left_relids; /* relids in left side of clause */
966 Relids right_relids; /* relids in right side of clause */
968 /* This field is NULL unless clause is an OR clause: */
969 Expr *orclause; /* modified clause with RestrictInfos */
971 /* This field is NULL unless clause is potentially redundant: */
972 EquivalenceClass *parent_ec; /* generating EquivalenceClass */
974 /* cache space for cost and selectivity */
975 QualCost eval_cost; /* eval cost of clause; -1 if not yet set */
976 Selectivity this_selec; /* selectivity; -1 if not yet set */
978 /* valid if clause is mergejoinable, else NIL */
979 List *mergeopfamilies; /* opfamilies containing clause operator */
981 /* cache space for mergeclause processing; NULL if not yet set */
982 EquivalenceClass *left_ec; /* EquivalenceClass containing lefthand */
983 EquivalenceClass *right_ec; /* EquivalenceClass containing righthand */
984 EquivalenceMember *left_em; /* EquivalenceMember for lefthand */
985 EquivalenceMember *right_em; /* EquivalenceMember for righthand */
986 List *scansel_cache; /* list of MergeScanSelCache structs */
988 /* transient workspace for use while considering a specific join path */
989 bool outer_is_left; /* T = outer var on left, F = on right */
991 /* valid if clause is hashjoinable, else InvalidOid: */
992 Oid hashjoinoperator; /* copy of clause operator */
994 /* cache space for hashclause processing; -1 if not yet set */
995 Selectivity left_bucketsize; /* avg bucketsize of left side */
996 Selectivity right_bucketsize; /* avg bucketsize of right side */
1000 * Since mergejoinscansel() is a relatively expensive function, and would
1001 * otherwise be invoked many times while planning a large join tree,
1002 * we go out of our way to cache its results. Each mergejoinable
1003 * RestrictInfo carries a list of the specific sort orderings that have
1004 * been considered for use with it, and the resulting selectivities.
1006 typedef struct MergeScanSelCache
1008 /* Ordering details (cache lookup key) */
1009 Oid opfamily; /* btree opfamily defining the ordering */
1010 int strategy; /* sort direction (ASC or DESC) */
1011 bool nulls_first; /* do NULLs come before normal values? */
1013 Selectivity leftstartsel; /* first-join fraction for clause left side */
1014 Selectivity leftendsel; /* last-join fraction for clause left side */
1015 Selectivity rightstartsel; /* first-join fraction for clause right side */
1016 Selectivity rightendsel; /* last-join fraction for clause right side */
1017 } MergeScanSelCache;
1020 * Inner indexscan info.
1022 * An inner indexscan is one that uses one or more joinclauses as index
1023 * conditions (perhaps in addition to plain restriction clauses). So it
1024 * can only be used as the inner path of a nestloop join where the outer
1025 * relation includes all other relids appearing in those joinclauses.
1026 * The set of usable joinclauses, and thus the best inner indexscan,
1027 * thus varies depending on which outer relation we consider; so we have
1028 * to recompute the best such paths for every join. To avoid lots of
1029 * redundant computation, we cache the results of such searches. For
1030 * each relation we compute the set of possible otherrelids (all relids
1031 * appearing in joinquals that could become indexquals for this table).
1032 * Two outer relations whose relids have the same intersection with this
1033 * set will have the same set of available joinclauses and thus the same
1034 * best inner indexscans for the inner relation. By taking the intersection
1035 * before scanning the cache, we avoid recomputing when considering
1036 * join rels that differ only by the inclusion of irrelevant other rels.
1038 * The search key also includes a bool showing whether the join being
1039 * considered is an outer join. Since we constrain the join order for
1040 * outer joins, I believe that this bool can only have one possible value
1041 * for any particular lookup key; but store it anyway to avoid confusion.
1044 typedef struct InnerIndexscanInfo
1047 /* The lookup key: */
1048 Relids other_relids; /* a set of relevant other relids */
1049 bool isouterjoin; /* true if join is outer */
1050 /* Best paths for this lookup key (NULL if no available indexscans): */
1051 Path *cheapest_startup_innerpath; /* cheapest startup cost */
1052 Path *cheapest_total_innerpath; /* cheapest total cost */
1053 } InnerIndexscanInfo;
1058 * One-sided outer joins constrain the order of joining partially but not
1059 * completely. We flatten such joins into the planner's top-level list of
1060 * relations to join, but record information about each outer join in an
1061 * OuterJoinInfo struct. These structs are kept in the PlannerInfo node's
1064 * min_lefthand and min_righthand are the sets of base relids that must be
1065 * available on each side when performing the outer join. lhs_strict is
1066 * true if the outer join's condition cannot succeed when the LHS variables
1067 * are all NULL (this means that the outer join can commute with upper-level
1068 * outer joins even if it appears in their RHS). We don't bother to set
1069 * lhs_strict for FULL JOINs, however.
1071 * It is not valid for either min_lefthand or min_righthand to be empty sets;
1072 * if they were, this would break the logic that enforces join order.
1074 * syn_lefthand and syn_righthand are the sets of base relids that are
1075 * syntactically below this outer join. (These are needed to help compute
1076 * min_lefthand and min_righthand for higher joins, but are not used
1079 * delay_upper_joins is set TRUE if we detect a pushed-down clause that has
1080 * to be evaluated after this join is formed (because it references the RHS).
1081 * Any outer joins that have such a clause and this join in their RHS cannot
1082 * commute with this join, because that would leave noplace to check the
1083 * pushed-down clause. (We don't track this for FULL JOINs, either.)
1085 * Note: OuterJoinInfo directly represents only LEFT JOIN and FULL JOIN;
1086 * RIGHT JOIN is handled by switching the inputs to make it a LEFT JOIN.
1087 * We make an OuterJoinInfo for FULL JOINs even though there is no flexibility
1088 * of planning for them, because this simplifies make_join_rel()'s API.
1091 typedef struct OuterJoinInfo
1094 Relids min_lefthand; /* base relids in minimum LHS for join */
1095 Relids min_righthand; /* base relids in minimum RHS for join */
1096 Relids syn_lefthand; /* base relids syntactically within LHS */
1097 Relids syn_righthand; /* base relids syntactically within RHS */
1098 bool is_full_join; /* it's a FULL OUTER JOIN */
1099 bool lhs_strict; /* joinclause is strict for some LHS rel */
1100 bool delay_upper_joins; /* can't commute with upper RHS */
1106 * When we convert top-level IN quals into join operations, we must restrict
1107 * the order of joining and use special join methods at some join points.
1108 * We record information about each such IN clause in an InClauseInfo struct.
1109 * These structs are kept in the PlannerInfo node's in_info_list.
1111 * Note: sub_targetlist is a bit misnamed; it is a list of the expressions
1112 * on the RHS of the IN's join clauses. (This normally starts out as a list
1113 * of Vars referencing the subquery outputs, but can get mutated if the
1114 * subquery is flattened into the main query.)
1117 typedef struct InClauseInfo
1120 Relids lefthand; /* base relids in lefthand expressions */
1121 Relids righthand; /* base relids coming from the subselect */
1122 List *sub_targetlist; /* RHS expressions of the IN's comparisons */
1123 List *in_operators; /* OIDs of the IN's equality operators */
1127 * Append-relation info.
1129 * When we expand an inheritable table or a UNION-ALL subselect into an
1130 * "append relation" (essentially, a list of child RTEs), we build an
1131 * AppendRelInfo for each child RTE. The list of AppendRelInfos indicates
1132 * which child RTEs must be included when expanding the parent, and each
1133 * node carries information needed to translate Vars referencing the parent
1134 * into Vars referencing that child.
1136 * These structs are kept in the PlannerInfo node's append_rel_list.
1137 * Note that we just throw all the structs into one list, and scan the
1138 * whole list when desiring to expand any one parent. We could have used
1139 * a more complex data structure (eg, one list per parent), but this would
1140 * be harder to update during operations such as pulling up subqueries,
1141 * and not really any easier to scan. Considering that typical queries
1142 * will not have many different append parents, it doesn't seem worthwhile
1143 * to complicate things.
1145 * Note: after completion of the planner prep phase, any given RTE is an
1146 * append parent having entries in append_rel_list if and only if its
1147 * "inh" flag is set. We clear "inh" for plain tables that turn out not
1148 * to have inheritance children, and (in an abuse of the original meaning
1149 * of the flag) we set "inh" for subquery RTEs that turn out to be
1150 * flattenable UNION ALL queries. This lets us avoid useless searches
1151 * of append_rel_list.
1153 * Note: the data structure assumes that append-rel members are single
1154 * baserels. This is OK for inheritance, but it prevents us from pulling
1155 * up a UNION ALL member subquery if it contains a join. While that could
1156 * be fixed with a more complex data structure, at present there's not much
1157 * point because no improvement in the plan could result.
1160 typedef struct AppendRelInfo
1165 * These fields uniquely identify this append relationship. There can be
1166 * (in fact, always should be) multiple AppendRelInfos for the same
1167 * parent_relid, but never more than one per child_relid, since a given
1168 * RTE cannot be a child of more than one append parent.
1170 Index parent_relid; /* RT index of append parent rel */
1171 Index child_relid; /* RT index of append child rel */
1174 * For an inheritance appendrel, the parent and child are both regular
1175 * relations, and we store their rowtype OIDs here for use in translating
1176 * whole-row Vars. For a UNION-ALL appendrel, the parent and child are
1177 * both subqueries with no named rowtype, and we store InvalidOid here.
1179 Oid parent_reltype; /* OID of parent's composite type */
1180 Oid child_reltype; /* OID of child's composite type */
1183 * The N'th element of this list is the integer column number of the child
1184 * column corresponding to the N'th column of the parent. A list element
1185 * is zero if it corresponds to a dropped column of the parent (this is
1186 * only possible for inheritance cases, not UNION ALL).
1188 List *col_mappings; /* list of child attribute numbers */
1191 * The N'th element of this list is a Var or expression representing the
1192 * child column corresponding to the N'th column of the parent. This is
1193 * used to translate Vars referencing the parent rel into references to
1194 * the child. A list element is NULL if it corresponds to a dropped
1195 * column of the parent (this is only possible for inheritance cases, not
1198 * This might seem redundant with the col_mappings data, but it is handy
1199 * because flattening of sub-SELECTs that are members of a UNION ALL will
1200 * cause changes in the expressions that need to be substituted for a
1201 * parent Var. Adjusting this data structure lets us track what really
1202 * needs to be substituted.
1204 * Notice we only store entries for user columns (attno > 0). Whole-row
1205 * Vars are special-cased, and system columns (attno < 0) need no special
1206 * translation since their attnos are the same for all tables.
1208 * Caution: the Vars have varlevelsup = 0. Be careful to adjust as needed
1209 * when copying into a subquery.
1211 List *translated_vars; /* Expressions in the child's Vars */
1214 * We store the parent table's OID here for inheritance, or InvalidOid for
1215 * UNION ALL. This is only needed to help in generating error messages if
1216 * an attempt is made to reference a dropped parent column.
1218 Oid parent_reloid; /* OID of parent relation */
1222 * glob->paramlist keeps track of the PARAM_EXEC slots that we have decided
1223 * we need for the query. At runtime these slots are used to pass values
1224 * either down into subqueries (for outer references in subqueries) or up out
1225 * of subqueries (for the results of a subplan). The n'th entry in the list
1226 * (n counts from 0) corresponds to Param->paramid = n.
1228 * Each paramlist item shows the absolute query level it is associated with,
1229 * where the outermost query is level 1 and nested subqueries have higher
1230 * numbers. The item the parameter slot represents can be one of three kinds:
1232 * A Var: the slot represents a variable of that level that must be passed
1233 * down because subqueries have outer references to it. The varlevelsup
1234 * value in the Var will always be zero.
1236 * An Aggref (with an expression tree representing its argument): the slot
1237 * represents an aggregate expression that is an outer reference for some
1238 * subquery. The Aggref itself has agglevelsup = 0, and its argument tree
1239 * is adjusted to match in level.
1241 * A Param: the slot holds the result of a subplan (it is a setParam item
1242 * for that subplan). The absolute level shown for such items corresponds
1243 * to the parent query of the subplan.
1245 * Note: we detect duplicate Var parameters and coalesce them into one slot,
1246 * but we do not do this for Aggref or Param slots.
1248 typedef struct PlannerParamItem
1252 Node *item; /* the Var, Aggref, or Param */
1253 Index abslevel; /* its absolute query level */
1256 #endif /* RELATION_H */