1 /*-------------------------------------------------------------------------
4 * Definitions for planner's internal data structures.
7 * Portions Copyright (c) 1996-2009, 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.178 2009/10/26 02:26:43 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 List *subrowmarks; /* PlanRowMarks for SubPlan nodes */
73 Bitmapset *rewindPlanIDs; /* indices of subplans that require REWIND */
75 List *finalrtable; /* "flat" rangetable for executor */
77 List *finalrowmarks; /* "flat" list of PlanRowMarks */
79 List *relationOids; /* OIDs of relations the plan depends on */
81 List *invalItems; /* other dependencies, as PlanInvalItems */
83 Index lastPHId; /* highest PlaceHolderVar ID assigned */
85 bool transientPlan; /* redo plan when TransactionXmin changes? */
88 /* macro for fetching the Plan associated with a SubPlan node */
89 #define planner_subplan_get_plan(root, subplan) \
90 ((Plan *) list_nth((root)->glob->subplans, (subplan)->plan_id - 1))
95 * Per-query information for planning/optimization
97 * This struct is conventionally called "root" in all the planner routines.
98 * It holds links to all of the planner's working state, in addition to the
99 * original Query. Note that at present the planner extensively modifies
100 * the passed-in Query data structure; someday that should stop.
103 typedef struct PlannerInfo
107 Query *parse; /* the Query being planned */
109 PlannerGlobal *glob; /* global info for current planner run */
111 Index query_level; /* 1 at the outermost Query */
113 struct PlannerInfo *parent_root; /* NULL at outermost Query */
116 * simple_rel_array holds pointers to "base rels" and "other rels" (see
117 * comments for RelOptInfo for more info). It is indexed by rangetable
118 * index (so entry 0 is always wasted). Entries can be NULL when an RTE
119 * does not correspond to a base relation, such as a join RTE or an
120 * unreferenced view RTE; or if the RelOptInfo hasn't been made yet.
122 struct RelOptInfo **simple_rel_array; /* All 1-rel RelOptInfos */
123 int simple_rel_array_size; /* allocated size of array */
126 * simple_rte_array is the same length as simple_rel_array and holds
127 * pointers to the associated rangetable entries. This lets us avoid
128 * rt_fetch(), which can be a bit slow once large inheritance sets have
131 RangeTblEntry **simple_rte_array; /* rangetable as an array */
134 * join_rel_list is a list of all join-relation RelOptInfos we have
135 * considered in this planning run. For small problems we just scan the
136 * list to do lookups, but when there are many join relations we build a
137 * hash table for faster lookups. The hash table is present and valid
138 * when join_rel_hash is not NULL. Note that we still maintain the list
139 * even when using the hash table for lookups; this simplifies life for
142 List *join_rel_list; /* list of join-relation RelOptInfos */
143 struct HTAB *join_rel_hash; /* optional hashtable for join relations */
145 List *resultRelations; /* integer list of RT indexes, or NIL */
147 List *init_plans; /* init SubPlans for query */
149 List *cte_plan_ids; /* per-CTE-item list of subplan IDs */
151 List *eq_classes; /* list of active EquivalenceClasses */
153 List *canon_pathkeys; /* list of "canonical" PathKeys */
155 List *left_join_clauses; /* list of RestrictInfos for
156 * mergejoinable outer join clauses
157 * w/nonnullable var on left */
159 List *right_join_clauses; /* list of RestrictInfos for
160 * mergejoinable outer join clauses
161 * w/nonnullable var on right */
163 List *full_join_clauses; /* list of RestrictInfos for
164 * mergejoinable full join clauses */
166 List *join_info_list; /* list of SpecialJoinInfos */
168 List *append_rel_list; /* list of AppendRelInfos */
170 List *rowMarks; /* list of PlanRowMarks */
172 List *placeholder_list; /* list of PlaceHolderInfos */
174 List *query_pathkeys; /* desired pathkeys for query_planner(), and
175 * actual pathkeys afterwards */
177 List *group_pathkeys; /* groupClause pathkeys, if any */
178 List *window_pathkeys; /* pathkeys of bottom window, if any */
179 List *distinct_pathkeys; /* distinctClause pathkeys, if any */
180 List *sort_pathkeys; /* sortClause pathkeys, if any */
182 List *initial_rels; /* RelOptInfos we are now trying to join */
184 MemoryContext planner_cxt; /* context holding PlannerInfo */
186 double total_table_pages; /* # of pages in all tables of query */
188 double tuple_fraction; /* tuple_fraction passed to query_planner */
190 bool hasJoinRTEs; /* true if any RTEs are RTE_JOIN kind */
191 bool hasHavingQual; /* true if havingQual was non-null */
192 bool hasPseudoConstantQuals; /* true if any RestrictInfo has
193 * pseudoconstant = true */
194 bool hasRecursion; /* true if planning a recursive WITH item */
196 /* These fields are used only when hasRecursion is true: */
197 int wt_param_id; /* PARAM_EXEC ID for the work table */
198 struct Plan *non_recursive_plan; /* plan for non-recursive term */
200 /* optional private data for join_search_hook, e.g., GEQO */
201 void *join_search_private;
206 * In places where it's known that simple_rte_array[] must have been prepared
207 * already, we just index into it to fetch RTEs. In code that might be
208 * executed before or after entering query_planner(), use this macro.
210 #define planner_rt_fetch(rti, root) \
211 ((root)->simple_rte_array ? (root)->simple_rte_array[rti] : \
212 rt_fetch(rti, (root)->parse->rtable))
217 * Per-relation information for planning/optimization
219 * For planning purposes, a "base rel" is either a plain relation (a table)
220 * or the output of a sub-SELECT or function that appears in the range table.
221 * In either case it is uniquely identified by an RT index. A "joinrel"
222 * is the joining of two or more base rels. A joinrel is identified by
223 * the set of RT indexes for its component baserels. We create RelOptInfo
224 * nodes for each baserel and joinrel, and store them in the PlannerInfo's
225 * simple_rel_array and join_rel_list respectively.
227 * Note that there is only one joinrel for any given set of component
228 * baserels, no matter what order we assemble them in; so an unordered
229 * set is the right datatype to identify it with.
231 * We also have "other rels", which are like base rels in that they refer to
232 * single RT indexes; but they are not part of the join tree, and are given
233 * a different RelOptKind to identify them.
235 * Currently the only kind of otherrels are those made for member relations
236 * of an "append relation", that is an inheritance set or UNION ALL subquery.
237 * An append relation has a parent RTE that is a base rel, which represents
238 * the entire append relation. The member RTEs are otherrels. The parent
239 * is present in the query join tree but the members are not. The member
240 * RTEs and otherrels are used to plan the scans of the individual tables or
241 * subqueries of the append set; then the parent baserel is given an Append
242 * plan comprising the best plans for the individual member rels. (See
243 * comments for AppendRelInfo for more information.)
245 * At one time we also made otherrels to represent join RTEs, for use in
246 * handling join alias Vars. Currently this is not needed because all join
247 * alias Vars are expanded to non-aliased form during preprocess_expression.
249 * Parts of this data structure are specific to various scan and join
250 * mechanisms. It didn't seem worth creating new node types for them.
252 * relids - Set of base-relation identifiers; it is a base relation
253 * if there is just one, a join relation if more than one
254 * rows - estimated number of tuples in the relation after restriction
255 * clauses have been applied (ie, output rows of a plan for it)
256 * width - avg. number of bytes per tuple in the relation after the
257 * appropriate projections have been done (ie, output width)
258 * reltargetlist - List of Var and PlaceHolderVar nodes for the values
259 * we need to output from this relation.
260 * List is in no particular order, but all rels of an
261 * appendrel set must use corresponding orders.
262 * NOTE: in a child relation, may contain RowExpr or
263 * ConvertRowtypeExpr representing a whole-row Var.
264 * pathlist - List of Path nodes, one for each potentially useful
265 * method of generating the relation
266 * cheapest_startup_path - the pathlist member with lowest startup cost
267 * (regardless of its ordering)
268 * cheapest_total_path - the pathlist member with lowest total cost
269 * (regardless of its ordering)
270 * cheapest_unique_path - for caching cheapest path to produce unique
271 * (no duplicates) output from relation
273 * If the relation is a base relation it will have these fields set:
275 * relid - RTE index (this is redundant with the relids field, but
276 * is provided for convenience of access)
277 * rtekind - distinguishes plain relation, subquery, or function RTE
278 * min_attr, max_attr - range of valid AttrNumbers for rel
279 * attr_needed - array of bitmapsets indicating the highest joinrel
280 * in which each attribute is needed; if bit 0 is set then
281 * the attribute is needed as part of final targetlist
282 * attr_widths - cache space for per-attribute width estimates;
283 * zero means not computed yet
284 * indexlist - list of IndexOptInfo nodes for relation's indexes
285 * (always NIL if it's not a table)
286 * pages - number of disk pages in relation (zero if not a table)
287 * tuples - number of tuples in relation (not considering restrictions)
288 * subplan - plan for subquery (NULL if it's not a subquery)
289 * subrtable - rangetable for subquery (NIL if it's not a subquery)
290 * subrowmark - rowmarks for subquery (NIL if it's not a subquery)
292 * Note: for a subquery, tuples and subplan are not set immediately
293 * upon creation of the RelOptInfo object; they are filled in when
294 * set_base_rel_pathlist processes the object.
296 * For otherrels that are appendrel members, these fields are filled
297 * in just as for a baserel.
299 * The presence of the remaining fields depends on the restrictions
300 * and joins that the relation participates in:
302 * baserestrictinfo - List of RestrictInfo nodes, containing info about
303 * each non-join qualification clause in which this relation
304 * participates (only used for base rels)
305 * baserestrictcost - Estimated cost of evaluating the baserestrictinfo
306 * clauses at a single tuple (only used for base rels)
307 * joininfo - List of RestrictInfo nodes, containing info about each
308 * join clause in which this relation participates (but
309 * note this excludes clauses that might be derivable from
310 * EquivalenceClasses)
311 * has_eclass_joins - flag that EquivalenceClass joins are possible
312 * index_outer_relids - only used for base rels; set of outer relids
313 * that participate in indexable joinclauses for this rel
314 * index_inner_paths - only used for base rels; list of InnerIndexscanInfo
315 * nodes showing best indexpaths for various subsets of
316 * index_outer_relids.
318 * Note: Keeping a restrictinfo list in the RelOptInfo is useful only for
319 * base rels, because for a join rel the set of clauses that are treated as
320 * restrict clauses varies depending on which sub-relations we choose to join.
321 * (For example, in a 3-base-rel join, a clause relating rels 1 and 2 must be
322 * treated as a restrictclause if we join {1} and {2 3} to make {1 2 3}; but
323 * if we join {1 2} and {3} then that clause will be a restrictclause in {1 2}
324 * and should not be processed again at the level of {1 2 3}.) Therefore,
325 * the restrictinfo list in the join case appears in individual JoinPaths
326 * (field joinrestrictinfo), not in the parent relation. But it's OK for
327 * the RelOptInfo to store the joininfo list, because that is the same
328 * for a given rel no matter how we form it.
330 * We store baserestrictcost in the RelOptInfo (for base relations) because
331 * we know we will need it at least once (to price the sequential scan)
332 * and may need it multiple times to price index scans.
335 typedef enum RelOptKind
339 RELOPT_OTHER_MEMBER_REL
342 typedef struct RelOptInfo
346 RelOptKind reloptkind;
348 /* all relations included in this RelOptInfo */
349 Relids relids; /* set of base relids (rangetable indexes) */
351 /* size estimates generated by planner */
352 double rows; /* estimated number of result tuples */
353 int width; /* estimated avg width of result tuples */
355 /* materialization information */
356 List *reltargetlist; /* Vars to be output by scan of relation */
357 List *pathlist; /* Path structures */
358 struct Path *cheapest_startup_path;
359 struct Path *cheapest_total_path;
360 struct Path *cheapest_unique_path;
362 /* information about a base rel (not set for join rels!) */
364 RTEKind rtekind; /* RELATION, SUBQUERY, or FUNCTION */
365 AttrNumber min_attr; /* smallest attrno of rel (often <0) */
366 AttrNumber max_attr; /* largest attrno of rel */
367 Relids *attr_needed; /* array indexed [min_attr .. max_attr] */
368 int32 *attr_widths; /* array indexed [min_attr .. max_attr] */
369 List *indexlist; /* list of IndexOptInfo */
372 struct Plan *subplan; /* if subquery */
373 List *subrtable; /* if subquery */
374 List *subrowmark; /* if subquery */
376 /* used by various scans and joins: */
377 List *baserestrictinfo; /* RestrictInfo structures (if base
379 QualCost baserestrictcost; /* cost of evaluating the above */
380 List *joininfo; /* RestrictInfo structures for join clauses
381 * involving this rel */
382 bool has_eclass_joins; /* T means joininfo is incomplete */
384 /* cached info about inner indexscan paths for relation: */
385 Relids index_outer_relids; /* other relids in indexable join
387 List *index_inner_paths; /* InnerIndexscanInfo nodes */
390 * Inner indexscans are not in the main pathlist because they are not
391 * usable except in specific join contexts. We use the index_inner_paths
392 * list just to avoid recomputing the best inner indexscan repeatedly for
393 * similar outer relations. See comments for InnerIndexscanInfo.
399 * Per-index information for planning/optimization
401 * Prior to Postgres 7.0, RelOptInfo was used to describe both relations
402 * and indexes, but that created confusion without actually doing anything
403 * useful. So now we have a separate IndexOptInfo struct for indexes.
405 * opfamily[], indexkeys[], opcintype[], fwdsortop[], revsortop[],
406 * and nulls_first[] each have ncolumns entries.
407 * Note: for historical reasons, the opfamily array has an extra entry
408 * that is always zero. Some code scans until it sees a zero entry,
409 * rather than looking at ncolumns.
411 * Zeroes in the indexkeys[] array indicate index columns that are
412 * expressions; there is one element in indexprs for each such column.
414 * For an unordered index, the sortop arrays contains zeroes. Note that
415 * fwdsortop[] and nulls_first[] describe the sort ordering of a forward
416 * indexscan; we can also consider a backward indexscan, which will
417 * generate sort order described by revsortop/!nulls_first.
419 * The indexprs and indpred expressions have been run through
420 * prepqual.c and eval_const_expressions() for ease of matching to
421 * WHERE clauses. indpred is in implicit-AND form.
423 typedef struct IndexOptInfo
427 Oid indexoid; /* OID of the index relation */
428 RelOptInfo *rel; /* back-link to index's table */
430 /* statistics from pg_class */
431 BlockNumber pages; /* number of disk pages in index */
432 double tuples; /* number of index tuples in index */
434 /* index descriptor information */
435 int ncolumns; /* number of columns in index */
436 Oid *opfamily; /* OIDs of operator families for columns */
437 int *indexkeys; /* column numbers of index's keys, or 0 */
438 Oid *opcintype; /* OIDs of opclass declared input data types */
439 Oid *fwdsortop; /* OIDs of sort operators for each column */
440 Oid *revsortop; /* OIDs of sort operators for backward scan */
441 bool *nulls_first; /* do NULLs come first in the sort order? */
442 Oid relam; /* OID of the access method (in pg_am) */
444 RegProcedure amcostestimate; /* OID of the access method's cost fcn */
446 List *indexprs; /* expressions for non-simple index columns */
447 List *indpred; /* predicate if a partial index, else NIL */
449 bool predOK; /* true if predicate matches query */
450 bool unique; /* true if a unique index */
451 bool amoptionalkey; /* can query omit key for the first column? */
452 bool amsearchnulls; /* can AM search for NULL index entries? */
453 bool amhasgettuple; /* does AM have amgettuple interface? */
454 bool amhasgetbitmap; /* does AM have amgetbitmap interface? */
461 * Whenever we can determine that a mergejoinable equality clause A = B is
462 * not delayed by any outer join, we create an EquivalenceClass containing
463 * the expressions A and B to record this knowledge. If we later find another
464 * equivalence B = C, we add C to the existing EquivalenceClass; this may
465 * require merging two existing EquivalenceClasses. At the end of the qual
466 * distribution process, we have sets of values that are known all transitively
467 * equal to each other, where "equal" is according to the rules of the btree
468 * operator family(s) shown in ec_opfamilies. (We restrict an EC to contain
469 * only equalities whose operators belong to the same set of opfamilies. This
470 * could probably be relaxed, but for now it's not worth the trouble, since
471 * nearly all equality operators belong to only one btree opclass anyway.)
473 * We also use EquivalenceClasses as the base structure for PathKeys, letting
474 * us represent knowledge about different sort orderings being equivalent.
475 * Since every PathKey must reference an EquivalenceClass, we will end up
476 * with single-member EquivalenceClasses whenever a sort key expression has
477 * not been equivalenced to anything else. It is also possible that such an
478 * EquivalenceClass will contain a volatile expression ("ORDER BY random()"),
479 * which is a case that can't arise otherwise since clauses containing
480 * volatile functions are never considered mergejoinable. We mark such
481 * EquivalenceClasses specially to prevent them from being merged with
482 * ordinary EquivalenceClasses. Also, for volatile expressions we have
483 * to be careful to match the EquivalenceClass to the correct targetlist
484 * entry: consider SELECT random() AS a, random() AS b ... ORDER BY b,a.
485 * So we record the SortGroupRef of the originating sort clause.
487 * We allow equality clauses appearing below the nullable side of an outer join
488 * to form EquivalenceClasses, but these have a slightly different meaning:
489 * the included values might be all NULL rather than all the same non-null
490 * values. See src/backend/optimizer/README for more on that point.
492 * NB: if ec_merged isn't NULL, this class has been merged into another, and
493 * should be ignored in favor of using the pointed-to class.
495 typedef struct EquivalenceClass
499 List *ec_opfamilies; /* btree operator family OIDs */
500 List *ec_members; /* list of EquivalenceMembers */
501 List *ec_sources; /* list of generating RestrictInfos */
502 List *ec_derives; /* list of derived RestrictInfos */
503 Relids ec_relids; /* all relids appearing in ec_members */
504 bool ec_has_const; /* any pseudoconstants in ec_members? */
505 bool ec_has_volatile; /* the (sole) member is a volatile expr */
506 bool ec_below_outer_join; /* equivalence applies below an OJ */
507 bool ec_broken; /* failed to generate needed clauses? */
508 Index ec_sortref; /* originating sortclause label, or 0 */
509 struct EquivalenceClass *ec_merged; /* set if merged into another EC */
513 * If an EC contains a const and isn't below-outer-join, any PathKey depending
514 * on it must be redundant, since there's only one possible value of the key.
516 #define EC_MUST_BE_REDUNDANT(eclass) \
517 ((eclass)->ec_has_const && !(eclass)->ec_below_outer_join)
520 * EquivalenceMember - one member expression of an EquivalenceClass
522 * em_is_child signifies that this element was built by transposing a member
523 * for an inheritance parent relation to represent the corresponding expression
524 * on an inheritance child. The element should be ignored for all purposes
525 * except constructing inner-indexscan paths for the child relation. (Other
526 * types of join are driven from transposed joininfo-list entries.) Note
527 * that the EC's ec_relids field does NOT include the child relation.
529 * em_datatype is usually the same as exprType(em_expr), but can be
530 * different when dealing with a binary-compatible opfamily; in particular
531 * anyarray_ops would never work without this. Use em_datatype when
532 * looking up a specific btree operator to work with this expression.
534 typedef struct EquivalenceMember
538 Expr *em_expr; /* the expression represented */
539 Relids em_relids; /* all relids appearing in em_expr */
540 bool em_is_const; /* expression is pseudoconstant? */
541 bool em_is_child; /* derived version for a child relation? */
542 Oid em_datatype; /* the "nominal type" used by the opfamily */
548 * The sort ordering of a path is represented by a list of PathKey nodes.
549 * An empty list implies no known ordering. Otherwise the first item
550 * represents the primary sort key, the second the first secondary sort key,
551 * etc. The value being sorted is represented by linking to an
552 * EquivalenceClass containing that value and including pk_opfamily among its
553 * ec_opfamilies. This is a convenient method because it makes it trivial
554 * to detect equivalent and closely-related orderings. (See optimizer/README
555 * for more information.)
557 * Note: pk_strategy is either BTLessStrategyNumber (for ASC) or
558 * BTGreaterStrategyNumber (for DESC). We assume that all ordering-capable
559 * index types will use btree-compatible strategy numbers.
562 typedef struct PathKey
566 EquivalenceClass *pk_eclass; /* the value that is ordered */
567 Oid pk_opfamily; /* btree opfamily defining the ordering */
568 int pk_strategy; /* sort direction (ASC or DESC) */
569 bool pk_nulls_first; /* do NULLs come before normal values? */
573 * Type "Path" is used as-is for sequential-scan paths, as well as some other
574 * simple plan types that we don't need any extra information in the path for.
575 * For other path types it is the first component of a larger struct.
577 * Note: "pathtype" is the NodeTag of the Plan node we could build from this
578 * Path. It is partially redundant with the Path's NodeTag, but allows us
579 * to use the same Path type for multiple Plan types where there is no need
580 * to distinguish the Plan type during path processing.
587 NodeTag pathtype; /* tag identifying scan/join method */
589 RelOptInfo *parent; /* the relation this path can build */
591 /* estimated execution costs for path (see costsize.c for more info) */
592 Cost startup_cost; /* cost expended before fetching any tuples */
593 Cost total_cost; /* total cost (assuming all tuples fetched) */
595 List *pathkeys; /* sort ordering of path's output */
596 /* pathkeys is a List of PathKey nodes; see above */
600 * IndexPath represents an index scan over a single index.
602 * 'indexinfo' is the index to be scanned.
604 * 'indexclauses' is a list of index qualification clauses, with implicit
605 * AND semantics across the list. Each clause is a RestrictInfo node from
606 * the query's WHERE or JOIN conditions.
608 * 'indexquals' has the same structure as 'indexclauses', but it contains
609 * the actual indexqual conditions that can be used with the index.
610 * In simple cases this is identical to 'indexclauses', but when special
611 * indexable operators appear in 'indexclauses', they are replaced by the
612 * derived indexscannable conditions in 'indexquals'.
614 * 'isjoininner' is TRUE if the path is a nestloop inner scan (that is,
615 * some of the index conditions are join rather than restriction clauses).
616 * Note that the path costs will be calculated differently from a plain
617 * indexscan in this case, and in addition there's a special 'rows' value
618 * different from the parent RelOptInfo's (see below).
620 * 'indexscandir' is one of:
621 * ForwardScanDirection: forward scan of an ordered index
622 * BackwardScanDirection: backward scan of an ordered index
623 * NoMovementScanDirection: scan of an unordered index, or don't care
624 * (The executor doesn't care whether it gets ForwardScanDirection or
625 * NoMovementScanDirection for an indexscan, but the planner wants to
626 * distinguish ordered from unordered indexes for building pathkeys.)
628 * 'indextotalcost' and 'indexselectivity' are saved in the IndexPath so that
629 * we need not recompute them when considering using the same index in a
630 * bitmap index/heap scan (see BitmapHeapPath). The costs of the IndexPath
631 * itself represent the costs of an IndexScan plan type.
633 * 'rows' is the estimated result tuple count for the indexscan. This
634 * is the same as path.parent->rows for a simple indexscan, but it is
635 * different for a nestloop inner scan, because the additional indexquals
636 * coming from join clauses make the scan more selective than the parent
637 * rel's restrict clauses alone would do.
640 typedef struct IndexPath
643 IndexOptInfo *indexinfo;
647 ScanDirection indexscandir;
649 Selectivity indexselectivity;
650 double rows; /* estimated number of result tuples */
654 * BitmapHeapPath represents one or more indexscans that generate TID bitmaps
655 * instead of directly accessing the heap, followed by AND/OR combinations
656 * to produce a single bitmap, followed by a heap scan that uses the bitmap.
657 * Note that the output is always considered unordered, since it will come
658 * out in physical heap order no matter what the underlying indexes did.
660 * The individual indexscans are represented by IndexPath nodes, and any
661 * logic on top of them is represented by a tree of BitmapAndPath and
662 * BitmapOrPath nodes. Notice that we can use the same IndexPath node both
663 * to represent a regular IndexScan plan, and as the child of a BitmapHeapPath
664 * that represents scanning the same index using a BitmapIndexScan. The
665 * startup_cost and total_cost figures of an IndexPath always represent the
666 * costs to use it as a regular IndexScan. The costs of a BitmapIndexScan
667 * can be computed using the IndexPath's indextotalcost and indexselectivity.
669 * BitmapHeapPaths can be nestloop inner indexscans. The isjoininner and
670 * rows fields serve the same purpose as for plain IndexPaths.
672 typedef struct BitmapHeapPath
675 Path *bitmapqual; /* IndexPath, BitmapAndPath, BitmapOrPath */
676 bool isjoininner; /* T if it's a nestloop inner scan */
677 double rows; /* estimated number of result tuples */
681 * BitmapAndPath represents a BitmapAnd plan node; it can only appear as
682 * part of the substructure of a BitmapHeapPath. The Path structure is
683 * a bit more heavyweight than we really need for this, but for simplicity
684 * we make it a derivative of Path anyway.
686 typedef struct BitmapAndPath
689 List *bitmapquals; /* IndexPaths and BitmapOrPaths */
690 Selectivity bitmapselectivity;
694 * BitmapOrPath represents a BitmapOr plan node; it can only appear as
695 * part of the substructure of a BitmapHeapPath. The Path structure is
696 * a bit more heavyweight than we really need for this, but for simplicity
697 * we make it a derivative of Path anyway.
699 typedef struct BitmapOrPath
702 List *bitmapquals; /* IndexPaths and BitmapAndPaths */
703 Selectivity bitmapselectivity;
707 * TidPath represents a scan by TID
709 * tidquals is an implicitly OR'ed list of qual expressions of the form
710 * "CTID = pseudoconstant" or "CTID = ANY(pseudoconstant_array)".
711 * Note they are bare expressions, not RestrictInfos.
713 typedef struct TidPath
716 List *tidquals; /* qual(s) involving CTID = something */
720 * AppendPath represents an Append plan, ie, successive execution of
721 * several member plans.
723 * Note: it is possible for "subpaths" to contain only one, or even no,
724 * elements. These cases are optimized during create_append_plan.
725 * In particular, an AppendPath with no subpaths is a "dummy" path that
726 * is created to represent the case that a relation is provably empty.
728 typedef struct AppendPath
731 List *subpaths; /* list of component Paths */
734 #define IS_DUMMY_PATH(p) \
735 (IsA((p), AppendPath) && ((AppendPath *) (p))->subpaths == NIL)
738 * ResultPath represents use of a Result plan node to compute a variable-free
739 * targetlist with no underlying tables (a "SELECT expressions" query).
740 * The query could have a WHERE clause, too, represented by "quals".
742 * Note that quals is a list of bare clauses, not RestrictInfos.
744 typedef struct ResultPath
751 * MaterialPath represents use of a Material plan node, i.e., caching of
752 * the output of its subpath. This is used when the subpath is expensive
753 * and needs to be scanned repeatedly, or when we need mark/restore ability
754 * and the subpath doesn't have it.
756 typedef struct MaterialPath
763 * UniquePath represents elimination of distinct rows from the output of
766 * This is unlike the other Path nodes in that it can actually generate
767 * different plans: either hash-based or sort-based implementation, or a
768 * no-op if the input path can be proven distinct already. The decision
769 * is sufficiently localized that it's not worth having separate Path node
770 * types. (Note: in the no-op case, we could eliminate the UniquePath node
771 * entirely and just return the subpath; but it's convenient to have a
772 * UniquePath in the path tree to signal upper-level routines that the input
773 * is known distinct.)
777 UNIQUE_PATH_NOOP, /* input is known unique already */
778 UNIQUE_PATH_HASH, /* use hashing */
779 UNIQUE_PATH_SORT /* use sorting */
782 typedef struct UniquePath
786 UniquePathMethod umethod;
787 List *in_operators; /* equality operators of the IN clause */
788 List *uniq_exprs; /* expressions to be made unique */
789 double rows; /* estimated number of result tuples */
793 * NoOpPath represents exactly the same plan as its subpath. This is used
794 * when we have determined that a join can be eliminated. The difference
795 * between the NoOpPath and its subpath is just that the NoOpPath's parent
796 * is the whole join relation while the subpath is for one of the joined
797 * relations (and the other one isn't needed).
799 * Note: path.pathtype is always T_Join, but this won't actually give rise
800 * to a Join plan node.
802 typedef struct NoOpPath
809 * All join-type paths share these fields.
812 typedef struct JoinPath
818 Path *outerjoinpath; /* path for the outer side of the join */
819 Path *innerjoinpath; /* path for the inner side of the join */
821 List *joinrestrictinfo; /* RestrictInfos to apply to join */
824 * See the notes for RelOptInfo to understand why joinrestrictinfo is
825 * needed in JoinPath, and can't be merged into the parent RelOptInfo.
830 * A nested-loop path needs no special fields.
833 typedef JoinPath NestPath;
836 * A mergejoin path has these fields.
838 * path_mergeclauses lists the clauses (in the form of RestrictInfos)
839 * that will be used in the merge.
841 * Note that the mergeclauses are a subset of the parent relation's
842 * restriction-clause list. Any join clauses that are not mergejoinable
843 * appear only in the parent's restrict list, and must be checked by a
844 * qpqual at execution time.
846 * outersortkeys (resp. innersortkeys) is NIL if the outer path
847 * (resp. inner path) is already ordered appropriately for the
848 * mergejoin. If it is not NIL then it is a PathKeys list describing
849 * the ordering that must be created by an explicit sort step.
852 typedef struct MergePath
855 List *path_mergeclauses; /* join clauses to be used for merge */
856 List *outersortkeys; /* keys for explicit sort, if any */
857 List *innersortkeys; /* keys for explicit sort, if any */
861 * A hashjoin path has these fields.
863 * The remarks above for mergeclauses apply for hashclauses as well.
865 * Hashjoin does not care what order its inputs appear in, so we have
866 * no need for sortkeys.
869 typedef struct HashPath
872 List *path_hashclauses; /* join clauses used for hashing */
873 int num_batches; /* number of batches expected */
877 * Restriction clause info.
879 * We create one of these for each AND sub-clause of a restriction condition
880 * (WHERE or JOIN/ON clause). Since the restriction clauses are logically
881 * ANDed, we can use any one of them or any subset of them to filter out
882 * tuples, without having to evaluate the rest. The RestrictInfo node itself
883 * stores data used by the optimizer while choosing the best query plan.
885 * If a restriction clause references a single base relation, it will appear
886 * in the baserestrictinfo list of the RelOptInfo for that base rel.
888 * If a restriction clause references more than one base rel, it will
889 * appear in the joininfo list of every RelOptInfo that describes a strict
890 * subset of the base rels mentioned in the clause. The joininfo lists are
891 * used to drive join tree building by selecting plausible join candidates.
892 * The clause cannot actually be applied until we have built a join rel
893 * containing all the base rels it references, however.
895 * When we construct a join rel that includes all the base rels referenced
896 * in a multi-relation restriction clause, we place that clause into the
897 * joinrestrictinfo lists of paths for the join rel, if neither left nor
898 * right sub-path includes all base rels referenced in the clause. The clause
899 * will be applied at that join level, and will not propagate any further up
900 * the join tree. (Note: the "predicate migration" code was once intended to
901 * push restriction clauses up and down the plan tree based on evaluation
902 * costs, but it's dead code and is unlikely to be resurrected in the
903 * foreseeable future.)
905 * Note that in the presence of more than two rels, a multi-rel restriction
906 * might reach different heights in the join tree depending on the join
907 * sequence we use. So, these clauses cannot be associated directly with
908 * the join RelOptInfo, but must be kept track of on a per-join-path basis.
910 * RestrictInfos that represent equivalence conditions (i.e., mergejoinable
911 * equalities that are not outerjoin-delayed) are handled a bit differently.
912 * Initially we attach them to the EquivalenceClasses that are derived from
913 * them. When we construct a scan or join path, we look through all the
914 * EquivalenceClasses and generate derived RestrictInfos representing the
915 * minimal set of conditions that need to be checked for this particular scan
916 * or join to enforce that all members of each EquivalenceClass are in fact
917 * equal in all rows emitted by the scan or join.
919 * When dealing with outer joins we have to be very careful about pushing qual
920 * clauses up and down the tree. An outer join's own JOIN/ON conditions must
921 * be evaluated exactly at that join node, unless they are "degenerate"
922 * conditions that reference only Vars from the nullable side of the join.
923 * Quals appearing in WHERE or in a JOIN above the outer join cannot be pushed
924 * down below the outer join, if they reference any nullable Vars.
925 * RestrictInfo nodes contain a flag to indicate whether a qual has been
926 * pushed down to a lower level than its original syntactic placement in the
927 * join tree would suggest. If an outer join prevents us from pushing a qual
928 * down to its "natural" semantic level (the level associated with just the
929 * base rels used in the qual) then we mark the qual with a "required_relids"
930 * value including more than just the base rels it actually uses. By
931 * pretending that the qual references all the rels required to form the outer
932 * join, we prevent it from being evaluated below the outer join's joinrel.
933 * When we do form the outer join's joinrel, we still need to distinguish
934 * those quals that are actually in that join's JOIN/ON condition from those
935 * that appeared elsewhere in the tree and were pushed down to the join rel
936 * because they used no other rels. That's what the is_pushed_down flag is
937 * for; it tells us that a qual is not an OUTER JOIN qual for the set of base
938 * rels listed in required_relids. A clause that originally came from WHERE
939 * or an INNER JOIN condition will *always* have its is_pushed_down flag set.
940 * It's possible for an OUTER JOIN clause to be marked is_pushed_down too,
941 * if we decide that it can be pushed down into the nullable side of the join.
942 * In that case it acts as a plain filter qual for wherever it gets evaluated.
943 * (In short, is_pushed_down is only false for non-degenerate outer join
944 * conditions. Possibly we should rename it to reflect that meaning?)
946 * RestrictInfo nodes also contain an outerjoin_delayed flag, which is true
947 * if the clause's applicability must be delayed due to any outer joins
948 * appearing below it (ie, it has to be postponed to some join level higher
949 * than the set of relations it actually references). There is also a
950 * nullable_relids field, which is the set of rels it references that can be
951 * forced null by some outer join below the clause. outerjoin_delayed = true
952 * is subtly different from nullable_relids != NULL: a clause might reference
953 * some nullable rels and yet not be outerjoin_delayed because it also
954 * references all the other rels of the outer join(s). A clause that is not
955 * outerjoin_delayed can be enforced anywhere it is computable.
957 * In general, the referenced clause might be arbitrarily complex. The
958 * kinds of clauses we can handle as indexscan quals, mergejoin clauses,
959 * or hashjoin clauses are limited (e.g., no volatile functions). The code
960 * for each kind of path is responsible for identifying the restrict clauses
961 * it can use and ignoring the rest. Clauses not implemented by an indexscan,
962 * mergejoin, or hashjoin will be placed in the plan qual or joinqual field
963 * of the finished Plan node, where they will be enforced by general-purpose
964 * qual-expression-evaluation code. (But we are still entitled to count
965 * their selectivity when estimating the result tuple count, if we
966 * can guess what it is...)
968 * When the referenced clause is an OR clause, we generate a modified copy
969 * in which additional RestrictInfo nodes are inserted below the top-level
970 * OR/AND structure. This is a convenience for OR indexscan processing:
971 * indexquals taken from either the top level or an OR subclause will have
972 * associated RestrictInfo nodes.
974 * The can_join flag is set true if the clause looks potentially useful as
975 * a merge or hash join clause, that is if it is a binary opclause with
976 * nonoverlapping sets of relids referenced in the left and right sides.
977 * (Whether the operator is actually merge or hash joinable isn't checked,
980 * The pseudoconstant flag is set true if the clause contains no Vars of
981 * the current query level and no volatile functions. Such a clause can be
982 * pulled out and used as a one-time qual in a gating Result node. We keep
983 * pseudoconstant clauses in the same lists as other RestrictInfos so that
984 * the regular clause-pushing machinery can assign them to the correct join
985 * level, but they need to be treated specially for cost and selectivity
986 * estimates. Note that a pseudoconstant clause can never be an indexqual
987 * or merge or hash join clause, so it's of no interest to large parts of
990 * When join clauses are generated from EquivalenceClasses, there may be
991 * several equally valid ways to enforce join equivalence, of which we need
992 * apply only one. We mark clauses of this kind by setting parent_ec to
993 * point to the generating EquivalenceClass. Multiple clauses with the same
994 * parent_ec in the same join are redundant.
997 typedef struct RestrictInfo
1001 Expr *clause; /* the represented clause of WHERE or JOIN */
1003 bool is_pushed_down; /* TRUE if clause was pushed down in level */
1005 bool outerjoin_delayed; /* TRUE if delayed by lower outer join */
1007 bool can_join; /* see comment above */
1009 bool pseudoconstant; /* see comment above */
1011 /* The set of relids (varnos) actually referenced in the clause: */
1012 Relids clause_relids;
1014 /* The set of relids required to evaluate the clause: */
1015 Relids required_relids;
1017 /* The relids used in the clause that are nullable by lower outer joins: */
1018 Relids nullable_relids;
1020 /* These fields are set for any binary opclause: */
1021 Relids left_relids; /* relids in left side of clause */
1022 Relids right_relids; /* relids in right side of clause */
1024 /* This field is NULL unless clause is an OR clause: */
1025 Expr *orclause; /* modified clause with RestrictInfos */
1027 /* This field is NULL unless clause is potentially redundant: */
1028 EquivalenceClass *parent_ec; /* generating EquivalenceClass */
1030 /* cache space for cost and selectivity */
1031 QualCost eval_cost; /* eval cost of clause; -1 if not yet set */
1032 Selectivity norm_selec; /* selectivity for "normal" (JOIN_INNER)
1033 * semantics; -1 if not yet set; >1 means a
1034 * redundant clause */
1035 Selectivity outer_selec; /* selectivity for outer join semantics; -1 if
1038 /* valid if clause is mergejoinable, else NIL */
1039 List *mergeopfamilies; /* opfamilies containing clause operator */
1041 /* cache space for mergeclause processing; NULL if not yet set */
1042 EquivalenceClass *left_ec; /* EquivalenceClass containing lefthand */
1043 EquivalenceClass *right_ec; /* EquivalenceClass containing righthand */
1044 EquivalenceMember *left_em; /* EquivalenceMember for lefthand */
1045 EquivalenceMember *right_em; /* EquivalenceMember for righthand */
1046 List *scansel_cache; /* list of MergeScanSelCache structs */
1048 /* transient workspace for use while considering a specific join path */
1049 bool outer_is_left; /* T = outer var on left, F = on right */
1051 /* valid if clause is hashjoinable, else InvalidOid: */
1052 Oid hashjoinoperator; /* copy of clause operator */
1054 /* cache space for hashclause processing; -1 if not yet set */
1055 Selectivity left_bucketsize; /* avg bucketsize of left side */
1056 Selectivity right_bucketsize; /* avg bucketsize of right side */
1060 * Since mergejoinscansel() is a relatively expensive function, and would
1061 * otherwise be invoked many times while planning a large join tree,
1062 * we go out of our way to cache its results. Each mergejoinable
1063 * RestrictInfo carries a list of the specific sort orderings that have
1064 * been considered for use with it, and the resulting selectivities.
1066 typedef struct MergeScanSelCache
1068 /* Ordering details (cache lookup key) */
1069 Oid opfamily; /* btree opfamily defining the ordering */
1070 int strategy; /* sort direction (ASC or DESC) */
1071 bool nulls_first; /* do NULLs come before normal values? */
1073 Selectivity leftstartsel; /* first-join fraction for clause left side */
1074 Selectivity leftendsel; /* last-join fraction for clause left side */
1075 Selectivity rightstartsel; /* first-join fraction for clause right side */
1076 Selectivity rightendsel; /* last-join fraction for clause right side */
1077 } MergeScanSelCache;
1080 * Inner indexscan info.
1082 * An inner indexscan is one that uses one or more joinclauses as index
1083 * conditions (perhaps in addition to plain restriction clauses). So it
1084 * can only be used as the inner path of a nestloop join where the outer
1085 * relation includes all other relids appearing in those joinclauses.
1086 * The set of usable joinclauses, and thus the best inner indexscan,
1087 * thus varies depending on which outer relation we consider; so we have
1088 * to recompute the best such paths for every join. To avoid lots of
1089 * redundant computation, we cache the results of such searches. For
1090 * each relation we compute the set of possible otherrelids (all relids
1091 * appearing in joinquals that could become indexquals for this table).
1092 * Two outer relations whose relids have the same intersection with this
1093 * set will have the same set of available joinclauses and thus the same
1094 * best inner indexscans for the inner relation. By taking the intersection
1095 * before scanning the cache, we avoid recomputing when considering
1096 * join rels that differ only by the inclusion of irrelevant other rels.
1098 * The search key also includes a bool showing whether the join being
1099 * considered is an outer join. Since we constrain the join order for
1100 * outer joins, I believe that this bool can only have one possible value
1101 * for any particular lookup key; but store it anyway to avoid confusion.
1104 typedef struct InnerIndexscanInfo
1107 /* The lookup key: */
1108 Relids other_relids; /* a set of relevant other relids */
1109 bool isouterjoin; /* true if join is outer */
1110 /* Best paths for this lookup key (NULL if no available indexscans): */
1111 Path *cheapest_startup_innerpath; /* cheapest startup cost */
1112 Path *cheapest_total_innerpath; /* cheapest total cost */
1113 } InnerIndexscanInfo;
1116 * Placeholder node for an expression to be evaluated below the top level
1117 * of a plan tree. This is used during planning to represent the contained
1118 * expression. At the end of the planning process it is replaced by either
1119 * the contained expression or a Var referring to a lower-level evaluation of
1120 * the contained expression. Typically the evaluation occurs below an outer
1121 * join, and Var references above the outer join might thereby yield NULL
1122 * instead of the expression value.
1124 * Although the planner treats this as an expression node type, it is not
1125 * recognized by the parser or executor, so we declare it here rather than
1129 typedef struct PlaceHolderVar
1132 Expr *phexpr; /* the represented expression */
1133 Relids phrels; /* base relids syntactically within expr src */
1134 Index phid; /* ID for PHV (unique within planner run) */
1135 Index phlevelsup; /* > 0 if PHV belongs to outer query */
1139 * "Special join" info.
1141 * One-sided outer joins constrain the order of joining partially but not
1142 * completely. We flatten such joins into the planner's top-level list of
1143 * relations to join, but record information about each outer join in a
1144 * SpecialJoinInfo struct. These structs are kept in the PlannerInfo node's
1147 * Similarly, semijoins and antijoins created by flattening IN (subselect)
1148 * and EXISTS(subselect) clauses create partial constraints on join order.
1149 * These are likewise recorded in SpecialJoinInfo structs.
1151 * We make SpecialJoinInfos for FULL JOINs even though there is no flexibility
1152 * of planning for them, because this simplifies make_join_rel()'s API.
1154 * min_lefthand and min_righthand are the sets of base relids that must be
1155 * available on each side when performing the special join. lhs_strict is
1156 * true if the special join's condition cannot succeed when the LHS variables
1157 * are all NULL (this means that an outer join can commute with upper-level
1158 * outer joins even if it appears in their RHS). We don't bother to set
1159 * lhs_strict for FULL JOINs, however.
1161 * It is not valid for either min_lefthand or min_righthand to be empty sets;
1162 * if they were, this would break the logic that enforces join order.
1164 * syn_lefthand and syn_righthand are the sets of base relids that are
1165 * syntactically below this special join. (These are needed to help compute
1166 * min_lefthand and min_righthand for higher joins.)
1168 * delay_upper_joins is set TRUE if we detect a pushed-down clause that has
1169 * to be evaluated after this join is formed (because it references the RHS).
1170 * Any outer joins that have such a clause and this join in their RHS cannot
1171 * commute with this join, because that would leave noplace to check the
1172 * pushed-down clause. (We don't track this for FULL JOINs, either.)
1174 * join_quals is an implicit-AND list of the quals syntactically associated
1175 * with the join (they may or may not end up being applied at the join level).
1176 * This is just a side list and does not drive actual application of quals.
1177 * For JOIN_SEMI joins, this is cleared to NIL in create_unique_path() if
1178 * the join is found not to be suitable for a uniqueify-the-RHS plan.
1180 * jointype is never JOIN_RIGHT; a RIGHT JOIN is handled by switching
1181 * the inputs to make it a LEFT JOIN. So the allowed values of jointype
1182 * in a join_info_list member are only LEFT, FULL, SEMI, or ANTI.
1184 * For purposes of join selectivity estimation, we create transient
1185 * SpecialJoinInfo structures for regular inner joins; so it is possible
1186 * to have jointype == JOIN_INNER in such a structure, even though this is
1187 * not allowed within join_info_list. We also create transient
1188 * SpecialJoinInfos with jointype == JOIN_INNER for outer joins, since for
1189 * cost estimation purposes it is sometimes useful to know the join size under
1190 * plain innerjoin semantics. Note that lhs_strict, delay_upper_joins, and
1191 * join_quals are not set meaningfully within such structs.
1194 typedef struct SpecialJoinInfo
1197 Relids min_lefthand; /* base relids in minimum LHS for join */
1198 Relids min_righthand; /* base relids in minimum RHS for join */
1199 Relids syn_lefthand; /* base relids syntactically within LHS */
1200 Relids syn_righthand; /* base relids syntactically within RHS */
1201 JoinType jointype; /* always INNER, LEFT, FULL, SEMI, or ANTI */
1202 bool lhs_strict; /* joinclause is strict for some LHS rel */
1203 bool delay_upper_joins; /* can't commute with upper RHS */
1204 List *join_quals; /* join quals, in implicit-AND list format */
1208 * Append-relation info.
1210 * When we expand an inheritable table or a UNION-ALL subselect into an
1211 * "append relation" (essentially, a list of child RTEs), we build an
1212 * AppendRelInfo for each child RTE. The list of AppendRelInfos indicates
1213 * which child RTEs must be included when expanding the parent, and each
1214 * node carries information needed to translate Vars referencing the parent
1215 * into Vars referencing that child.
1217 * These structs are kept in the PlannerInfo node's append_rel_list.
1218 * Note that we just throw all the structs into one list, and scan the
1219 * whole list when desiring to expand any one parent. We could have used
1220 * a more complex data structure (eg, one list per parent), but this would
1221 * be harder to update during operations such as pulling up subqueries,
1222 * and not really any easier to scan. Considering that typical queries
1223 * will not have many different append parents, it doesn't seem worthwhile
1224 * to complicate things.
1226 * Note: after completion of the planner prep phase, any given RTE is an
1227 * append parent having entries in append_rel_list if and only if its
1228 * "inh" flag is set. We clear "inh" for plain tables that turn out not
1229 * to have inheritance children, and (in an abuse of the original meaning
1230 * of the flag) we set "inh" for subquery RTEs that turn out to be
1231 * flattenable UNION ALL queries. This lets us avoid useless searches
1232 * of append_rel_list.
1234 * Note: the data structure assumes that append-rel members are single
1235 * baserels. This is OK for inheritance, but it prevents us from pulling
1236 * up a UNION ALL member subquery if it contains a join. While that could
1237 * be fixed with a more complex data structure, at present there's not much
1238 * point because no improvement in the plan could result.
1241 typedef struct AppendRelInfo
1246 * These fields uniquely identify this append relationship. There can be
1247 * (in fact, always should be) multiple AppendRelInfos for the same
1248 * parent_relid, but never more than one per child_relid, since a given
1249 * RTE cannot be a child of more than one append parent.
1251 Index parent_relid; /* RT index of append parent rel */
1252 Index child_relid; /* RT index of append child rel */
1255 * For an inheritance appendrel, the parent and child are both regular
1256 * relations, and we store their rowtype OIDs here for use in translating
1257 * whole-row Vars. For a UNION-ALL appendrel, the parent and child are
1258 * both subqueries with no named rowtype, and we store InvalidOid here.
1260 Oid parent_reltype; /* OID of parent's composite type */
1261 Oid child_reltype; /* OID of child's composite type */
1264 * The N'th element of this list is a Var or expression representing the
1265 * child column corresponding to the N'th column of the parent. This is
1266 * used to translate Vars referencing the parent rel into references to
1267 * the child. A list element is NULL if it corresponds to a dropped
1268 * column of the parent (this is only possible for inheritance cases, not
1269 * UNION ALL). The list elements are always simple Vars for inheritance
1270 * cases, but can be arbitrary expressions in UNION ALL cases.
1272 * Notice we only store entries for user columns (attno > 0). Whole-row
1273 * Vars are special-cased, and system columns (attno < 0) need no special
1274 * translation since their attnos are the same for all tables.
1276 * Caution: the Vars have varlevelsup = 0. Be careful to adjust as needed
1277 * when copying into a subquery.
1279 List *translated_vars; /* Expressions in the child's Vars */
1282 * We store the parent table's OID here for inheritance, or InvalidOid for
1283 * UNION ALL. This is only needed to help in generating error messages if
1284 * an attempt is made to reference a dropped parent column.
1286 Oid parent_reloid; /* OID of parent relation */
1290 * For each distinct placeholder expression generated during planning, we
1291 * store a PlaceHolderInfo node in the PlannerInfo node's placeholder_list.
1292 * This stores info that is needed centrally rather than in each copy of the
1293 * PlaceHolderVar. The phid fields identify which PlaceHolderInfo goes with
1294 * each PlaceHolderVar. Note that phid is unique throughout a planner run,
1295 * not just within a query level --- this is so that we need not reassign ID's
1296 * when pulling a subquery into its parent.
1298 * The idea is to evaluate the expression at (only) the ph_eval_at join level,
1299 * then allow it to bubble up like a Var until the ph_needed join level.
1300 * ph_needed has the same definition as attr_needed for a regular Var.
1302 * We create a PlaceHolderInfo only after determining that the PlaceHolderVar
1303 * is actually referenced in the plan tree.
1306 typedef struct PlaceHolderInfo
1310 Index phid; /* ID for PH (unique within planner run) */
1311 PlaceHolderVar *ph_var; /* copy of PlaceHolderVar tree */
1312 Relids ph_eval_at; /* lowest level we can evaluate value at */
1313 Relids ph_needed; /* highest level the value is needed at */
1314 int32 ph_width; /* estimated attribute width */
1318 * glob->paramlist keeps track of the PARAM_EXEC slots that we have decided
1319 * we need for the query. At runtime these slots are used to pass values
1320 * either down into subqueries (for outer references in subqueries) or up out
1321 * of subqueries (for the results of a subplan). The n'th entry in the list
1322 * (n counts from 0) corresponds to Param->paramid = n.
1324 * Each paramlist item shows the absolute query level it is associated with,
1325 * where the outermost query is level 1 and nested subqueries have higher
1326 * numbers. The item the parameter slot represents can be one of three kinds:
1328 * A Var: the slot represents a variable of that level that must be passed
1329 * down because subqueries have outer references to it. The varlevelsup
1330 * value in the Var will always be zero.
1332 * An Aggref (with an expression tree representing its argument): the slot
1333 * represents an aggregate expression that is an outer reference for some
1334 * subquery. The Aggref itself has agglevelsup = 0, and its argument tree
1335 * is adjusted to match in level.
1337 * A Param: the slot holds the result of a subplan (it is a setParam item
1338 * for that subplan). The absolute level shown for such items corresponds
1339 * to the parent query of the subplan.
1341 * Note: we detect duplicate Var parameters and coalesce them into one slot,
1342 * but we do not do this for Aggref or Param slots.
1344 typedef struct PlannerParamItem
1348 Node *item; /* the Var, Aggref, or Param */
1349 Index abslevel; /* its absolute query level */
1352 #endif /* RELATION_H */