]> granicus.if.org Git - postgresql/blob - src/include/nodes/relation.h
Fix the plan-invalidation mechanism to treat regclass constants that refer to
[postgresql] / src / include / nodes / relation.h
1 /*-------------------------------------------------------------------------
2  *
3  * relation.h
4  *        Definitions for planner's internal data structures.
5  *
6  *
7  * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * $PostgreSQL: pgsql/src/include/nodes/relation.h,v 1.147 2007/10/11 18:05:27 tgl Exp $
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef RELATION_H
15 #define RELATION_H
16
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"
22
23
24 /*
25  * Relids
26  *              Set of relation identifiers (indexes into the rangetable).
27  */
28 typedef Bitmapset *Relids;
29
30 /*
31  * When looking for a "cheapest path", this enum specifies whether we want
32  * cheapest startup cost or cheapest total cost.
33  */
34 typedef enum CostSelector
35 {
36         STARTUP_COST, TOTAL_COST
37 } CostSelector;
38
39 /*
40  * The cost estimate produced by cost_qual_eval() includes both a one-time
41  * (startup) cost, and a per-tuple cost.
42  */
43 typedef struct QualCost
44 {
45         Cost            startup;                /* one-time cost */
46         Cost            per_tuple;              /* per-evaluation cost */
47 } QualCost;
48
49
50 /*----------
51  * PlannerGlobal
52  *              Global information for planning/optimization
53  *
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
56  * planned.
57  *----------
58  */
59 typedef struct PlannerGlobal
60 {
61         NodeTag         type;
62
63         ParamListInfo boundParams;      /* Param values provided to planner() */
64
65         List       *paramlist;          /* to keep track of cross-level Params */
66
67         List       *subplans;           /* Plans for SubPlan nodes */
68
69         List       *subrtables;         /* Rangetables for SubPlan nodes */
70
71         Bitmapset  *rewindPlanIDs;      /* indices of subplans that require REWIND */
72
73         List       *finalrtable;        /* "flat" rangetable for executor */
74
75         List       *relationOids;       /* OIDs of relations the plan depends on */
76
77         bool            transientPlan;  /* redo plan when TransactionXmin changes? */
78 } PlannerGlobal;
79
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))
83
84
85 /*----------
86  * PlannerInfo
87  *              Per-query information for planning/optimization
88  *
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.
93  *----------
94  */
95 typedef struct PlannerInfo
96 {
97         NodeTag         type;
98
99         Query      *parse;                      /* the Query being planned */
100
101         PlannerGlobal *glob;            /* global info for current planner run */
102
103         Index           query_level;    /* 1 at the outermost Query */
104
105         /*
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.
111          */
112         struct RelOptInfo **simple_rel_array;           /* All 1-rel RelOptInfos */
113         int                     simple_rel_array_size;  /* allocated size of array */
114
115         /*
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
119          * been expanded.
120          */
121         RangeTblEntry **simple_rte_array;                       /* rangetable as an array */
122
123         /*
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
130          * GEQO.
131          */
132         List       *join_rel_list;      /* list of join-relation RelOptInfos */
133         struct HTAB *join_rel_hash; /* optional hashtable for join relations */
134
135         List       *resultRelations;    /* integer list of RT indexes, or NIL */
136
137         List       *returningLists;             /* list of lists of TargetEntry, or NIL */
138
139         List       *init_plans;                         /* init subplans for query */
140
141         List       *eq_classes;                         /* list of active EquivalenceClasses */
142
143         List       *canon_pathkeys;                     /* list of "canonical" PathKeys */
144
145         List       *left_join_clauses;          /* list of RestrictInfos for
146                                                                                  * mergejoinable outer join clauses
147                                                                                  * w/nonnullable var on left */
148
149         List       *right_join_clauses;         /* list of RestrictInfos for
150                                                                                  * mergejoinable outer join clauses
151                                                                                  * w/nonnullable var on right */
152
153         List       *full_join_clauses;          /* list of RestrictInfos for
154                                                                                  * mergejoinable full join clauses */
155
156         List       *oj_info_list;       /* list of OuterJoinInfos */
157
158         List       *in_info_list;       /* list of InClauseInfos */
159
160         List       *append_rel_list;    /* list of AppendRelInfos */
161
162         List       *query_pathkeys; /* desired pathkeys for query_planner(), and
163                                                                  * actual pathkeys afterwards */
164
165         List       *group_pathkeys; /* groupClause pathkeys, if any */
166         List       *sort_pathkeys;      /* sortClause pathkeys, if any */
167
168         MemoryContext planner_cxt;      /* context holding PlannerInfo */
169
170         double          total_table_pages;              /* # of pages in all tables of query */
171
172         double          tuple_fraction; /* tuple_fraction passed to query_planner */
173
174         bool            hasJoinRTEs;    /* true if any RTEs are RTE_JOIN kind */
175         bool            hasOuterJoins;  /* true if any RTEs are outer joins */
176         bool            hasHavingQual;  /* true if havingQual was non-null */
177         bool            hasPseudoConstantQuals; /* true if any RestrictInfo has
178                                                                                  * pseudoconstant = true */
179 } PlannerInfo;
180
181
182 /*
183  * In places where it's known that simple_rte_array[] must have been prepared
184  * already, we just index into it to fetch RTEs.  In code that might be
185  * executed before or after entering query_planner(), use this macro.
186  */
187 #define planner_rt_fetch(rti, root) \
188         ((root)->simple_rte_array ? (root)->simple_rte_array[rti] : \
189          rt_fetch(rti, (root)->parse->rtable))
190
191
192 /*----------
193  * RelOptInfo
194  *              Per-relation information for planning/optimization
195  *
196  * For planning purposes, a "base rel" is either a plain relation (a table)
197  * or the output of a sub-SELECT or function that appears in the range table.
198  * In either case it is uniquely identified by an RT index.  A "joinrel"
199  * is the joining of two or more base rels.  A joinrel is identified by
200  * the set of RT indexes for its component baserels.  We create RelOptInfo
201  * nodes for each baserel and joinrel, and store them in the PlannerInfo's
202  * simple_rel_array and join_rel_list respectively.
203  *
204  * Note that there is only one joinrel for any given set of component
205  * baserels, no matter what order we assemble them in; so an unordered
206  * set is the right datatype to identify it with.
207  *
208  * We also have "other rels", which are like base rels in that they refer to
209  * single RT indexes; but they are not part of the join tree, and are given
210  * a different RelOptKind to identify them.
211  *
212  * Currently the only kind of otherrels are those made for member relations
213  * of an "append relation", that is an inheritance set or UNION ALL subquery.
214  * An append relation has a parent RTE that is a base rel, which represents
215  * the entire append relation.  The member RTEs are otherrels.  The parent
216  * is present in the query join tree but the members are not.  The member
217  * RTEs and otherrels are used to plan the scans of the individual tables or
218  * subqueries of the append set; then the parent baserel is given an Append
219  * plan comprising the best plans for the individual member rels.  (See
220  * comments for AppendRelInfo for more information.)
221  *
222  * At one time we also made otherrels to represent join RTEs, for use in
223  * handling join alias Vars.  Currently this is not needed because all join
224  * alias Vars are expanded to non-aliased form during preprocess_expression.
225  *
226  * Parts of this data structure are specific to various scan and join
227  * mechanisms.  It didn't seem worth creating new node types for them.
228  *
229  *              relids - Set of base-relation identifiers; it is a base relation
230  *                              if there is just one, a join relation if more than one
231  *              rows - estimated number of tuples in the relation after restriction
232  *                         clauses have been applied (ie, output rows of a plan for it)
233  *              width - avg. number of bytes per tuple in the relation after the
234  *                              appropriate projections have been done (ie, output width)
235  *              reltargetlist - List of Var nodes for the attributes we need to
236  *                                              output from this relation (in no particular order)
237  *                                              NOTE: in a child relation, may contain RowExprs
238  *              pathlist - List of Path nodes, one for each potentially useful
239  *                                 method of generating the relation
240  *              cheapest_startup_path - the pathlist member with lowest startup cost
241  *                                                              (regardless of its ordering)
242  *              cheapest_total_path - the pathlist member with lowest total cost
243  *                                                        (regardless of its ordering)
244  *              cheapest_unique_path - for caching cheapest path to produce unique
245  *                                                         (no duplicates) output from relation
246  *
247  * If the relation is a base relation it will have these fields set:
248  *
249  *              relid - RTE index (this is redundant with the relids field, but
250  *                              is provided for convenience of access)
251  *              rtekind - distinguishes plain relation, subquery, or function RTE
252  *              min_attr, max_attr - range of valid AttrNumbers for rel
253  *              attr_needed - array of bitmapsets indicating the highest joinrel
254  *                              in which each attribute is needed; if bit 0 is set then
255  *                              the attribute is needed as part of final targetlist
256  *              attr_widths - cache space for per-attribute width estimates;
257  *                                        zero means not computed yet
258  *              indexlist - list of IndexOptInfo nodes for relation's indexes
259  *                                      (always NIL if it's not a table)
260  *              pages - number of disk pages in relation (zero if not a table)
261  *              tuples - number of tuples in relation (not considering restrictions)
262  *              subplan - plan for subquery (NULL if it's not a subquery)
263  *              subrtable - rangetable for subquery (NIL if it's not a subquery)
264  *
265  *              Note: for a subquery, tuples and subplan are not set immediately
266  *              upon creation of the RelOptInfo object; they are filled in when
267  *              set_base_rel_pathlist processes the object.
268  *
269  *              For otherrels that are appendrel members, these fields are filled
270  *              in just as for a baserel.
271  *
272  * The presence of the remaining fields depends on the restrictions
273  * and joins that the relation participates in:
274  *
275  *              baserestrictinfo - List of RestrictInfo nodes, containing info about
276  *                                      each non-join qualification clause in which this relation
277  *                                      participates (only used for base rels)
278  *              baserestrictcost - Estimated cost of evaluating the baserestrictinfo
279  *                                      clauses at a single tuple (only used for base rels)
280  *              joininfo  - List of RestrictInfo nodes, containing info about each
281  *                                      join clause in which this relation participates (but
282  *                                      note this excludes clauses that might be derivable from
283  *                                      EquivalenceClasses)
284  *              has_eclass_joins - flag that EquivalenceClass joins are possible
285  *              index_outer_relids - only used for base rels; set of outer relids
286  *                                      that participate in indexable joinclauses for this rel
287  *              index_inner_paths - only used for base rels; list of InnerIndexscanInfo
288  *                                      nodes showing best indexpaths for various subsets of
289  *                                      index_outer_relids.
290  *
291  * Note: Keeping a restrictinfo list in the RelOptInfo is useful only for
292  * base rels, because for a join rel the set of clauses that are treated as
293  * restrict clauses varies depending on which sub-relations we choose to join.
294  * (For example, in a 3-base-rel join, a clause relating rels 1 and 2 must be
295  * treated as a restrictclause if we join {1} and {2 3} to make {1 2 3}; but
296  * if we join {1 2} and {3} then that clause will be a restrictclause in {1 2}
297  * and should not be processed again at the level of {1 2 3}.)  Therefore,
298  * the restrictinfo list in the join case appears in individual JoinPaths
299  * (field joinrestrictinfo), not in the parent relation.  But it's OK for
300  * the RelOptInfo to store the joininfo list, because that is the same
301  * for a given rel no matter how we form it.
302  *
303  * We store baserestrictcost in the RelOptInfo (for base relations) because
304  * we know we will need it at least once (to price the sequential scan)
305  * and may need it multiple times to price index scans.
306  *----------
307  */
308 typedef enum RelOptKind
309 {
310         RELOPT_BASEREL,
311         RELOPT_JOINREL,
312         RELOPT_OTHER_MEMBER_REL
313 } RelOptKind;
314
315 typedef struct RelOptInfo
316 {
317         NodeTag         type;
318
319         RelOptKind      reloptkind;
320
321         /* all relations included in this RelOptInfo */
322         Relids          relids;                 /* set of base relids (rangetable indexes) */
323
324         /* size estimates generated by planner */
325         double          rows;                   /* estimated number of result tuples */
326         int                     width;                  /* estimated avg width of result tuples */
327
328         /* materialization information */
329         List       *reltargetlist;      /* needed Vars */
330         List       *pathlist;           /* Path structures */
331         struct Path *cheapest_startup_path;
332         struct Path *cheapest_total_path;
333         struct Path *cheapest_unique_path;
334
335         /* information about a base rel (not set for join rels!) */
336         Index           relid;
337         RTEKind         rtekind;                /* RELATION, SUBQUERY, or FUNCTION */
338         AttrNumber      min_attr;               /* smallest attrno of rel (often <0) */
339         AttrNumber      max_attr;               /* largest attrno of rel */
340         Relids     *attr_needed;        /* array indexed [min_attr .. max_attr] */
341         int32      *attr_widths;        /* array indexed [min_attr .. max_attr] */
342         List       *indexlist;
343         BlockNumber pages;
344         double          tuples;
345         struct Plan *subplan;           /* if subquery */
346         List       *subrtable;          /* if subquery */
347
348         /* used by various scans and joins: */
349         List       *baserestrictinfo;           /* RestrictInfo structures (if base
350                                                                                  * rel) */
351         QualCost        baserestrictcost;               /* cost of evaluating the above */
352         List       *joininfo;           /* RestrictInfo structures for join clauses
353                                                                  * involving this rel */
354         bool            has_eclass_joins;               /* T means joininfo is incomplete */
355
356         /* cached info about inner indexscan paths for relation: */
357         Relids          index_outer_relids;             /* other relids in indexable join
358                                                                                  * clauses */
359         List       *index_inner_paths;          /* InnerIndexscanInfo nodes */
360
361         /*
362          * Inner indexscans are not in the main pathlist because they are not
363          * usable except in specific join contexts.  We use the index_inner_paths
364          * list just to avoid recomputing the best inner indexscan repeatedly for
365          * similar outer relations.  See comments for InnerIndexscanInfo.
366          */
367 } RelOptInfo;
368
369 /*
370  * IndexOptInfo
371  *              Per-index information for planning/optimization
372  *
373  *              Prior to Postgres 7.0, RelOptInfo was used to describe both relations
374  *              and indexes, but that created confusion without actually doing anything
375  *              useful.  So now we have a separate IndexOptInfo struct for indexes.
376  *
377  *              opfamily[], indexkeys[], opcintype[], fwdsortop[], revsortop[],
378  *              and nulls_first[] each have ncolumns entries.
379  *              Note: for historical reasons, the opfamily array has an extra entry
380  *              that is always zero.  Some code scans until it sees a zero entry,
381  *              rather than looking at ncolumns.
382  *
383  *              Zeroes in the indexkeys[] array indicate index columns that are
384  *              expressions; there is one element in indexprs for each such column.
385  *
386  *              For an unordered index, the sortop arrays contains zeroes.  Note that
387  *              fwdsortop[] and nulls_first[] describe the sort ordering of a forward
388  *              indexscan; we can also consider a backward indexscan, which will
389  *              generate sort order described by revsortop/!nulls_first.
390  *
391  *              The indexprs and indpred expressions have been run through
392  *              prepqual.c and eval_const_expressions() for ease of matching to
393  *              WHERE clauses. indpred is in implicit-AND form.
394  */
395 typedef struct IndexOptInfo
396 {
397         NodeTag         type;
398
399         Oid                     indexoid;               /* OID of the index relation */
400         RelOptInfo *rel;                        /* back-link to index's table */
401
402         /* statistics from pg_class */
403         BlockNumber pages;                      /* number of disk pages in index */
404         double          tuples;                 /* number of index tuples in index */
405
406         /* index descriptor information */
407         int                     ncolumns;               /* number of columns in index */
408         Oid                *opfamily;           /* OIDs of operator families for columns */
409         int                *indexkeys;          /* column numbers of index's keys, or 0 */
410         Oid                *opcintype;          /* OIDs of opclass declared input data types */
411         Oid                *fwdsortop;          /* OIDs of sort operators for each column */
412         Oid                *revsortop;          /* OIDs of sort operators for backward scan */
413         bool       *nulls_first;        /* do NULLs come first in the sort order? */
414         Oid                     relam;                  /* OID of the access method (in pg_am) */
415
416         RegProcedure amcostestimate;    /* OID of the access method's cost fcn */
417
418         List       *indexprs;           /* expressions for non-simple index columns */
419         List       *indpred;            /* predicate if a partial index, else NIL */
420
421         bool            predOK;                 /* true if predicate matches query */
422         bool            unique;                 /* true if a unique index */
423         bool            amoptionalkey;  /* can query omit key for the first column? */
424         bool            amsearchnulls;  /* can AM search for NULL index entries? */
425 } IndexOptInfo;
426
427
428 /*
429  * EquivalenceClasses
430  *
431  * Whenever we can determine that a mergejoinable equality clause A = B is
432  * not delayed by any outer join, we create an EquivalenceClass containing
433  * the expressions A and B to record this knowledge.  If we later find another
434  * equivalence B = C, we add C to the existing EquivalenceClass; this may
435  * require merging two existing EquivalenceClasses.  At the end of the qual
436  * distribution process, we have sets of values that are known all transitively
437  * equal to each other, where "equal" is according to the rules of the btree
438  * operator family(s) shown in ec_opfamilies.  (We restrict an EC to contain
439  * only equalities whose operators belong to the same set of opfamilies.  This
440  * could probably be relaxed, but for now it's not worth the trouble, since
441  * nearly all equality operators belong to only one btree opclass anyway.)
442  *
443  * We also use EquivalenceClasses as the base structure for PathKeys, letting
444  * us represent knowledge about different sort orderings being equivalent.
445  * Since every PathKey must reference an EquivalenceClass, we will end up
446  * with single-member EquivalenceClasses whenever a sort key expression has
447  * not been equivalenced to anything else.  It is also possible that such an
448  * EquivalenceClass will contain a volatile expression ("ORDER BY random()"),
449  * which is a case that can't arise otherwise since clauses containing
450  * volatile functions are never considered mergejoinable.  We mark such
451  * EquivalenceClasses specially to prevent them from being merged with
452  * ordinary EquivalenceClasses.
453  *
454  * We allow equality clauses appearing below the nullable side of an outer join
455  * to form EquivalenceClasses, but these have a slightly different meaning:
456  * the included values might be all NULL rather than all the same non-null
457  * values.  See src/backend/optimizer/README for more on that point.
458  *
459  * NB: if ec_merged isn't NULL, this class has been merged into another, and
460  * should be ignored in favor of using the pointed-to class.
461  */
462 typedef struct EquivalenceClass
463 {
464         NodeTag         type;
465
466         List       *ec_opfamilies;              /* btree operator family OIDs */
467         List       *ec_members;                 /* list of EquivalenceMembers */
468         List       *ec_sources;                 /* list of generating RestrictInfos */
469         List       *ec_derives;                 /* list of derived RestrictInfos */
470         Relids          ec_relids;                      /* all relids appearing in ec_members */
471         bool            ec_has_const;           /* any pseudoconstants in ec_members? */
472         bool            ec_has_volatile;        /* the (sole) member is a volatile expr */
473         bool            ec_below_outer_join;    /* equivalence applies below an OJ */
474         bool            ec_broken;                      /* failed to generate needed clauses? */
475         struct EquivalenceClass *ec_merged;             /* set if merged into another EC */
476 } EquivalenceClass;
477
478 /*
479  * EquivalenceMember - one member expression of an EquivalenceClass
480  *
481  * em_is_child signifies that this element was built by transposing a member
482  * for an inheritance parent relation to represent the corresponding expression
483  * on an inheritance child.  The element should be ignored for all purposes
484  * except constructing inner-indexscan paths for the child relation.  (Other
485  * types of join are driven from transposed joininfo-list entries.)  Note
486  * that the EC's ec_relids field does NOT include the child relation.
487  *
488  * em_datatype is usually the same as exprType(em_expr), but can be
489  * different when dealing with a binary-compatible opfamily; in particular
490  * anyarray_ops would never work without this.  Use em_datatype when
491  * looking up a specific btree operator to work with this expression.
492  */
493 typedef struct EquivalenceMember
494 {
495         NodeTag         type;
496
497         Expr       *em_expr;            /* the expression represented */
498         Relids          em_relids;              /* all relids appearing in em_expr */
499         bool            em_is_const;    /* expression is pseudoconstant? */
500         bool            em_is_child;    /* derived version for a child relation? */
501         Oid                     em_datatype;    /* the "nominal type" used by the opfamily */
502 } EquivalenceMember;
503
504 /*
505  * PathKeys
506  *
507  * The sort ordering of a path is represented by a list of PathKey nodes.
508  * An empty list implies no known ordering.  Otherwise the first item
509  * represents the primary sort key, the second the first secondary sort key,
510  * etc.  The value being sorted is represented by linking to an
511  * EquivalenceClass containing that value and including pk_opfamily among its
512  * ec_opfamilies.  This is a convenient method because it makes it trivial
513  * to detect equivalent and closely-related orderings.  (See optimizer/README
514  * for more information.)
515  *
516  * Note: pk_strategy is either BTLessStrategyNumber (for ASC) or
517  * BTGreaterStrategyNumber (for DESC).  We assume that all ordering-capable
518  * index types will use btree-compatible strategy numbers.
519  */
520
521 typedef struct PathKey
522 {
523         NodeTag         type;
524
525         EquivalenceClass *pk_eclass;    /* the value that is ordered */
526         Oid                     pk_opfamily;            /* btree opfamily defining the ordering */
527         int                     pk_strategy;            /* sort direction (ASC or DESC) */
528         bool            pk_nulls_first;         /* do NULLs come before normal values? */
529 } PathKey;
530
531 /*
532  * Type "Path" is used as-is for sequential-scan paths.  For other
533  * path types it is the first component of a larger struct.
534  *
535  * Note: "pathtype" is the NodeTag of the Plan node we could build from this
536  * Path.  It is partially redundant with the Path's NodeTag, but allows us
537  * to use the same Path type for multiple Plan types where there is no need
538  * to distinguish the Plan type during path processing.
539  */
540
541 typedef struct Path
542 {
543         NodeTag         type;
544
545         NodeTag         pathtype;               /* tag identifying scan/join method */
546
547         RelOptInfo *parent;                     /* the relation this path can build */
548
549         /* estimated execution costs for path (see costsize.c for more info) */
550         Cost            startup_cost;   /* cost expended before fetching any tuples */
551         Cost            total_cost;             /* total cost (assuming all tuples fetched) */
552
553         List       *pathkeys;           /* sort ordering of path's output */
554         /* pathkeys is a List of PathKey nodes; see above */
555 } Path;
556
557 /*----------
558  * IndexPath represents an index scan over a single index.
559  *
560  * 'indexinfo' is the index to be scanned.
561  *
562  * 'indexclauses' is a list of index qualification clauses, with implicit
563  * AND semantics across the list.  Each clause is a RestrictInfo node from
564  * the query's WHERE or JOIN conditions.
565  *
566  * 'indexquals' has the same structure as 'indexclauses', but it contains
567  * the actual indexqual conditions that can be used with the index.
568  * In simple cases this is identical to 'indexclauses', but when special
569  * indexable operators appear in 'indexclauses', they are replaced by the
570  * derived indexscannable conditions in 'indexquals'.
571  *
572  * 'isjoininner' is TRUE if the path is a nestloop inner scan (that is,
573  * some of the index conditions are join rather than restriction clauses).
574  * Note that the path costs will be calculated differently from a plain
575  * indexscan in this case, and in addition there's a special 'rows' value
576  * different from the parent RelOptInfo's (see below).
577  *
578  * 'indexscandir' is one of:
579  *              ForwardScanDirection: forward scan of an ordered index
580  *              BackwardScanDirection: backward scan of an ordered index
581  *              NoMovementScanDirection: scan of an unordered index, or don't care
582  * (The executor doesn't care whether it gets ForwardScanDirection or
583  * NoMovementScanDirection for an indexscan, but the planner wants to
584  * distinguish ordered from unordered indexes for building pathkeys.)
585  *
586  * 'indextotalcost' and 'indexselectivity' are saved in the IndexPath so that
587  * we need not recompute them when considering using the same index in a
588  * bitmap index/heap scan (see BitmapHeapPath).  The costs of the IndexPath
589  * itself represent the costs of an IndexScan plan type.
590  *
591  * 'rows' is the estimated result tuple count for the indexscan.  This
592  * is the same as path.parent->rows for a simple indexscan, but it is
593  * different for a nestloop inner scan, because the additional indexquals
594  * coming from join clauses make the scan more selective than the parent
595  * rel's restrict clauses alone would do.
596  *----------
597  */
598 typedef struct IndexPath
599 {
600         Path            path;
601         IndexOptInfo *indexinfo;
602         List       *indexclauses;
603         List       *indexquals;
604         bool            isjoininner;
605         ScanDirection indexscandir;
606         Cost            indextotalcost;
607         Selectivity indexselectivity;
608         double          rows;                   /* estimated number of result tuples */
609 } IndexPath;
610
611 /*
612  * BitmapHeapPath represents one or more indexscans that generate TID bitmaps
613  * instead of directly accessing the heap, followed by AND/OR combinations
614  * to produce a single bitmap, followed by a heap scan that uses the bitmap.
615  * Note that the output is always considered unordered, since it will come
616  * out in physical heap order no matter what the underlying indexes did.
617  *
618  * The individual indexscans are represented by IndexPath nodes, and any
619  * logic on top of them is represented by a tree of BitmapAndPath and
620  * BitmapOrPath nodes.  Notice that we can use the same IndexPath node both
621  * to represent a regular IndexScan plan, and as the child of a BitmapHeapPath
622  * that represents scanning the same index using a BitmapIndexScan.  The
623  * startup_cost and total_cost figures of an IndexPath always represent the
624  * costs to use it as a regular IndexScan.      The costs of a BitmapIndexScan
625  * can be computed using the IndexPath's indextotalcost and indexselectivity.
626  *
627  * BitmapHeapPaths can be nestloop inner indexscans.  The isjoininner and
628  * rows fields serve the same purpose as for plain IndexPaths.
629  */
630 typedef struct BitmapHeapPath
631 {
632         Path            path;
633         Path       *bitmapqual;         /* IndexPath, BitmapAndPath, BitmapOrPath */
634         bool            isjoininner;    /* T if it's a nestloop inner scan */
635         double          rows;                   /* estimated number of result tuples */
636 } BitmapHeapPath;
637
638 /*
639  * BitmapAndPath represents a BitmapAnd plan node; it can only appear as
640  * part of the substructure of a BitmapHeapPath.  The Path structure is
641  * a bit more heavyweight than we really need for this, but for simplicity
642  * we make it a derivative of Path anyway.
643  */
644 typedef struct BitmapAndPath
645 {
646         Path            path;
647         List       *bitmapquals;        /* IndexPaths and BitmapOrPaths */
648         Selectivity bitmapselectivity;
649 } BitmapAndPath;
650
651 /*
652  * BitmapOrPath represents a BitmapOr plan node; it can only appear as
653  * part of the substructure of a BitmapHeapPath.  The Path structure is
654  * a bit more heavyweight than we really need for this, but for simplicity
655  * we make it a derivative of Path anyway.
656  */
657 typedef struct BitmapOrPath
658 {
659         Path            path;
660         List       *bitmapquals;        /* IndexPaths and BitmapAndPaths */
661         Selectivity bitmapselectivity;
662 } BitmapOrPath;
663
664 /*
665  * TidPath represents a scan by TID
666  *
667  * tidquals is an implicitly OR'ed list of qual expressions of the form
668  * "CTID = pseudoconstant" or "CTID = ANY(pseudoconstant_array)".
669  * Note they are bare expressions, not RestrictInfos.
670  */
671 typedef struct TidPath
672 {
673         Path            path;
674         List       *tidquals;           /* qual(s) involving CTID = something */
675 } TidPath;
676
677 /*
678  * AppendPath represents an Append plan, ie, successive execution of
679  * several member plans.
680  *
681  * Note: it is possible for "subpaths" to contain only one, or even no,
682  * elements.  These cases are optimized during create_append_plan.
683  */
684 typedef struct AppendPath
685 {
686         Path            path;
687         List       *subpaths;           /* list of component Paths */
688 } AppendPath;
689
690 /*
691  * ResultPath represents use of a Result plan node to compute a variable-free
692  * targetlist with no underlying tables (a "SELECT expressions" query).
693  * The query could have a WHERE clause, too, represented by "quals".
694  *
695  * Note that quals is a list of bare clauses, not RestrictInfos.
696  */
697 typedef struct ResultPath
698 {
699         Path            path;
700         List       *quals;
701 } ResultPath;
702
703 /*
704  * MaterialPath represents use of a Material plan node, i.e., caching of
705  * the output of its subpath.  This is used when the subpath is expensive
706  * and needs to be scanned repeatedly, or when we need mark/restore ability
707  * and the subpath doesn't have it.
708  */
709 typedef struct MaterialPath
710 {
711         Path            path;
712         Path       *subpath;
713 } MaterialPath;
714
715 /*
716  * UniquePath represents elimination of distinct rows from the output of
717  * its subpath.
718  *
719  * This is unlike the other Path nodes in that it can actually generate
720  * different plans: either hash-based or sort-based implementation, or a
721  * no-op if the input path can be proven distinct already.      The decision
722  * is sufficiently localized that it's not worth having separate Path node
723  * types.  (Note: in the no-op case, we could eliminate the UniquePath node
724  * entirely and just return the subpath; but it's convenient to have a
725  * UniquePath in the path tree to signal upper-level routines that the input
726  * is known distinct.)
727  */
728 typedef enum
729 {
730         UNIQUE_PATH_NOOP,                       /* input is known unique already */
731         UNIQUE_PATH_HASH,                       /* use hashing */
732         UNIQUE_PATH_SORT                        /* use sorting */
733 } UniquePathMethod;
734
735 typedef struct UniquePath
736 {
737         Path            path;
738         Path       *subpath;
739         UniquePathMethod umethod;
740         double          rows;                   /* estimated number of result tuples */
741 } UniquePath;
742
743 /*
744  * All join-type paths share these fields.
745  */
746
747 typedef struct JoinPath
748 {
749         Path            path;
750
751         JoinType        jointype;
752
753         Path       *outerjoinpath;      /* path for the outer side of the join */
754         Path       *innerjoinpath;      /* path for the inner side of the join */
755
756         List       *joinrestrictinfo;           /* RestrictInfos to apply to join */
757
758         /*
759          * See the notes for RelOptInfo to understand why joinrestrictinfo is
760          * needed in JoinPath, and can't be merged into the parent RelOptInfo.
761          */
762 } JoinPath;
763
764 /*
765  * A nested-loop path needs no special fields.
766  */
767
768 typedef JoinPath NestPath;
769
770 /*
771  * A mergejoin path has these fields.
772  *
773  * path_mergeclauses lists the clauses (in the form of RestrictInfos)
774  * that will be used in the merge.
775  *
776  * Note that the mergeclauses are a subset of the parent relation's
777  * restriction-clause list.  Any join clauses that are not mergejoinable
778  * appear only in the parent's restrict list, and must be checked by a
779  * qpqual at execution time.
780  *
781  * outersortkeys (resp. innersortkeys) is NIL if the outer path
782  * (resp. inner path) is already ordered appropriately for the
783  * mergejoin.  If it is not NIL then it is a PathKeys list describing
784  * the ordering that must be created by an explicit sort step.
785  */
786
787 typedef struct MergePath
788 {
789         JoinPath        jpath;
790         List       *path_mergeclauses;          /* join clauses to be used for merge */
791         List       *outersortkeys;      /* keys for explicit sort, if any */
792         List       *innersortkeys;      /* keys for explicit sort, if any */
793 } MergePath;
794
795 /*
796  * A hashjoin path has these fields.
797  *
798  * The remarks above for mergeclauses apply for hashclauses as well.
799  *
800  * Hashjoin does not care what order its inputs appear in, so we have
801  * no need for sortkeys.
802  */
803
804 typedef struct HashPath
805 {
806         JoinPath        jpath;
807         List       *path_hashclauses;           /* join clauses used for hashing */
808 } HashPath;
809
810 /*
811  * Restriction clause info.
812  *
813  * We create one of these for each AND sub-clause of a restriction condition
814  * (WHERE or JOIN/ON clause).  Since the restriction clauses are logically
815  * ANDed, we can use any one of them or any subset of them to filter out
816  * tuples, without having to evaluate the rest.  The RestrictInfo node itself
817  * stores data used by the optimizer while choosing the best query plan.
818  *
819  * If a restriction clause references a single base relation, it will appear
820  * in the baserestrictinfo list of the RelOptInfo for that base rel.
821  *
822  * If a restriction clause references more than one base rel, it will
823  * appear in the joininfo list of every RelOptInfo that describes a strict
824  * subset of the base rels mentioned in the clause.  The joininfo lists are
825  * used to drive join tree building by selecting plausible join candidates.
826  * The clause cannot actually be applied until we have built a join rel
827  * containing all the base rels it references, however.
828  *
829  * When we construct a join rel that includes all the base rels referenced
830  * in a multi-relation restriction clause, we place that clause into the
831  * joinrestrictinfo lists of paths for the join rel, if neither left nor
832  * right sub-path includes all base rels referenced in the clause.      The clause
833  * will be applied at that join level, and will not propagate any further up
834  * the join tree.  (Note: the "predicate migration" code was once intended to
835  * push restriction clauses up and down the plan tree based on evaluation
836  * costs, but it's dead code and is unlikely to be resurrected in the
837  * foreseeable future.)
838  *
839  * Note that in the presence of more than two rels, a multi-rel restriction
840  * might reach different heights in the join tree depending on the join
841  * sequence we use.  So, these clauses cannot be associated directly with
842  * the join RelOptInfo, but must be kept track of on a per-join-path basis.
843  *
844  * RestrictInfos that represent equivalence conditions (i.e., mergejoinable
845  * equalities that are not outerjoin-delayed) are handled a bit differently.
846  * Initially we attach them to the EquivalenceClasses that are derived from
847  * them.  When we construct a scan or join path, we look through all the
848  * EquivalenceClasses and generate derived RestrictInfos representing the
849  * minimal set of conditions that need to be checked for this particular scan
850  * or join to enforce that all members of each EquivalenceClass are in fact
851  * equal in all rows emitted by the scan or join.
852  *
853  * When dealing with outer joins we have to be very careful about pushing qual
854  * clauses up and down the tree.  An outer join's own JOIN/ON conditions must
855  * be evaluated exactly at that join node, and any quals appearing in WHERE or
856  * in a JOIN above the outer join cannot be pushed down below the outer join.
857  * Otherwise the outer join will produce wrong results because it will see the
858  * wrong sets of input rows.  All quals are stored as RestrictInfo nodes
859  * during planning, but there's a flag to indicate whether a qual has been
860  * pushed down to a lower level than its original syntactic placement in the
861  * join tree would suggest.  If an outer join prevents us from pushing a qual
862  * down to its "natural" semantic level (the level associated with just the
863  * base rels used in the qual) then we mark the qual with a "required_relids"
864  * value including more than just the base rels it actually uses.  By
865  * pretending that the qual references all the rels appearing in the outer
866  * join, we prevent it from being evaluated below the outer join's joinrel.
867  * When we do form the outer join's joinrel, we still need to distinguish
868  * those quals that are actually in that join's JOIN/ON condition from those
869  * that appeared elsewhere in the tree and were pushed down to the join rel
870  * because they used no other rels.  That's what the is_pushed_down flag is
871  * for; it tells us that a qual is not an OUTER JOIN qual for the set of base
872  * rels listed in required_relids.  A clause that originally came from WHERE
873  * or an INNER JOIN condition will *always* have its is_pushed_down flag set.
874  * It's possible for an OUTER JOIN clause to be marked is_pushed_down too,
875  * if we decide that it can be pushed down into the nullable side of the join.
876  * In that case it acts as a plain filter qual for wherever it gets evaluated.
877  *
878  * When application of a qual must be delayed by outer join, we also mark it
879  * with outerjoin_delayed = true.  This isn't redundant with required_relids
880  * because that might equal clause_relids whether or not it's an outer-join
881  * clause.
882  *
883  * In general, the referenced clause might be arbitrarily complex.      The
884  * kinds of clauses we can handle as indexscan quals, mergejoin clauses,
885  * or hashjoin clauses are limited (e.g., no volatile functions).  The code
886  * for each kind of path is responsible for identifying the restrict clauses
887  * it can use and ignoring the rest.  Clauses not implemented by an indexscan,
888  * mergejoin, or hashjoin will be placed in the plan qual or joinqual field
889  * of the finished Plan node, where they will be enforced by general-purpose
890  * qual-expression-evaluation code.  (But we are still entitled to count
891  * their selectivity when estimating the result tuple count, if we
892  * can guess what it is...)
893  *
894  * When the referenced clause is an OR clause, we generate a modified copy
895  * in which additional RestrictInfo nodes are inserted below the top-level
896  * OR/AND structure.  This is a convenience for OR indexscan processing:
897  * indexquals taken from either the top level or an OR subclause will have
898  * associated RestrictInfo nodes.
899  *
900  * The can_join flag is set true if the clause looks potentially useful as
901  * a merge or hash join clause, that is if it is a binary opclause with
902  * nonoverlapping sets of relids referenced in the left and right sides.
903  * (Whether the operator is actually merge or hash joinable isn't checked,
904  * however.)
905  *
906  * The pseudoconstant flag is set true if the clause contains no Vars of
907  * the current query level and no volatile functions.  Such a clause can be
908  * pulled out and used as a one-time qual in a gating Result node.      We keep
909  * pseudoconstant clauses in the same lists as other RestrictInfos so that
910  * the regular clause-pushing machinery can assign them to the correct join
911  * level, but they need to be treated specially for cost and selectivity
912  * estimates.  Note that a pseudoconstant clause can never be an indexqual
913  * or merge or hash join clause, so it's of no interest to large parts of
914  * the planner.
915  *
916  * When join clauses are generated from EquivalenceClasses, there may be
917  * several equally valid ways to enforce join equivalence, of which we need
918  * apply only one.  We mark clauses of this kind by setting parent_ec to
919  * point to the generating EquivalenceClass.  Multiple clauses with the same
920  * parent_ec in the same join are redundant.
921  */
922
923 typedef struct RestrictInfo
924 {
925         NodeTag         type;
926
927         Expr       *clause;                     /* the represented clause of WHERE or JOIN */
928
929         bool            is_pushed_down; /* TRUE if clause was pushed down in level */
930
931         bool            outerjoin_delayed;              /* TRUE if delayed by outer join */
932
933         bool            can_join;               /* see comment above */
934
935         bool            pseudoconstant; /* see comment above */
936
937         /* The set of relids (varnos) actually referenced in the clause: */
938         Relids          clause_relids;
939
940         /* The set of relids required to evaluate the clause: */
941         Relids          required_relids;
942
943         /* These fields are set for any binary opclause: */
944         Relids          left_relids;    /* relids in left side of clause */
945         Relids          right_relids;   /* relids in right side of clause */
946
947         /* This field is NULL unless clause is an OR clause: */
948         Expr       *orclause;           /* modified clause with RestrictInfos */
949
950         /* This field is NULL unless clause is potentially redundant: */
951         EquivalenceClass *parent_ec;    /* generating EquivalenceClass */
952
953         /* cache space for cost and selectivity */
954         QualCost        eval_cost;              /* eval cost of clause; -1 if not yet set */
955         Selectivity this_selec;         /* selectivity; -1 if not yet set */
956
957         /* valid if clause is mergejoinable, else NIL */
958         List       *mergeopfamilies;    /* opfamilies containing clause operator */
959
960         /* cache space for mergeclause processing; NULL if not yet set */
961         EquivalenceClass *left_ec;      /* EquivalenceClass containing lefthand */
962         EquivalenceClass *right_ec;     /* EquivalenceClass containing righthand */
963         EquivalenceMember *left_em;             /* EquivalenceMember for lefthand */
964         EquivalenceMember *right_em;    /* EquivalenceMember for righthand */
965         List       *scansel_cache;      /* list of MergeScanSelCache structs */
966
967         /* transient workspace for use while considering a specific join path */
968         bool            outer_is_left;  /* T = outer var on left, F = on right */
969
970         /* valid if clause is hashjoinable, else InvalidOid: */
971         Oid                     hashjoinoperator;               /* copy of clause operator */
972
973         /* cache space for hashclause processing; -1 if not yet set */
974         Selectivity left_bucketsize;    /* avg bucketsize of left side */
975         Selectivity right_bucketsize;           /* avg bucketsize of right side */
976 } RestrictInfo;
977
978 /*
979  * Since mergejoinscansel() is a relatively expensive function, and would
980  * otherwise be invoked many times while planning a large join tree,
981  * we go out of our way to cache its results.  Each mergejoinable
982  * RestrictInfo carries a list of the specific sort orderings that have
983  * been considered for use with it, and the resulting selectivities.
984  */
985 typedef struct MergeScanSelCache
986 {
987         /* Ordering details (cache lookup key) */
988         Oid                     opfamily;               /* btree opfamily defining the ordering */
989         int                     strategy;               /* sort direction (ASC or DESC) */
990         bool            nulls_first;    /* do NULLs come before normal values? */
991         /* Results */
992         Selectivity     leftscansel;    /* scan fraction for clause left side */
993         Selectivity     rightscansel;   /* scan fraction for clause right side */
994 } MergeScanSelCache;
995
996 /*
997  * Inner indexscan info.
998  *
999  * An inner indexscan is one that uses one or more joinclauses as index
1000  * conditions (perhaps in addition to plain restriction clauses).  So it
1001  * can only be used as the inner path of a nestloop join where the outer
1002  * relation includes all other relids appearing in those joinclauses.
1003  * The set of usable joinclauses, and thus the best inner indexscan,
1004  * thus varies depending on which outer relation we consider; so we have
1005  * to recompute the best such paths for every join.  To avoid lots of
1006  * redundant computation, we cache the results of such searches.  For
1007  * each relation we compute the set of possible otherrelids (all relids
1008  * appearing in joinquals that could become indexquals for this table).
1009  * Two outer relations whose relids have the same intersection with this
1010  * set will have the same set of available joinclauses and thus the same
1011  * best inner indexscans for the inner relation.  By taking the intersection
1012  * before scanning the cache, we avoid recomputing when considering
1013  * join rels that differ only by the inclusion of irrelevant other rels.
1014  *
1015  * The search key also includes a bool showing whether the join being
1016  * considered is an outer join.  Since we constrain the join order for
1017  * outer joins, I believe that this bool can only have one possible value
1018  * for any particular lookup key; but store it anyway to avoid confusion.
1019  */
1020
1021 typedef struct InnerIndexscanInfo
1022 {
1023         NodeTag         type;
1024         /* The lookup key: */
1025         Relids          other_relids;   /* a set of relevant other relids */
1026         bool            isouterjoin;    /* true if join is outer */
1027         /* Best paths for this lookup key (NULL if no available indexscans): */
1028         Path       *cheapest_startup_innerpath; /* cheapest startup cost */
1029         Path       *cheapest_total_innerpath;   /* cheapest total cost */
1030 } InnerIndexscanInfo;
1031
1032 /*
1033  * Outer join info.
1034  *
1035  * One-sided outer joins constrain the order of joining partially but not
1036  * completely.  We flatten such joins into the planner's top-level list of
1037  * relations to join, but record information about each outer join in an
1038  * OuterJoinInfo struct.  These structs are kept in the PlannerInfo node's
1039  * oj_info_list.
1040  *
1041  * min_lefthand and min_righthand are the sets of base relids that must be
1042  * available on each side when performing the outer join.  lhs_strict is
1043  * true if the outer join's condition cannot succeed when the LHS variables
1044  * are all NULL (this means that the outer join can commute with upper-level
1045  * outer joins even if it appears in their RHS).  We don't bother to set
1046  * lhs_strict for FULL JOINs, however.
1047  *
1048  * It is not valid for either min_lefthand or min_righthand to be empty sets;
1049  * if they were, this would break the logic that enforces join order.
1050  *
1051  * syn_lefthand and syn_righthand are the sets of base relids that are
1052  * syntactically below this outer join.  (These are needed to help compute
1053  * min_lefthand and min_righthand for higher joins, but are not used
1054  * thereafter.)
1055  *
1056  * delay_upper_joins is set TRUE if we detect a pushed-down clause that has
1057  * to be evaluated after this join is formed (because it references the RHS).
1058  * Any outer joins that have such a clause and this join in their RHS cannot
1059  * commute with this join, because that would leave noplace to check the
1060  * pushed-down clause.  (We don't track this for FULL JOINs, either.)
1061  *
1062  * Note: OuterJoinInfo directly represents only LEFT JOIN and FULL JOIN;
1063  * RIGHT JOIN is handled by switching the inputs to make it a LEFT JOIN.
1064  * We make an OuterJoinInfo for FULL JOINs even though there is no flexibility
1065  * of planning for them, because this simplifies make_join_rel()'s API.
1066  */
1067
1068 typedef struct OuterJoinInfo
1069 {
1070         NodeTag         type;
1071         Relids          min_lefthand;   /* base relids in minimum LHS for join */
1072         Relids          min_righthand;  /* base relids in minimum RHS for join */
1073         Relids          syn_lefthand;   /* base relids syntactically within LHS */
1074         Relids          syn_righthand;  /* base relids syntactically within RHS */
1075         bool            is_full_join;   /* it's a FULL OUTER JOIN */
1076         bool            lhs_strict;             /* joinclause is strict for some LHS rel */
1077         bool            delay_upper_joins;      /* can't commute with upper RHS */
1078 } OuterJoinInfo;
1079
1080 /*
1081  * IN clause info.
1082  *
1083  * When we convert top-level IN quals into join operations, we must restrict
1084  * the order of joining and use special join methods at some join points.
1085  * We record information about each such IN clause in an InClauseInfo struct.
1086  * These structs are kept in the PlannerInfo node's in_info_list.
1087  *
1088  * Note: sub_targetlist is just a list of Vars or expressions; it does not
1089  * contain TargetEntry nodes.
1090  */
1091
1092 typedef struct InClauseInfo
1093 {
1094         NodeTag         type;
1095         Relids          lefthand;               /* base relids in lefthand expressions */
1096         Relids          righthand;              /* base relids coming from the subselect */
1097         List       *sub_targetlist; /* targetlist of original RHS subquery */
1098         List       *in_operators;       /* OIDs of the IN's equality operator(s) */
1099 } InClauseInfo;
1100
1101 /*
1102  * Append-relation info.
1103  *
1104  * When we expand an inheritable table or a UNION-ALL subselect into an
1105  * "append relation" (essentially, a list of child RTEs), we build an
1106  * AppendRelInfo for each child RTE.  The list of AppendRelInfos indicates
1107  * which child RTEs must be included when expanding the parent, and each
1108  * node carries information needed to translate Vars referencing the parent
1109  * into Vars referencing that child.
1110  *
1111  * These structs are kept in the PlannerInfo node's append_rel_list.
1112  * Note that we just throw all the structs into one list, and scan the
1113  * whole list when desiring to expand any one parent.  We could have used
1114  * a more complex data structure (eg, one list per parent), but this would
1115  * be harder to update during operations such as pulling up subqueries,
1116  * and not really any easier to scan.  Considering that typical queries
1117  * will not have many different append parents, it doesn't seem worthwhile
1118  * to complicate things.
1119  *
1120  * Note: after completion of the planner prep phase, any given RTE is an
1121  * append parent having entries in append_rel_list if and only if its
1122  * "inh" flag is set.  We clear "inh" for plain tables that turn out not
1123  * to have inheritance children, and (in an abuse of the original meaning
1124  * of the flag) we set "inh" for subquery RTEs that turn out to be
1125  * flattenable UNION ALL queries.  This lets us avoid useless searches
1126  * of append_rel_list.
1127  *
1128  * Note: the data structure assumes that append-rel members are single
1129  * baserels.  This is OK for inheritance, but it prevents us from pulling
1130  * up a UNION ALL member subquery if it contains a join.  While that could
1131  * be fixed with a more complex data structure, at present there's not much
1132  * point because no improvement in the plan could result.
1133  */
1134
1135 typedef struct AppendRelInfo
1136 {
1137         NodeTag         type;
1138
1139         /*
1140          * These fields uniquely identify this append relationship.  There can be
1141          * (in fact, always should be) multiple AppendRelInfos for the same
1142          * parent_relid, but never more than one per child_relid, since a given
1143          * RTE cannot be a child of more than one append parent.
1144          */
1145         Index           parent_relid;   /* RT index of append parent rel */
1146         Index           child_relid;    /* RT index of append child rel */
1147
1148         /*
1149          * For an inheritance appendrel, the parent and child are both regular
1150          * relations, and we store their rowtype OIDs here for use in translating
1151          * whole-row Vars.      For a UNION-ALL appendrel, the parent and child are
1152          * both subqueries with no named rowtype, and we store InvalidOid here.
1153          */
1154         Oid                     parent_reltype; /* OID of parent's composite type */
1155         Oid                     child_reltype;  /* OID of child's composite type */
1156
1157         /*
1158          * The N'th element of this list is the integer column number of the child
1159          * column corresponding to the N'th column of the parent. A list element
1160          * is zero if it corresponds to a dropped column of the parent (this is
1161          * only possible for inheritance cases, not UNION ALL).
1162          */
1163         List       *col_mappings;       /* list of child attribute numbers */
1164
1165         /*
1166          * The N'th element of this list is a Var or expression representing the
1167          * child column corresponding to the N'th column of the parent. This is
1168          * used to translate Vars referencing the parent rel into references to
1169          * the child.  A list element is NULL if it corresponds to a dropped
1170          * column of the parent (this is only possible for inheritance cases, not
1171          * UNION ALL).
1172          *
1173          * This might seem redundant with the col_mappings data, but it is handy
1174          * because flattening of sub-SELECTs that are members of a UNION ALL will
1175          * cause changes in the expressions that need to be substituted for a
1176          * parent Var.  Adjusting this data structure lets us track what really
1177          * needs to be substituted.
1178          *
1179          * Notice we only store entries for user columns (attno > 0).  Whole-row
1180          * Vars are special-cased, and system columns (attno < 0) need no special
1181          * translation since their attnos are the same for all tables.
1182          *
1183          * Caution: the Vars have varlevelsup = 0.      Be careful to adjust as needed
1184          * when copying into a subquery.
1185          */
1186         List       *translated_vars;    /* Expressions in the child's Vars */
1187
1188         /*
1189          * We store the parent table's OID here for inheritance, or InvalidOid for
1190          * UNION ALL.  This is only needed to help in generating error messages if
1191          * an attempt is made to reference a dropped parent column.
1192          */
1193         Oid                     parent_reloid;  /* OID of parent relation */
1194 } AppendRelInfo;
1195
1196 /*
1197  * glob->paramlist keeps track of the PARAM_EXEC slots that we have decided
1198  * we need for the query.  At runtime these slots are used to pass values
1199  * either down into subqueries (for outer references in subqueries) or up out
1200  * of subqueries (for the results of a subplan).  The n'th entry in the list
1201  * (n counts from 0) corresponds to Param->paramid = n.
1202  *
1203  * Each paramlist item shows the absolute query level it is associated with,
1204  * where the outermost query is level 1 and nested subqueries have higher
1205  * numbers.  The item the parameter slot represents can be one of three kinds:
1206  *
1207  * A Var: the slot represents a variable of that level that must be passed
1208  * down because subqueries have outer references to it.  The varlevelsup
1209  * value in the Var will always be zero.
1210  *
1211  * An Aggref (with an expression tree representing its argument): the slot
1212  * represents an aggregate expression that is an outer reference for some
1213  * subquery.  The Aggref itself has agglevelsup = 0, and its argument tree
1214  * is adjusted to match in level.
1215  *
1216  * A Param: the slot holds the result of a subplan (it is a setParam item
1217  * for that subplan).  The absolute level shown for such items corresponds
1218  * to the parent query of the subplan.
1219  *
1220  * Note: we detect duplicate Var parameters and coalesce them into one slot,
1221  * but we do not do this for Aggref or Param slots.
1222  */
1223 typedef struct PlannerParamItem
1224 {
1225         NodeTag         type;
1226
1227         Node       *item;                       /* the Var, Aggref, or Param */
1228         Index           abslevel;               /* its absolute query level */
1229 } PlannerParamItem;
1230
1231 #endif   /* RELATION_H */