granicus.if.org Git - postgresql/blob - src/include/optimizer/planmain.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * planmain.h
   4  *        prototypes for various files in optimizer/plan
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/optimizer/planmain.h,v 1.116 2008/12/31 00:08:38 tgl Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef PLANMAIN_H
  15 #define PLANMAIN_H
  16
  17 #include "nodes/plannodes.h"
  18 #include "nodes/relation.h"
  19
  20 /* GUC parameters */
  21 #define DEFAULT_CURSOR_TUPLE_FRACTION 0.1
  22 extern double cursor_tuple_fraction;
  23
  24 /*
  25  * prototypes for plan/planmain.c
  26  */
  27 extern void query_planner(PlannerInfo *root, List *tlist,
  28                           double tuple_fraction, double limit_tuples,
  29                           Path **cheapest_path, Path **sorted_path,
  30                           double *num_groups);
  31
  32 /*
  33  * prototypes for plan/planagg.c
  34  */
  35 extern Plan *optimize_minmax_aggregates(PlannerInfo *root, List *tlist,
  36                                                    Path *best_path);
  37
  38 /*
  39  * prototypes for plan/createplan.c
  40  */
  41 extern Plan *create_plan(PlannerInfo *root, Path *best_path);
  42 extern SubqueryScan *make_subqueryscan(List *qptlist, List *qpqual,
  43                                   Index scanrelid, Plan *subplan, List *subrtable);
  44 extern Append *make_append(List *appendplans, bool isTarget, List *tlist);
  45 extern RecursiveUnion *make_recursive_union(List *tlist,
  46                            Plan *lefttree, Plan *righttree, int wtParam,
  47                            List *distinctList, long numGroups);
  48 extern Sort *make_sort_from_pathkeys(PlannerInfo *root, Plan *lefttree,
  49                                                 List *pathkeys, double limit_tuples);
  50 extern Sort *make_sort_from_sortclauses(PlannerInfo *root, List *sortcls,
  51                                                    Plan *lefttree);
  52 extern Sort *make_sort_from_groupcols(PlannerInfo *root, List *groupcls,
  53                                                  AttrNumber *grpColIdx, Plan *lefttree);
  54 extern Agg *make_agg(PlannerInfo *root, List *tlist, List *qual,
  55                  AggStrategy aggstrategy,
  56                  int numGroupCols, AttrNumber *grpColIdx, Oid *grpOperators,
  57                  long numGroups, int numAggs,
  58                  Plan *lefttree);
  59 extern WindowAgg *make_windowagg(PlannerInfo *root, List *tlist,
  60                            int numWindowFuncs, Index winref,
  61                            int partNumCols, AttrNumber *partColIdx, Oid *partOperators,
  62                            int ordNumCols, AttrNumber *ordColIdx, Oid *ordOperators,
  63                            int frameOptions, Plan *lefttree);
  64 extern Group *make_group(PlannerInfo *root, List *tlist, List *qual,
  65                    int numGroupCols, AttrNumber *grpColIdx, Oid *grpOperators,
  66                    double numGroups,
  67                    Plan *lefttree);
  68 extern Plan *materialize_finished_plan(Plan *subplan);
  69 extern Unique *make_unique(Plan *lefttree, List *distinctList);
  70 extern Limit *make_limit(Plan *lefttree, Node *limitOffset, Node *limitCount,
  71                    int64 offset_est, int64 count_est);
  72 extern SetOp *make_setop(SetOpCmd cmd, SetOpStrategy strategy, Plan *lefttree,
  73                    List *distinctList, AttrNumber flagColIdx, int firstFlag,
  74                    long numGroups, double outputRows);
  75 extern Result *make_result(PlannerInfo *root, List *tlist,
  76                         Node *resconstantqual, Plan *subplan);
  77 extern bool is_projection_capable_plan(Plan *plan);
  78
  79 /*
  80  * prototypes for plan/initsplan.c
  81  */
  82 extern int      from_collapse_limit;
  83 extern int      join_collapse_limit;
  84
  85 extern void add_base_rels_to_query(PlannerInfo *root, Node *jtnode);
  86 extern void build_base_rel_tlists(PlannerInfo *root, List *final_tlist);
  87 extern void add_vars_to_targetlist(PlannerInfo *root, List *vars,
  88                                            Relids where_needed);
  89 extern List *deconstruct_jointree(PlannerInfo *root);
  90 extern void distribute_restrictinfo_to_rels(PlannerInfo *root,
  91                                                                 RestrictInfo *restrictinfo);
  92 extern void process_implied_equality(PlannerInfo *root,
  93                                                  Oid opno,
  94                                                  Expr *item1,
  95                                                  Expr *item2,
  96                                                  Relids qualscope,
  97                                                  bool below_outer_join,
  98                                                  bool both_const);
  99 extern RestrictInfo *build_implied_join_equality(Oid opno,
 100                                                         Expr *item1,
 101                                                         Expr *item2,
 102                                                         Relids qualscope);
 103
 104 /*
 105  * prototypes for plan/setrefs.c
 106  */
 107 extern Plan *set_plan_references(PlannerGlobal *glob,
 108                                         Plan *plan,
 109                                         List *rtable);
 110 extern List *set_returning_clause_references(PlannerGlobal *glob,
 111                                                                 List *rlist,
 112                                                                 Plan *topplan,
 113                                                                 Index resultRelation);
 114 extern void fix_opfuncids(Node *node);
 115 extern void set_opfuncid(OpExpr *opexpr);
 116 extern void set_sa_opfuncid(ScalarArrayOpExpr *opexpr);
 117 extern void record_plan_function_dependency(PlannerGlobal *glob, Oid funcid);
 118 extern void extract_query_dependencies(List *queries,
 119                                                                            List **relationOids,
 120                                                                            List **invalItems);
 121
 122 #endif   /* PLANMAIN_H */