]> granicus.if.org Git - postgresql/blobdiff - src/include/nodes/relation.h
Create the system catalog infrastructure needed for KNNGIST.
[postgresql] / src / include / nodes / relation.h
index 5e504b0ab4ba5a03faa54362f7bd2c389dae23c8..785acc955ad652254c547d015715ec6ac1841925 100644 (file)
@@ -4,10 +4,10 @@
  *       Definitions for planner's internal data structures.
  *
  *
- * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1996-2010, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/nodes/relation.h,v 1.176 2009/10/10 01:43:50 tgl Exp $
+ * src/include/nodes/relation.h
  *
  *-------------------------------------------------------------------------
  */
@@ -68,10 +68,14 @@ typedef struct PlannerGlobal
 
        List       *subrtables;         /* Rangetables for SubPlan nodes */
 
+       List       *subrowmarks;        /* PlanRowMarks for SubPlan nodes */
+
        Bitmapset  *rewindPlanIDs;      /* indices of subplans that require REWIND */
 
        List       *finalrtable;        /* "flat" rangetable for executor */
 
+       List       *finalrowmarks;      /* "flat" list of PlanRowMarks */
+
        List       *relationOids;       /* OIDs of relations the plan depends on */
 
        List       *invalItems;         /* other dependencies, as PlanInvalItems */
@@ -138,6 +142,16 @@ typedef struct PlannerInfo
        List       *join_rel_list;      /* list of join-relation RelOptInfos */
        struct HTAB *join_rel_hash; /* optional hashtable for join relations */
 
+       /*
+        * When doing a dynamic-programming-style join search, join_rel_level[k]
+        * is a list of all join-relation RelOptInfos of level k, and
+        * join_cur_level is the current level.  New join-relation RelOptInfos are
+        * automatically added to the join_rel_level[join_cur_level] list.
+        * join_rel_level is NULL if not in use.
+        */
+       List      **join_rel_level; /* lists of join-relation RelOptInfos */
+       int                     join_cur_level; /* index of list being extended */
+
        List       *resultRelations;    /* integer list of RT indexes, or NIL */
 
        List       *init_plans;         /* init SubPlans for query */
@@ -163,6 +177,8 @@ typedef struct PlannerInfo
 
        List       *append_rel_list;    /* list of AppendRelInfos */
 
+       List       *rowMarks;           /* list of PlanRowMarks */
+
        List       *placeholder_list;           /* list of PlaceHolderInfos */
 
        List       *query_pathkeys; /* desired pathkeys for query_planner(), and
@@ -173,6 +189,8 @@ typedef struct PlannerInfo
        List       *distinct_pathkeys;          /* distinctClause pathkeys, if any */
        List       *sort_pathkeys;      /* sortClause pathkeys, if any */
 
+       List       *minmax_aggs;        /* List of MinMaxAggInfos */
+
        List       *initial_rels;       /* RelOptInfos we are now trying to join */
 
        MemoryContext planner_cxt;      /* context holding PlannerInfo */
@@ -180,7 +198,10 @@ typedef struct PlannerInfo
        double          total_table_pages;              /* # of pages in all tables of query */
 
        double          tuple_fraction; /* tuple_fraction passed to query_planner */
+       double          limit_tuples;   /* limit_tuples passed to query_planner */
 
+       bool            hasInheritedTarget;             /* true if parse->resultRelation is an
+                                                                                * inheritance child rel */
        bool            hasJoinRTEs;    /* true if any RTEs are RTE_JOIN kind */
        bool            hasHavingQual;  /* true if havingQual was non-null */
        bool            hasPseudoConstantQuals; /* true if any RestrictInfo has
@@ -191,6 +212,10 @@ typedef struct PlannerInfo
        int                     wt_param_id;    /* PARAM_EXEC ID for the work table */
        struct Plan *non_recursive_plan;        /* plan for non-recursive term */
 
+       /* These fields are workspace for createplan.c */
+       Relids          curOuterRels;                   /* outer rels above current node */
+       List       *curOuterParams;                     /* not-yet-assigned NestLoopParams */
+
        /* optional private data for join_search_hook, e.g., GEQO */
        void       *join_search_private;
 } PlannerInfo;
@@ -224,7 +249,9 @@ typedef struct PlannerInfo
  *
  * We also have "other rels", which are like base rels in that they refer to
  * single RT indexes; but they are not part of the join tree, and are given
- * a different RelOptKind to identify them.
+ * a different RelOptKind to identify them.  Lastly, there is a RelOptKind
+ * for "dead" relations, which are base rels that we have proven we don't
+ * need to join after all.
  *
  * Currently the only kind of otherrels are those made for member relations
  * of an "append relation", that is an inheritance set or UNION ALL subquery.
@@ -232,9 +259,9 @@ typedef struct PlannerInfo
  * the entire append relation. The member RTEs are otherrels.  The parent
  * is present in the query join tree but the members are not.  The member
  * RTEs and otherrels are used to plan the scans of the individual tables or
- * subqueries of the append set; then the parent baserel is given an Append
- * plan comprising the best plans for the individual member rels.  (See
- * comments for AppendRelInfo for more information.)
+ * subqueries of the append set; then the parent baserel is given Append
+ * and/or MergeAppend paths comprising the best paths for the individual
+ * member rels.  (See comments for AppendRelInfo for more information.)
  *
  * At one time we also made otherrels to represent join RTEs, for use in
  * handling join alias Vars.  Currently this is not needed because all join
@@ -281,6 +308,7 @@ typedef struct PlannerInfo
  *             tuples - number of tuples in relation (not considering restrictions)
  *             subplan - plan for subquery (NULL if it's not a subquery)
  *             subrtable - rangetable for subquery (NIL if it's not a subquery)
+ *             subrowmark - rowmarks for subquery (NIL if it's not a subquery)
  *
  *             Note: for a subquery, tuples and subplan are not set immediately
  *             upon creation of the RelOptInfo object; they are filled in when
@@ -329,7 +357,8 @@ typedef enum RelOptKind
 {
        RELOPT_BASEREL,
        RELOPT_JOINREL,
-       RELOPT_OTHER_MEMBER_REL
+       RELOPT_OTHER_MEMBER_REL,
+       RELOPT_DEADREL
 } RelOptKind;
 
 typedef struct RelOptInfo
@@ -354,6 +383,7 @@ typedef struct RelOptInfo
 
        /* information about a base rel (not set for join rels!) */
        Index           relid;
+       Oid                     reltablespace;  /* containing tablespace */
        RTEKind         rtekind;                /* RELATION, SUBQUERY, or FUNCTION */
        AttrNumber      min_attr;               /* smallest attrno of rel (often <0) */
        AttrNumber      max_attr;               /* largest attrno of rel */
@@ -364,6 +394,7 @@ typedef struct RelOptInfo
        double          tuples;
        struct Plan *subplan;           /* if subquery */
        List       *subrtable;          /* if subquery */
+       List       *subrowmark;         /* if subquery */
 
        /* used by various scans and joins: */
        List       *baserestrictinfo;           /* RestrictInfo structures (if base
@@ -396,9 +427,6 @@ typedef struct RelOptInfo
  *
  *             opfamily[], indexkeys[], opcintype[], fwdsortop[], revsortop[],
  *             and nulls_first[] each have ncolumns entries.
- *             Note: for historical reasons, the opfamily array has an extra entry
- *             that is always zero.  Some code scans until it sees a zero entry,
- *             rather than looking at ncolumns.
  *
  *             Zeroes in the indexkeys[] array indicate index columns that are
  *             expressions; there is one element in indexprs for each such column.
@@ -417,6 +445,7 @@ typedef struct IndexOptInfo
        NodeTag         type;
 
        Oid                     indexoid;               /* OID of the index relation */
+       Oid                     reltablespace;  /* tablespace of index (not table) */
        RelOptInfo *rel;                        /* back-link to index's table */
 
        /* statistics from pg_class */
@@ -440,8 +469,9 @@ typedef struct IndexOptInfo
 
        bool            predOK;                 /* true if predicate matches query */
        bool            unique;                 /* true if a unique index */
+       bool            amcanorderbyop; /* does AM support order by operator result? */
        bool            amoptionalkey;  /* can query omit key for the first column? */
-       bool            amsearchnulls;  /* can AM search for NULL index entries? */
+       bool            amsearchnulls;  /* can AM search for NULL/NOT NULL entries? */
        bool            amhasgettuple;  /* does AM have amgettuple interface? */
        bool            amhasgetbitmap; /* does AM have amgetbitmap interface? */
 } IndexOptInfo;
@@ -513,10 +543,11 @@ typedef struct EquivalenceClass
  *
  * em_is_child signifies that this element was built by transposing a member
  * for an inheritance parent relation to represent the corresponding expression
- * on an inheritance child.  The element should be ignored for all purposes
- * except constructing inner-indexscan paths for the child relation.  (Other
- * types of join are driven from transposed joininfo-list entries.)  Note
- * that the EC's ec_relids field does NOT include the child relation.
+ * on an inheritance child.  These elements are used for constructing
+ * inner-indexscan paths for the child relation (other types of join are
+ * driven from transposed joininfo-list entries) and for constructing
+ * MergeAppend paths for the whole inheritance tree.  Note that the EC's
+ * ec_relids field does NOT include the child relation.
  *
  * em_datatype is usually the same as exprType(em_expr), but can be
  * different when dealing with a binary-compatible opfamily; in particular
@@ -726,6 +757,17 @@ typedef struct AppendPath
 #define IS_DUMMY_PATH(p) \
        (IsA((p), AppendPath) && ((AppendPath *) (p))->subpaths == NIL)
 
+/*
+ * MergeAppendPath represents a MergeAppend plan, ie, the merging of sorted
+ * results from several member plans to produce similarly-sorted output.
+ */
+typedef struct MergeAppendPath
+{
+       Path            path;
+       List       *subpaths;           /* list of component Paths */
+       double          limit_tuples;   /* hard limit on output tuples, or -1 */
+} MergeAppendPath;
+
 /*
  * ResultPath represents use of a Result plan node to compute a variable-free
  * targetlist with no underlying tables (a "SELECT expressions" query).
@@ -781,22 +823,6 @@ typedef struct UniquePath
        double          rows;                   /* estimated number of result tuples */
 } UniquePath;
 
-/*
- * NoOpPath represents exactly the same plan as its subpath.  This is used
- * when we have determined that a join can be eliminated.  The difference
- * between the NoOpPath and its subpath is just that the NoOpPath's parent
- * is the whole join relation while the subpath is for one of the joined
- * relations (and the other one isn't needed).
- *
- * Note: path.pathtype is always T_Join, but this won't actually give rise
- * to a Join plan node.
- */
-typedef struct NoOpPath
-{
-       Path            path;
-       Path       *subpath;
-} NoOpPath;
-
 /*
  * All join-type paths share these fields.
  */
@@ -827,6 +853,14 @@ typedef JoinPath NestPath;
 /*
  * A mergejoin path has these fields.
  *
+ * Unlike other path types, a MergePath node doesn't represent just a single
+ * run-time plan node: it can represent up to four.  Aside from the MergeJoin
+ * node itself, there can be a Sort node for the outer input, a Sort node
+ * for the inner input, and/or a Material node for the inner input.  We could
+ * represent these nodes by separate path nodes, but considering how many
+ * different merge paths are investigated during a complex join problem,
+ * it seems better to avoid unnecessary palloc overhead.
+ *
  * path_mergeclauses lists the clauses (in the form of RestrictInfos)
  * that will be used in the merge.
  *
@@ -838,7 +872,10 @@ typedef JoinPath NestPath;
  * outersortkeys (resp. innersortkeys) is NIL if the outer path
  * (resp. inner path) is already ordered appropriately for the
  * mergejoin.  If it is not NIL then it is a PathKeys list describing
- * the ordering that must be created by an explicit sort step.
+ * the ordering that must be created by an explicit Sort node.
+ *
+ * materialize_inner is TRUE if a Material node should be placed atop the
+ * inner input.  This may appear with or without an inner Sort step.
  */
 
 typedef struct MergePath
@@ -847,6 +884,7 @@ typedef struct MergePath
        List       *path_mergeclauses;          /* join clauses to be used for merge */
        List       *outersortkeys;      /* keys for explicit sort, if any */
        List       *innersortkeys;      /* keys for explicit sort, if any */
+       bool            materialize_inner;              /* add Materialize to inner? */
 } MergePath;
 
 /*
@@ -1291,8 +1329,22 @@ typedef struct AppendRelInfo
  * then allow it to bubble up like a Var until the ph_needed join level.
  * ph_needed has the same definition as attr_needed for a regular Var.
  *
+ * ph_may_need is an initial estimate of ph_needed, formed using the
+ * syntactic locations of references to the PHV.  We need this in order to
+ * determine whether the PHV reference forces a join ordering constraint:
+ * if the PHV has to be evaluated below the nullable side of an outer join,
+ * and then used above that outer join, we must constrain join order to ensure
+ * there's a valid place to evaluate the PHV below the join.  The final
+ * actual ph_needed level might be lower than ph_may_need, but we can't
+ * determine that until later on.  Fortunately this doesn't matter for what
+ * we need ph_may_need for: if there's a PHV reference syntactically
+ * above the outer join, it's not going to be allowed to drop below the outer
+ * join, so we would come to the same conclusions about join order even if
+ * we had the final ph_needed value to compare to.
+ *
  * We create a PlaceHolderInfo only after determining that the PlaceHolderVar
- * is actually referenced in the plan tree.
+ * is actually referenced in the plan tree, so that unreferenced placeholders
+ * don't result in unnecessary constraints on join order.
  */
 
 typedef struct PlaceHolderInfo
@@ -1303,22 +1355,44 @@ typedef struct PlaceHolderInfo
        PlaceHolderVar *ph_var;         /* copy of PlaceHolderVar tree */
        Relids          ph_eval_at;             /* lowest level we can evaluate value at */
        Relids          ph_needed;              /* highest level the value is needed at */
+       Relids          ph_may_need;    /* highest level it might be needed at */
        int32           ph_width;               /* estimated attribute width */
 } PlaceHolderInfo;
 
+/*
+ * For each potentially index-optimizable MIN/MAX aggregate function,
+ * root->minmax_aggs stores a MinMaxAggInfo describing it.
+ *
+ * Note: a MIN/MAX agg doesn't really care about the nulls_first property,
+ * so the pathkey's nulls_first flag should be ignored.
+ */
+typedef struct MinMaxAggInfo
+{
+       NodeTag         type;
+
+       Oid                     aggfnoid;               /* pg_proc Oid of the aggregate */
+       Oid                     aggsortop;              /* Oid of its sort operator */
+       Expr       *target;                     /* expression we are aggregating on */
+       List       *pathkeys;           /* pathkeys representing needed sort order */
+} MinMaxAggInfo;
+
 /*
  * glob->paramlist keeps track of the PARAM_EXEC slots that we have decided
  * we need for the query.  At runtime these slots are used to pass values
- * either down into subqueries (for outer references in subqueries) or up out
- * of subqueries (for the results of a subplan).  The n'th entry in the list
- * (n counts from 0) corresponds to Param->paramid = n.
+ * around from one plan node to another.  They can be used to pass values
+ * down into subqueries (for outer references in subqueries), or up out of
+ * subqueries (for the results of a subplan), or from a NestLoop plan node
+ * into its inner relation (when the inner scan is parameterized with values
+ * from the outer relation).  The n'th entry in the list (n counts from 0)
+ * corresponds to Param->paramid = n.
  *
  * Each paramlist item shows the absolute query level it is associated with,
  * where the outermost query is level 1 and nested subqueries have higher
  * numbers.  The item the parameter slot represents can be one of three kinds:
  *
  * A Var: the slot represents a variable of that level that must be passed
- * down because subqueries have outer references to it.  The varlevelsup
+ * down because subqueries have outer references to it, or must be passed
+ * from a NestLoop node of that level to its inner scan.  The varlevelsup
  * value in the Var will always be zero.
  *
  * An Aggref (with an expression tree representing its argument): the slot
@@ -1331,7 +1405,13 @@ typedef struct PlaceHolderInfo
  * to the parent query of the subplan.
  *
  * Note: we detect duplicate Var parameters and coalesce them into one slot,
- * but we do not do this for Aggref or Param slots.
+ * but we do not bother to do this for Aggrefs, and it would be incorrect
+ * to do so for Param slots.  Duplicate detection is actually *necessary*
+ * in the case of NestLoop parameters since it serves to match up the usage
+ * of a Param (in the inner scan) with the assignment of the value (in the
+ * NestLoop node).  This might result in the same PARAM_EXEC slot being used
+ * by multiple NestLoop nodes or SubPlan nodes, but no harm is done since
+ * the same value would be assigned anyway.
  */
 typedef struct PlannerParamItem
 {